DbObject.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 _ODDBXOBJECT_INCLUDED_
#define _ODDBXOBJECT_INCLUDED_ 
 
#include "TD_PackPush.h"
 
#include "Gi/GiDrawable.h"
#include "DbObjectId.h"
#include "OdString.h"
#include "DbObjectReactor.h"
#include "IdArrays.h"
#include "ResBuf.h"
#include "DebugStuff.h"
 
class OdDbFiler;
class OdDbDwgFiler;
class OdDbDxfFiler;
class OdGiDrawableTraits;
class OdGiWorldDraw;
class OdGiViewportDraw;
class OdGsCache;
class OdDbObjectImpl;
class OdDbEntity;
class OdDbDatabase;
class OdDbIdMapping;
class OdDbAuditInfo;
class OdGeMatrix3d;
class OdDbObjStorage;
class OdString;
class OdGePoint3d;
class OdBinaryData;
class OdDbIdPair;
class OdDbField;
class OdDbDictionary;
class OdDbXrecord;

typedef OdSmartPtr<OdDbXrecord> OdDbXrecordPtr;

#define ODDB_DECLARE_MEMBERS(ClassName)\
protected:                                \
  ClassName(OdDbObjectImpl* pImpl);       \
public:                                   \
ODRX_DECLARE_MEMBERS (ClassName)

#define DBOBJECT_CONSTR(ClassName) OdSmartPtr<ClassName> (new ClassName, kOdRxObjAttach)
 

class TOOLKIT_EXPORT OdError_XdataSizeExceeded : public OdError
{
public:
  OdError_XdataSizeExceeded(
    const OdDbObjectId& objectId);
};
                            

namespace OdDb
{ 
  enum DuplicateRecordCloning
  {
    kDrcNotApplicable  = 0,   // Not applicable to the object.
    kDrcIgnore         = 1,   // If a duplicate record exists, use the existing record
                              // in the *database*, and ignore the clone.
    kDrcReplace        = 2,   // If a duplicate record exists, replace it with the cloned record.
    kDrcXrefMangleName = 3,   // Incoming record names are mangled with <Xref>$0$<name>
    kDrcMangleName     = 4,   // Incoming record names are mangled with $0$<name>
    kDrcUnmangleName   = 5,   // Unmangle the names mangled by kDrcMangleName, then default to kDrcIgnore.
                              // Typically used by RefEdit when checking records into the original *database*.  
    kDrcMax            = kDrcUnmangleName //  The maximum value of this enum.
  };

  enum Visibility
  {
    kInvisible = 1,
    kVisible = 0
  };
 
  enum SaveType
  {
    kDwg   = 0,   // Save as .dwg file
    kDxf   = 1,   // Save as .dxf file
    kDxb   = 2,   // Save as binary .dxf file
    kUnknown = -1 // Database was created from scratch
  };
}
 

class TOOLKIT_EXPORT OdDbObject : public OdGiDrawable
{
public:
  ODDB_DECLARE_MEMBERS(OdDbObject);
 
protected:
  OdDbObject();
public:
  ~OdDbObject();
  
  virtual void addRef() override;

  virtual void release() ODRX_NOEXCEPT override;

  virtual long numRefs() const override;
  
  OdDbObjectId objectId() const;
  
  OdDbHandle getDbHandle() const;
  
  OdDbHandle handle() const 
  { return getDbHandle (); }
  
  OdDbObjectId ownerId() const;
  
  virtual void setOwnerId(
    OdDbObjectId ownerId);
    
  OdDbDatabase* database() const;
  
  void createExtensionDictionary();
  
  OdDbObjectId extensionDictionary() const;
  
  bool releaseExtensionDictionary();  
 
  // Opens/creates/unerases Xdictionary, and retrieves/creates Xrecord for the given name
  //
  
  OdDbXrecordPtr createXrecord(
    const OdString& xrecordName, 
    OdDb::DuplicateRecordCloning style = OdDb::kDrcIgnore);

  void upgradeOpen();
  
  void downgradeOpen();
    
  //FELIX_CHANGE_BEGIN
  void cancel();
  //FELIX_CHANGE_END

  virtual OdResult subOpen(
    OdDb::OpenMode mode);
    

  virtual void subClose();
  
  OdResult erase(
    bool eraseIt = true);
  
  virtual OdResult subErase(
    bool erasing);
  
  void handOverTo(
    OdDbObject* pNewObject, 
    bool keepXData = true, bool 
    keepExtDict = true);
  
  virtual void subHandOverTo(
    OdDbObject* pNewObject);
  
