DbLayerState.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef DBLAYERSTATEMANAGER_H
#define DBLAYERSTATEMANAGER_H
 
#include "TD_PackPush.h"
#include "StringArray.h"
 
class OdDbLayerStateManagerReactor;
class OdDbLayerStateManagerImpl;

class TOOLKIT_EXPORT OdDbLayerStateManager: public OdRxObject
{
protected:
  OdDbLayerStateManager(OdDbLayerStateManagerImpl*);
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdDbLayerStateManager);
//DOM-IGNORE-END

  OdDbLayerStateManager();

  ~OdDbLayerStateManager();

  enum LayerStateMask {
    kNone           = 0x0000,  //None
    kOn             = 0x0001,  //On
    kFrozen         = 0x0002,  //Frozen
    kLocked         = 0x0004,  //Locked
    kPlot           = 0x0008,  //Plot
    kNewViewport    = 0x0010,  //New viewport
    kColor          = 0x0020,  //Color
    kLineType       = 0x0040,  //Line type
    kLineWeight     = 0x0080,  //Line weight
    kPlotStyle      = 0x0100,  //Plot style
    kCurrentViewport = 0x0200, //Current viewport
    kTransparency   = 0x0400,  //Transparency
    kAll            = kOn | kFrozen | kLocked | kPlot | kNewViewport |
    kColor | kLineType | kLineWeight | kPlotStyle |
    kCurrentViewport | kTransparency, //All
    kStateIsHidden  = 0x8000,  //State is hidden
    kLastRestored   = 0x10000, //Last restored
    kDecomposition  = kAll | 0x20000 //Decomposition
  };

  enum {
    kUndefDoNothing = 0,    //Restore as is
    kUndefTurnOff = 1,      //Restore as turned off
    kUndefFreeze = 2,       //Restore as frozen
    kRestoreAsOverrides = 4 //Restore as overrides
  };

  bool                addReactor(OdDbLayerStateManagerReactor * pReactor);

  bool                removeReactor(OdDbLayerStateManagerReactor * pReactor);

  OdDbObjectId        layerStatesDictionaryId(bool bCreateIfNotPresent=false);

  bool                hasLayerState(const OdString& sName);

  OdResult   saveLayerState(const OdString& sName, LayerStateMask mask);

  OdResult   restoreLayerState(const OdString& sName);

  OdResult   setLayerStateMask(const OdString& sName, LayerStateMask mask);

  OdResult   getLayerStateMask(const OdString& sName, LayerStateMask &returnMask);

  OdResult   deleteLayerState(const OdString& sName);

  OdResult   renameLayerState(const OdString& sName, const OdString& sNewName);

  OdResult   importLayerState(OdStreamBuf* pStreamBuf);

  OdResult   importLayerState(OdStreamBuf* pStreamBuf, OdString& sName);

  OdResult   exportLayerState(const OdString& sNameToExport, OdStreamBuf* pStreamBuf);

  OdResult   saveLayerState(const OdString& sName, LayerStateMask mask, const OdDbObjectId& idVp);

  OdResult   restoreLayerState(const OdString& sName, const OdDbObjectId& idVp, int nRestoreFlags = 0, const LayerStateMask* pClientMask = NULL);

  OdResult   setLayerStateDescription(const OdString& sName, const OdString& sDesc);
  OdResult   getLayerStateDescription(const OdString& sName, OdString& sDesc);
  bool       layerStateHasViewportData(const OdString&  sName);
  OdResult   importLayerStateFromDb(const OdString& pStateName, OdDbDatabase* pDb);
  OdResult   getLayerStateNames(OdStringArray& lsArray, bool bIncludeHidden = true, bool bIncludeXref = true);
  OdResult   getLastRestoredLayerState(OdString& sName, OdDbObjectId &restoredLSId);
  OdResult   getLayerStateLayers(OdStringArray& layerArray, const OdString& sName, bool bInvert = false);
  bool       compareLayerStateToDb(const OdString& sName, const OdDbObjectId& idVp);
  OdResult   addLayerStateLayers(const OdString& sName, const OdDbObjectIdArray& layerIds);
  OdResult   removeLayerStateLayers(const OdString& sName, const OdStringArray& layerNames);
  bool       isDependentLayerState(const OdString& sName);
  OdDbDatabase* getDatabase() const;
protected:
  OdDbLayerStateManagerImpl* m_pImpl;
  friend class OdDbLayerStateManagerImpl;
  friend class OdDbDatabase;
};
 
//FELIX_CHANGE_BEGIN
class TOOLKIT_EXPORT OdDbLayerStateProperties
{
public:
    OdDbLayerStateProperties(){}
    virtual ~OdDbLayerStateProperties(){}

    virtual bool load() = 0;

    virtual bool save() = 0;

    virtual OdString getActiveLayer() const = 0;
    virtual OdResult setActiveLayer( const OdString& layerStateName ) = 0;

    virtual bool isOn( const OdString& layerName ) const = 0;
    virtual OdResult setOn( const OdString& layerName, const bool& bOn ) = 0;

    virtual bool isFreezed( const OdString& layerName, OdDbObjectId id = NULL ) const = 0;
    virtual OdResult setFreeze( const OdString& layerName, const bool& bFreeze, OdDbObjectId id = NULL ) = 0;

    virtual bool isLocked( const OdString& layerName ) const = 0;
    virtual OdResult setLocked( const OdString& layerName, const bool& bLock ) = 0;

