AcDbLayerStateManager.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#include "..\acad\Acad.h"
 
template < typename Param1 > class AcArrayMemCopyReallocator;
template < typename Param1 > class AcArrayObjectCopyReallocator;
class AcDbDatabase;
class AcDbLayerStateManagerReactor;
class AcDbObjectId;
class AcRxClass;
class AcString;
 
class ARX_API AcDbLayerStateManager : public AcRxObject
{
public:
    enum LayerStateMask
    {
        kNone = 0x0000,
        kOn = 0x0001,
        kFrozen = 0x0002,
        kLocked = 0x0004,
        kPlot = 0x0008,
        kNewViewport = 0x0010,
        kColor = 0x0020,
        kLineType = 0x0040,
        kLineWeight = 0x0080,
        kPlotStyle = 0x0100,
        kCurrentViewport = 0x0200,
        kTransparency = 0x0400,
        kAll = kOn | kFrozen | kLocked | kPlot | kNewViewport | kColor | kLineType | kLineWeight | kPlotStyle | kCurrentViewport | kTransparency,
        kStateIsHidden = 0x8000,
        kLastRestored = 0x10000,
        kDecomposition = kAll | 0x20000
    };
 
    enum
    {
        kUndefDoNothing = 0,
        kUndefTurnOff = 1,
        kUndefFreeze = 2,
        kRestoreAsOverrides = 4
    };
 
public:
    ACRX_DECLARE_MEMBERS( AcDbLayerStateManager )
 
public:
    AcDbLayerStateManager( AcDbDatabase * );
    AcDbLayerStateManager( void );
    bool  addReactor( AcDbLayerStateManagerReactor * );
    bool  compareLayerStateToDb( wchar_t const *, AcDbObjectId const & );
    bool  hasLayerState( wchar_t const * );
    bool  isDependentLayerState( wchar_t const * );
    bool  layerStateHasViewportData( wchar_t const * );
    bool  removeReactor( AcDbLayerStateManagerReactor * );
    AcDbDatabase *  getDatabase( void )const;
    AcDbObjectId  layerStatesDictionaryId( bool param_1 = false );
    Acad::ErrorStatus  addLayerStateLayers( wchar_t const *, AcDbObjectIdArray const & );
    Acad::ErrorStatus  deleteLayerState( wchar_t const * );
    Acad::ErrorStatus  exportLayerState( wchar_t const *, wchar_t const * );
    Acad::ErrorStatus  getLastRestoredLayerState( AcString &, AcDbObjectId & );
    Acad::ErrorStatus  getLayerStateDescription( wchar_t const *, wchar_t * & );
    Acad::ErrorStatus  getLayerStateLayers( AcArray< AcString, AcArrayObjectCopyReallocator< AcString> > &, wchar_t const *, bool param_3 = false );
    Acad::ErrorStatus  getLayerStateMask( wchar_t const *, LayerStateMask & );
    Acad::ErrorStatus  getLayerStateNames( AcArray< AcString, AcArrayObjectCopyReallocator< AcString> > &, bool param_2 = true, bool param_3 = true);
    Acad::ErrorStatus  importLayerState( wchar_t const * );
    Acad::ErrorStatus  importLayerState( wchar_t const *, AcString & );
    Acad::ErrorStatus  importLayerStateFromDb( wchar_t const *, AcDbDatabase * );
    Acad::ErrorStatus  removeLayerStateLayers( wchar_t const *, AcArray< AcString, AcArrayObjectCopyReallocator< AcString> > const & );
    Acad::ErrorStatus  renameLayerState( wchar_t const *, wchar_t const * );
    Acad::ErrorStatus  restoreLayerState( wchar_t const * );
    Acad::ErrorStatus  restoreLayerState( wchar_t const *, AcDbObjectId const &, int param_3 = 0, LayerStateMask const * param_4 = nullptr);
    Acad::ErrorStatus  saveLayerState( wchar_t const *, LayerStateMask );
    Acad::ErrorStatus  saveLayerState( wchar_t const *, LayerStateMask, AcDbObjectId const & );
    Acad::ErrorStatus  setLayerStateDescription( wchar_t const *, wchar_t const * );
    Acad::ErrorStatus  setLayerStateMask( wchar_t const *, LayerStateMask );
 
    virtual  ~AcDbLayerStateManager( void );
};