  void swapIdWith(
    OdDbObjectId otherId, 
    bool swapXdata = false, 
    bool swapExtDict = false);
  
  virtual void subSwapIdWith(
    const OdDbObjectId& otherId, 
    bool swapXdata = false, 
    bool swapExtDict = false);
    
  virtual void audit(
    OdDbAuditInfo* pAuditInfo);
  
  void dwgIn(
    OdDbDwgFiler* pFiler);
  
  void dwgOut(
    OdDbDwgFiler* pFiler) const;
  
  virtual OdResult dxfIn(
    OdDbDxfFiler* pFiler);
  
  virtual void dxfOut(
    OdDbDxfFiler* pFiler) const;
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
  
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
  
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
  
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
  
  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler);
  
  virtual void dxfOutFields_R12(
    OdDbDxfFiler* pFiler) const;
  
  virtual OdDb::DuplicateRecordCloning mergeStyle() const;
  
  virtual OdResBufPtr xData(
    const OdString& regappName = OdString::kEmpty) const;
 
  
  virtual void setXData(
    const OdResBuf* pRb);
     
  bool hasXData(const OdChar* regappName = nullptr) const;

  bool isEraseStatusToggled() const;
  
  bool isErased() const;
  
  bool isReadEnabled() const;
  
  bool isWriteEnabled() const;
  
  bool isNotifyEnabled() const;
  
  bool isModified() const;

//  void setModified (bool bModified);
  
  bool isModifiedXData() const;
  
  bool isModifiedGraphics() const;
   
  bool isNewObject() const;
  
  bool isNotifying() const;
  
  bool isUndoing() const;
  
//  bool isCancelling() const;

    bool isReallyClosing() const;
  
  bool isDBRO() const;
    
  void assertReadEnabled() const;
  
  void assertWriteEnabled(
    bool autoUndo = true, 
    bool recordModified = true);
  
  void assertNotifyEnabled() const;
  
  void disableUndoRecording(
    bool disable);
  
  //FELIX_CHANGE_BEGIN
  bool isUndoRecordingDisabled() const;
  //FELIX_CHANGE_END

  OdDbDwgFiler* undoFiler();
  
  virtual void applyPartialUndo(
    OdDbDwgFiler* pUndoFiler, 
    OdRxClass* pClassObj);
  
  void addReactor(
    OdDbObjectReactor* pReactor) const;
  
  void removeReactor(
    OdDbObjectReactor* pReactor) const;
  
  virtual void addPersistentReactor(
    const OdDbObjectId& objId);
  
  virtual void removePersistentReactor(
    const OdDbObjectId& objId);
  
  bool hasPersistentReactor(
    const OdDbObjectId& objId) const;

  OdDbObjectIdArray getPersistentReactors() const;

  OdDbObjectReactorArray getTransientReactors() const;
  
  virtual void recvPropagateModify(
    const OdDbObject* pSubObj);
  
  virtual void xmitPropagateModify() const;
  
  ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone(OdDbIdMapping& idMap, OdDbObject* pOwner, bool bPrimary = true) const ODRX_FINAL;

  ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone(OdDbIdMapping& idMap, OdDbObject* pOwner, bool bPrimary = true) const ODRX_FINAL;

  virtual void appendToOwner(
    OdDbIdPair& idPair, 
    OdDbObject* pOwnerObject, 
    OdDbIdMapping& idMap);

  void setOdDbObjectIdsInFlux();
  
  bool isOdDbObjectIdsInFlux() const;
  
  virtual void copied(
    const OdDbObject* pObject, 
    const OdDbObject* pNewObject);
  

  virtual void erased(
    const OdDbObject* pObject, 
    bool erasing = true);
  
  virtual void goodbye(
    const OdDbObject* pObject);
    
  virtual void openedForModify(
    const OdDbObject* pObject);
  
  virtual void modified(
    const OdDbObject* pObject);

  virtual void subObjModified(
    const OdDbObject* pObject, 
    const OdDbObject* pSubObj);
  
  virtual void modifyUndone(
    const OdDbObject* pObject);
  
  virtual void modifiedXData(
    const OdDbObject* pObject);
  
  virtual void unappended(
    const OdDbObject* pObject);
  
  
  virtual void reappended(
    const OdDbObject* pObject);
  
  bool isAProxy() const;  

  virtual void objectClosed(
    const OdDbObjectId& objectId);
  
  
  virtual void modifiedGraphics(
    const OdDbObject* pObject);
    
  virtual void copyFrom(
    const OdRxObject* pSource);

       bool hasSaveVersionOverride() const;
  
       void setHasSaveVersionOverride(
    bool hasSaveVersionOverride);
  
  virtual OdDb::DwgVersion getObjectSaveVersion(
    const OdDbFiler* pFiler,
    OdDb::MaintReleaseVer* pMaintVer = 0) const;
      
  virtual OdDbObjectPtr decomposeForSave(
    OdDb::DwgVersion ver, 
    OdDbObjectId& replaceId, 
    bool& exchangeXData);

  virtual OdDbObjectPtr decomposeForSave(
    OdDb::SaveType format, 
    OdDb::DwgVersion ver, 
    OdDbObjectId& replaceId, 
    bool& exchangeXData);

  void convertForSave(OdDb::DwgVersion ver);

  virtual void composeForLoad(OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo* pAuditInfo);

  virtual OdGiDrawable* drawable();

  virtual OdUInt32 subSetAttributes(
    OdGiDrawableTraits* pTraits) const;
  
  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
  
  virtual void subViewportDraw(
    OdGiViewportDraw* pVd) const;
  
    virtual bool isPersistent() const;
  
  virtual OdDbStub* id() const;
    
  ODRX_SEALED_VIRTUAL OdResult getClassID(void* pClsid) const ODRX_FINAL;
 
  // Override of OdGiDrawable
  
  void setGsNode(OdGsCache* pNode);
 
  // Override of OdGiDrawable
  
  OdGsCache* gsNode() const;
 
  /*
    void upgradeFromNotify (bool& wasWritable);
    void downgradeToNotify (bool wasWritable);
    OdResult closeAndPage (bool onlyWhenClean = true);
    virtual void swapReferences (const OdDbIdMapping& idMap);
    virtual OdGiDrawable* drawable ();
    OdDbObjPtrArray* reactors (); 
    virtual OdRxObjectPtr clone (OdDbIdMapping& ownerIdMap) const;
  */
  
  void xDataTransformBy(
    const OdGeMatrix3d& xfm);

  bool hasFields() const;
  
  OdDbObjectId getField(
    const OdString& fieldName) const;
    
  OdDbObjectPtr getField(
    const OdString& fieldName, 
    OdDb::OpenMode mode) const;

  virtual OdDbObjectId setField(
    const OdString& fieldName, 
    OdDbField* pField);

  virtual OdResult removeField(
    OdDbObjectId fieldId);
    
  virtual OdDbObjectId removeField(
    const OdString& fieldName);

  OdDbObjectId getFieldDictionary() const;
  
  OdDbObjectPtr getFieldDictionary(
    OdDb::OpenMode mode) const;
 

  
  virtual OdRxClass* saveAsClass(
    OdRxClass* pClass) const;
 