    virtual OdCmColor getLineColor( const OdString& layerName ) const = 0;
    virtual OdResult setLineColor( const OdString& layerName, const OdCmColor& color ) = 0;   

    virtual OdDb::LineWeight getLineWeight( const OdString& layerName ) const = 0;
    virtual OdResult setLineWeight( const OdString& layerName, const OdDb::LineWeight& lweight ) = 0;
        
    virtual OdDbObjectId getLineType( const OdString& layerName ) const = 0;
    virtual OdResult setLineType( const OdString& layerName, const OdDbObjectId& ltype ) = 0;

    virtual OdString getPlotStyle( const OdString& layerName ) const = 0;
    virtual OdResult setPlotStyle( const OdString& layerName, const OdString& plotStyle ) = 0;

    virtual OdCmTransparency getTransparency( const OdString& layerName) const = 0;
    virtual OdResult setTransparency ( const OdString& layerName, const OdCmTransparency& transparency ) = 0;

    virtual bool isPlotable( const OdString& layerName ) const = 0;
    virtual OdResult setPlotable( const OdString& layerName, const bool& bPlot ) = 0;

    virtual bool isNewVPFreeze( const OdString& layerName ) const = 0;
    virtual OdResult setNewVPFreeze( const OdString& layerName, const bool& bNewVPFreeze ) = 0;
    
    virtual OdDbDatabase* database() const = 0;

    virtual OdString getLayerStateName() const = 0;
 };
 
TOOLKIT_EXPORT OdDbLayerStateProperties* fxGetLayerStateProperties( OdDbDatabase* pDb, const OdString& layerState);

class TOOLKIT_EXPORT OdDbLegacyLayerStateImporter
{
public:
    OdDbLegacyLayerStateImporter( OdDbDatabasePtr pDb ){ m_pDb = pDb; }
    virtual ~OdDbLegacyLayerStateImporter(){}
 
    bool       hasLegacyLayerStates();
    OdResult   importLegacyLayerStates();
 
private:
    OdDbDatabasePtr m_pDb;
};
//FELIX_CHANGE_END
 

class TOOLKIT_EXPORT OdDbLayerStateManagerReactor : public OdRxObject
{
public:
//DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdDbLayerStateManagerReactor);
//DOM-IGNORE-END

  virtual void layerStateCreated(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);

  virtual void layerStateCompareFailed(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);

  virtual void layerStateToBeRestored(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);

  virtual void layerStateRestored(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);

  virtual void abortLayerStateRestore(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);
 

  virtual void layerStateToBeDeleted(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);

  virtual void layerStateDeleted(const OdString& layerStateName);

  virtual void abortLayerStateDelete(const OdString& layerStateName,
    const OdDbObjectId& layerStateId);
 

  virtual void layerStateToBeRenamed(const OdString& oldLayerStateName,
    const OdString& newLayerStateName);

  virtual void layerStateRenamed(const OdString& oldLayerStateName,
    const OdString& newLayerStateName);

  virtual void abortLayerStateRename(const OdString& oldLayerStateName,
    const OdString& newLayerStateName);
};
 

typedef OdSmartPtr<OdDbLayerStateManagerReactor> OdDbLayerStateManagerReactorPtr;

class TOOLKIT_EXPORT OdDbLayerState
{
public:

  static OdDbObjectId dictionaryId(OdDbDatabase *pDb, bool createIfNotFound = false);

  static bool has(OdDbDatabase *pDb, const OdString &layerStateName);

  static void save(OdDbDatabase *pDb, const OdString &layerStateName, int layerStateMask, const OdDbObjectId &viewportId = OdDbObjectId::kNull);

  static void restore(OdDbDatabase *pDb, const OdString &layerStateName,
    int flags = OdDbLayerStateManager::kUndefDoNothing, const int layerStateMask = -1, const OdDbObjectId& viewportId = OdDbObjectId::kNull);
  static void setMask(OdDbDatabase *pDb, const OdString &layerStateName, int layerStateMask);

  static int  mask(OdDbDatabase *pDb, const OdString &layerStateName);

  static void remove(OdDbDatabase *pDb, const OdString &layerStateName);

  static void rename(OdDbDatabase *pDb, const OdString &oldName, const OdString &newName);

  enum ImportResult
  {
    kImported,     //Layer state was imported
    kAlreadyExists //Layer state already exists in the database
  };

  static ImportResult importData(OdDbDatabase *pDb, OdStreamBuf* pStreamBuf, OdString* pName = 0);

  static void exportData(OdDbDatabase *pDb, const OdString &layerStateName, OdStreamBuf* pStreamBuf);

  static void setDescription(OdDbDatabase *pDb, const OdString &layerStateName, const OdString &description);
  static OdString description(OdDbDatabase *pDb, const OdString &layerStateName);

  static bool hasViewportData(OdDbDatabase *pDb, const OdString &layerStateName);

  static OdResult addLayerStateLayers(const OdString &sName, OdDbObjectIdArray layerIds);

  static OdResult removeLayerStateLayers(OdDbDatabase* pDb, const OdString sName, const OdStringArray& layerNames);

  static OdResult saveGroup(OdDbDatabase *pDb, const OdString &sName,
    const OdDbObjectIdArray& pLayers, int mask = OdDbLayerStateManager::kOn,
    int includedLayersState = OdDbLayerStateManager::kOn, int otherLayersState = OdDbLayerStateManager::kNone);
};
 
#include "TD_PackPop.h"
 
#endif //#ifndef DBLAYERSTATEMANAGER_H