protected: // overridables
  virtual OdResult subGetClassID(void* pClsid) const;
  virtual OdDbObjectPtr subDeepClone(OdDbIdMapping& ownerIdMap, OdDbObject* pOwner, bool bPrimary) const;
  virtual OdDbObjectPtr subWblockClone(OdDbIdMapping& ownerIdMap, OdDbObject* pOwner, bool bPrimary) const;
 
  friend class OdDbSystemInternals;
  friend class OdDbObjectOverrule;
  friend class OdDbPropertiesOverrule;
  friend class OdDbObjectImpl;
  OdDbObjectImpl* m_pImpl;
};

typedef OdSmartPtr<OdDbObject> OdDbObjectPtr;
 

DBIO_EXPORT OdResBufPtr oddbEntGet( const OdDbObject* pObj, const OdString& regapps = OdString::kEmpty );
 
inline OdResBufPtr oddbEntGet( const OdDbObjectId& id, const OdString& regapps = OdString::kEmpty )
{
  return oddbEntGet(id.safeOpenObject(), regapps);
}
 

DBIO_EXPORT OdResult oddbEntMod( OdDbObject* pObj, OdResBuf* pRb );
 
inline OdResult oddbEntMod( const OdDbObjectId& id, OdResBuf* pRb )
{
  return oddbEntMod(id.safeOpenObject(OdDb::kForWrite), pRb);
}
 
TOOLKIT_EXPORT OdDbObjectId oddbEntNext(OdDbObjectId id, OdDbDatabase* db);
TOOLKIT_EXPORT OdDbObjectId oddbEntLast(OdDbDatabase* db);
 
DBIO_EXPORT OdResult oddbEntMake(OdDbDatabase* pDb, OdResBuf* pRb, OdDbObjectPtr& pObj);
DBIO_EXPORT OdResult oddbEntMakeX(OdDbDatabase* pDb, OdResBuf* pRb, OdDbObjectPtr& pObj);
 
 
 
#include "TD_PackPop.h"
 
#endif //_ODDBXOBJECT_INCLUDED_