#include <DbObject.h>
Protected Member Functions | |
| OdDbObject () | |
| 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 |
 Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subSetAttributes (OdGiDrawableTraits *traits) const =0 |
| virtual bool | subWorldDraw (OdGiWorldDraw *wd) const =0 |
| virtual void | subViewportDraw (OdGiViewportDraw *vd) const =0 |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
Protected Attributes | |
| OdDbObjectImpl * | m_pImpl |
Friends | |
| class | OdDbSystemInternals |
| class | OdDbObjectOverrule |
| class | OdDbPropertiesOverrule |
| class | OdDbObjectImpl |
Detailed Description
This class is the base class for all objects contained in an OdDbDatabase instance (OdDb objects).
- Remarks
Creating and Deleting Database Objects
Database objects are normally created by calling OdDbXXXXX::createObject(). When an object is created, it will be in kOpenForWrite mode. The delete operator should never be called on database objects. Instead, erase() should be called, which marks the object as erased. OdDbObject instances should be created by calling the createObject() method. OdDbObject instances are created in kOpenForWrite mode.
Depending on other OdDbObject instances while constructing or deleting instances is prohibited. OdDbObject instances should be deleted from an OdDbDatabase with erase(). Never access a pointer to a closed object. The delete operator must never be called on OdDbObject instances. Instead, the erase() method should be called, which marks this object as erased.
Accessing Database Objects
Database objects must be opened before they can be accessed.
Given a valid OdDbObjectId, a database object is opened by calling OdDbObjectId::safeOpenObject().
Database objects should be opened in the most restrictive mode possible, and should be released immediately when access is no longer needed.
Object may be opened in any one of the following modes:
Description OdDb::kForRead Allows operations that do not modify this object.
A database object can be opened in this mode any number of times (simultaneously), if has not open in OdDb::kForWrite or OdDb::kForNotify mode.
An exception will be thrown if any type of write operation is attempted on an object open in this mode. OdDb::kForWrite Allows read and write operations to be performed on this object.
An database object can be opened in this mode only if it is not already open in any mode. OdDb::kForNotify This object is opened for notification purposes.
A database object can be opened in this mode so long as it is not already open in kNotify mode.
- See also
- OdDbObjectId OdDbDatabase
Corresponding C++ library: TD_Db
<group OdDb_Classes>
Definition at line 212 of file DbObject.h.
Constructor & Destructor Documentation
◆ OdDbObject()
|
protected |
◆ ~OdDbObject()
| OdDbObject::~OdDbObject | ( | ) |
Member Function Documentation
◆ addPersistentReactor()
|
virtual |
Adds the specified persistent reactor to this object's reactor list.
- Parameters
-
objId [in] Object ID of the persistent reactor.
- Remarks
- An object must be open OdDb::kForWrite in order to add a persistent reactor.
If the persistent reactor does not have an owner, it isn't saved with the drawing. Non-graphical objects used as persistent reactors are typically stored in a dictionary in the Named Objects Dictionary or in an extension dictionary associated with some object.
◆ addReactor()
| void OdDbObject::addReactor | ( | OdDbObjectReactor * | pReactor | ) | const |
Adds the specified transient reactor to this object's reactor list.
- Parameters
-
pReactor [in] Pointer to the transient reactor object.
- Remarks
- An object must be open either OdDb::kForRead or OdDb::kForWrite in order to add a transient reactor.
◆ addRef()
|
virtual |
Increments the reference count of this object.
Implements OdRxObject.
◆ appendToOwner()
|
virtual |
This function appends this object to the specified owner object during the deep or wblock clone operation.
- Parameters
-
idPair [in] Original-to-clone ID mapping record for this clone. pOwnerObject [in] Pointer to the owner object. idMap [in/out] ID mapping object of the cloning operation in progress.
- Remarks
- This callback is called before the IDs are translated in the target database so the implementer should use only methods certainly not traversing hierarchy in the target database. To follow clone's references properly they should be translated using the ID mapping object.
The default implementation appends this object to OdDbDictionary or throws the eInvalidOwnerObject exception if the owner object is not a kind of dictionary.
- See also
- <link OdDbObject::subDeepClone@OdDbIdMapping&@OdDbObject*@bool@const, subDeepClone()> <link OdDbObject::subWblockClone@OdDbIdMapping&@OdDbObject*@bool@const, subWblockClone()> <link OdDbObject::deepClone@OdDbIdMapping&@OdDbObject*@bool@const, deepClone()> <link OdDbObject::wblockClone@OdDbIdMapping&@OdDbObject*@bool@const, wblockClone()>
Reimplemented in OdDbAttributeDefinition, OdDbEntity, OdDbGroup, OdDbHatch, OdDbLayout, OdDbMlineStyle, OdDbSymbolTableRecord, OdDbTable, OdDbDimension, and OdDbScale.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [in] A pointer to the OdRxClass object for the class that will handle the Undo.
- Remarks
- An object indicates it's using the partial undo mechanism, if and only if it has set autoUndo false in all calls to assertWriteEnabled().
This member function must know which types of fields to scan, and must stop after reading what it it needs.
If the class type specified by pClassObj does not matches the class of this object, this member function must call the parent class's applyPartialUndo() and return whatever it returns.
If it does match the class of this object, this member function must use pUndoFiler to read the undo data, then typically use this object's set() method.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented in OdDbBlockTable, OdDbBlockTableRecord, OdDbDictionary, OdDbUnderlayDefinition, OdDbScale, CFxBIMDatabaseReference, CFxBIMEntityReference, CFxBIMRoomSectionEntity, OdDbEvalGraph, OdDbDatabase, OdDbEntity, and OdDbLongTransaction.
◆ assertNotifyEnabled()
| void OdDbObject::assertNotifyEnabled | ( | ) | const |
Throws an exception if this object is not open OdDb::kForNotify.
- Remarks
- This function should be used only inside member functions that are used only when this object is open OdDb::kForNotify. It should be the first function called by these functions.
Throws:
Cause eInvalidOpenState !isNotifyEnabled()
◆ assertReadEnabled()
| void OdDbObject::assertReadEnabled | ( | ) | const |
Throws an exception if this object is not open OdDb::kForRead.
- Remarks
- This function should be used only inside member functions that do not modify this object. It should be the first function called by these functions.
Throws:
Cause eNotOpenForRead !isReadEnabled()
◆ assertWriteEnabled()
Throws an exception if this object is not open OdDb::kForWrite, and controls automatic undo and notification of modifications.
- Parameters
-
autoUndo [in] Specifies if automatic undo should be done. recordModified [in] Specifies if graphics are to be updated, and "openedForModify", "modified" and "modifiedGraphics" notifications are to be sent.
- Remarks
- This function should be used only inside member functions that modify this object. It should be the first function called by these functions.
Throws:
Cause eNotOpenForWrite !isWriteEnabled()
◆ audit()
|
virtual |
Perform an audit operation on this object.
- Parameters
-
pAuditInfo [in] Pointer to an OdDbAuditInfo object.
- Remarks
- The specified OdDbAuditInfo object controls the audit, and receives the audit status.
When overriding this function for a custom class, first call OdDbObject::audit(pAuditInfo) to validate the audit operation.
Reimplemented in AECDbObject, AECDbDispPropsMassElem, AECDbDispPropsSlab, OdDbDatabase, and CFxBIMStorage.
◆ cancel()
| void OdDbObject::cancel | ( | ) |
Discard changes since the object was opened for modify
◆ composeForLoad()
|
virtual |
After loading from file, performs necessary actions which require accessing other Database objects. For example, processing round-trip data.
- Parameters
-
format [in] File type. version [in] Drawing version of file loaded. pAuditInfo [in] Pointer to an OdDbAuditInfo object. Can be Null. Not Null if drawing is being loaded in Recover mode. If so, audit() will be called later.
- Remarks
- If an object in its dwgInFields() method accesses other database objects, it's non-thread-safe. Such objects can't be loaded in MT mode. To enable MT loading of custom objects, its dwgInFields() should not access other database objects. Such actions should be performed in composeForLoad(). composeForLoad() is called in single-thread mode after all thread-safe objects are loaded (their dwgInFields() were called in MT mode).
Being overridden in custom classes, the function first should call the parent class method. Parent class implementation takes care of parent class round-trip data and other actions which require access to other objects.
◆ convertForSave()
| void OdDbObject::convertForSave | ( | OdDb::DwgVersion | ver | ) |
The method should be called from decomposeForSave() of custom container objects for owned child objects. It calls child's decomposeForSave() method plus performs other required actions (handOverTo, exchanging XData, etc.)
- Parameters
-
ver [in] Drawing version to save as.
- Remarks
◆ copied()
|
virtual |
Notification function called whenever the notifying object has had its clone() member function called.
- Parameters
-
pObject [in] Pointer to the notifying object. pNewObject [in] Pointer to the object resulting from the copy.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbDimAssoc, and OdDbGroup.
◆ copyFrom()
|
virtual |
Copies the contents of the specified object into this object when possible.
- Parameters
-
pSource [in] Pointer to the source object.
- Remarks
- The source object and this object need not be of the same type.
This function is meaningful only when implemented by custom classes.
Throws:
Cause eNullObjectPointer pSource->isNull()
Reimplemented from OdRxObject.
Reimplemented in OdDbTextObjectContextData, OdDbMTextAttributeObjectContextData, OdDbBlkRefObjectContextData, OdDbDimensionObjectContextData, OdDbBlockTableRecord, OdDbEvalGraph, AECDbWindow, OdDbAbstractViewTableRecord, OdDbEntity, OdDbLinkedTableData, OdDbMLeader, OdDbMTextObjectContextData, OdDbAlignedDimensionObjectContextData, OdDbAngularDimensionObjectContextData, OdDbDiametricDimensionObjectContextData, OdDbOrdinateDimensionObjectContextData, OdDbRadialDimensionObjectContextData, OdDbRadialDimensionLargeObjectContextData, OdDbPlotSettings, OdDbSymbolTableRecord, OdDbTable, OdDbViewportTableRecord, OdDb3dSolid, OdDbBody, OdDbRegion, OdDbSurface, CFxBIMMaterial, CFxMaterialLayerSet, OdDbBlockReference, OdDbFcfObjectContextData, OdDbHatchScaleContextData, OdDbHatchViewContextData, OdDbLeaderObjectContextData, and OdDbMLeaderObjectContextData.
◆ createExtensionDictionary()
| void OdDbObject::createExtensionDictionary | ( | ) |
Creates an OdDbDictionary extension dictionary of this object.
- Remarks
- If this object's extension dictionary has been erased, it will be unerased.
An object owns its extension dictionary.
◆ createXrecord()
| OdDbXrecordPtr OdDbObject::createXrecord | ( | const OdString & | xrecordName, |
| OdDb::DuplicateRecordCloning | style = OdDb::kDrcIgnore |
||
| ) |
Creates or retrieves the specified Xrecord in this object's extension dictionary.
- Parameters
-
xrecordName [in] Xrecord name. style [in] Merge style.
- Returns
- Returns a SmartPointer to the specified Xrecord.
If the extension dictionary has been erased, it is unerased. If the extension dictionary does not exist, it is created. If the specified Xrecord does not exist, it is created.
◆ database()
| OdDbDatabase * OdDbObject::database | ( | ) | const |
Returns the OdDbDatabase that contains this object.
◆ decomposeForSave() [1/2]
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. The Drawings transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
Reimplemented in AECDbVarsSetup, OdDb3dSolid, OdDbBody, OdDbHatch, OdDbRegion, OdDbSpline, OdDbSubDMesh, OdDbSurface, and OdDbFcf.
◆ decomposeForSave() [2/2]
|
virtual |
Determines the behavior for custom objects when saving to .dwg or .dxf file.
- Parameters
-
format [in] File type. ver [in] Drawing version to save as. replaceId [out] Object ID of the object replacing this object. exchangeXData [out] Set to true if and only if this function did not add XData to the replacement object.
- Remarks
- This function either
Returns an OdDbObjectPtr for a non- database -resident (NDBRO) replacement object, setting replaceId to OdDbObjectId::kNull. Returns NULL, setting replaceId for a database -resident (DBRO) replacement object.
Custom objects can decompose themselves into other objects, adding additional XData as required. The Drawings transfers XData from this object to the replacement object if and only if exchangeXData is true.
The default implementation returns NULL and sets replaceId to OdDbObjectId::kNull. This function can be overridden in custom classes.
The method is not intended to be called by client code. For processing owned objects use convertForSave() method.
◆ deepClone()
| ODRX_SEALED_VIRTUAL OdDbObjectPtr OdDbObject::deepClone | ( | OdDbIdMapping & | idMap, |
| OdDbObject * | pOwner, | ||
| bool | bPrimary = true |
||
| ) | const |
Performs a deep clone of this object.
- Parameters
-
idMap [in/out] Object ID mapping object. pOwner [in] Pointer to the owner object.
- Remarks
- Returns a SmartPointer to the newly created clone, and adds a record to the specified ID mapping object.
If the cloning operation fails, a null SmartPointer is returned.
A deep clone is a clone of this object and everything it owns.
This function should not be called by client code; use OdDbDatabase::deepCloneObjects() instead.
This function can be overridden in custom classes.
The default implementation of this function appends the cloned object to the specified owner object.
- See also
- <link OdDbObject::subDeepClone@OdDbIdMapping&@OdDbObject*@bool@const, subDeepClone()> <link OdDbObject::wblockClone@OdDbIdMapping&@OdDbObject*@bool@const, wblockClone()> <link OdDbObject::appendToOwner@OdDbIdPair&@OdDbObject*@OdDbIdMapping&, appendToOwner()>
◆ disableUndoRecording()
| void OdDbObject::disableUndoRecording | ( | bool | disable | ) |
Controls the undo recording of this object in OdDbDatabase.
- Parameters
-
disable [in] Boolean to control undo recording.
- Remarks
- Disabling undo recording does not erase the undo recording; it merely suspends it. Undo recording is initially off for newly created OdDbDatabase objects.
◆ downgradeOpen()
| void OdDbObject::downgradeOpen | ( | ) |
Downgrades this object from OdDb::kForWrite to OdDb::kForRead
- Remarks
- Any pending changes to this object are committed to the database.
◆ drawable()
|
virtual |
Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL.
Reimplemented in OdDbAbstractViewTableRecord, OdDbBackground, OdDbBlockTableRecord, OdDbEntity, OdDbLayerTableRecord, OdDbLinetypeTableRecord, OdDbMaterial, OdDbRenderSettings, OdDbRenderEnvironment, OdDbSun, OdDbViewportTableRecord, and OdDbVisualStyle.
◆ dwgIn()
| void OdDbObject::dwgIn | ( | OdDbDwgFiler * | pFiler | ) |
Reads the .dwg file format data of this object from the specified file.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Remarks
- This function calls dwgInFields(pFiler), then loads any Xdata associated with this object.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Returns
- Returns the filer status.
This function is called by dwgIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented in OdDbBreakData, OdDbBreakPointRef, OdDbMLeader, AECDbEntity, ACAECBinRecord, AECDbObject, OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAbstractViewTableRecord, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbSolidBackground, OdDbGradientBackground, OdDbImageBackground, OdDbGroundPlaneBackground, OdDbSkyBackground, OdDbIBLBackground, OdDbBlockBegin, OdDbBlockReference, OdDbBlockTable, OdDbBody, OdDbCamera, OdDbCircle, OdDbColor, OdDbDatabase, OdDbDataLink, OdDbDataTable, OdDbDetailViewStyle, OdDbDiametricDimension, OdDbDictionary, OdDbDictionaryVar, OdDbDictionaryWithDefault, OdDbDimension, OdDbDimStyleTable, OdDbDimStyleTableRecord, OdDbEllipse, OdDbEntity, OdDbEvalExpr, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbField, OdDbFormattedTableData, OdDbGeoData, OdDbGeoPositionMarker, OdDbGroup, OdDbHatch, OdDbHelix, OdDbIdBuffer, OdDbIndex, OdDbLayerFilter, OdDbLayerIndex, OdDbLayerTableRecord, OdDbLayout, OdDbLeader, OdDbLight, OdDbLine, OdDbLinetypeTable, OdDbLinetypeTableRecord, OdDbLinkedData, OdDbLinkedTableData, OdDbLoftedSurface, OdDbLongTransaction, OdDbMaterial, OdDbMInsertBlock, OdDbMLeaderStyle, OdDbMline, OdDbMlineStyle, OdDbModelDocViewStyle, OdDbMotionPath, OdDbMPolygon, OdDbMText, OdDbCurvePath, OdDbPointPath, OdDbNurbSurface, OdDbObjectContextData, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPartialViewingIndex, OdDbPersSubentManager, OdDbPlaneSurface, OdDbPlotSettings, OdDbPoint, OdDbPointCloud, OdDbPointCloudColorMap, OdDbPointCloudDef, OdDbPointCloudDefReactor, OdDbPointCloudDefEx, OdDbPointCloudDefReactorEx, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbProxyObject, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRasterImageDef, OdDbRasterImageDefReactor, OdDbRasterVariables, OdDbRay, OdDbRegAppTableRecord, OdDbRegion, OdDbRenderSettings, OdDbMentalRayRenderSettings, OdDbRapidRTRenderSettings, OdDbRenderEnvironment, OdDbRenderGlobal, OdDbRenderEntry, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSectionSettings, OdDbSectionManager, OdDbSectionViewStyle, OdDbShape, OdDbSolid, OdDbSortentsTable, OdDbSpatialFilter, OdDbSpatialIndex, OdDbSpline, OdDbSubDMesh, OdDbSun, OdDbSurface, OdDbSweptSurface, OdDbSymbolTable, OdDbSymbolTableRecord, OdDbTable, OdDbTableContent, OdDbTableStyle, OdDbTableTemplate, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbUnderlayDefinition, OdDbNavisworksDefinition, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, OdDbVbaProject, OdDbViewport, OdDbViewportTableRecord, OdDbViewTableRecord, OdDbVisualStyle, OdDbWipeoutVariables, OdDbXline, OdDbXrecord, OdDbLSObject, OdDbBlockRepresentationData, OdDbDynamicBlockPurgePreventer, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbSynergyMappings, OdDbViewBorder, OdDbViewRep, OdDbViewRepCutDefinition, OdDbViewRepDetailDefinition, OdDbViewRepImage, OdDbViewRepInventorSource, OdDbViewRepModelPlaneDef, OdDbViewRepModelSpaceSource, OdDbViewRepModelSpaceViewSelSet, OdDbViewRepOrientation, OdDbViewRepOrientationDef, OdDbViewRepProjectionDef, OdDbViewRepSectionDefinition, OdDbViewRepSource, OdDbViewRepFusionSource, OdDbViewRepSourceMgr, OdDbViewRepStandard, OdDbViewSymbol, RText, OdDbAssocPersSubentManager, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistory, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, OdDbShWedge, OdVLObject, OdDbBlockTableRecord, OdDbDimAssoc, OdDbEvalGraph, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbScale, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMDatabase, CFxBIMDatabaseReference, CFxBIMEntity, CFxBIMEntityReference, CFxBIMMaterial, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, CFxBIMSectionView, and CFxBIMStorage.
◆ dwgOut()
| void OdDbObject::dwgOut | ( | OdDbDwgFiler * | pFiler | ) | const |
Writes the .dwg file format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dwgOutFields() function, writes loads any Xdata associated with this object.
◆ dwgOutFields()
|
virtual |
Writes the .dwg file data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are written.
- Remarks
This function is called by dwgIn() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.
Reimplemented in OdDbBreakData, OdDbBreakPointRef, OdDbMLeader, AECDbEntity, ACAECBinRecord, AECDbObject, OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAbstractViewTableRecord, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbSolidBackground, OdDbGradientBackground, OdDbImageBackground, OdDbGroundPlaneBackground, OdDbSkyBackground, OdDbIBLBackground, OdDbBlockBegin, OdDbBlockReference, OdDbBlockTable, OdDbBody, OdDbCamera, OdDbCircle, OdDbColor, OdDbDatabase, OdDbDataLink, OdDbDataTable, OdDbDetailViewStyle, OdDbDiametricDimension, OdDbDictionary, OdDbDictionaryVar, OdDbDictionaryWithDefault, OdDbDimension, OdDbDimStyleTable, OdDbDimStyleTableRecord, OdDbEllipse, OdDbEntity, OdDbEvalExpr, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbField, OdDbFormattedTableData, OdDbGeoData, OdDbGeoPositionMarker, OdDbGroup, OdDbHatch, OdDbHelix, OdDbIdBuffer, OdDbIndex, OdDbLayerFilter, OdDbLayerIndex, OdDbLayerTableRecord, OdDbLayout, OdDbLeader, OdDbLight, OdDbLine, OdDbLinetypeTable, OdDbLinetypeTableRecord, OdDbLinkedData, OdDbLinkedTableData, OdDbLoftedSurface, OdDbLongTransaction, OdDbMaterial, OdDbMInsertBlock, OdDbMLeaderStyle, OdDbMline, OdDbMlineStyle, OdDbModelDocViewStyle, OdDbMotionPath, OdDbMPolygon, OdDbMText, OdDbCurvePath, OdDbPointPath, OdDbNurbSurface, OdDbObjectContextData, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPartialViewingIndex, OdDbPersSubentManager, OdDbPlaneSurface, OdDbPlotSettings, OdDbPoint, OdDbPointCloud, OdDbPointCloudColorMap, OdDbPointCloudDef, OdDbPointCloudDefReactor, OdDbPointCloudDefEx, OdDbPointCloudDefReactorEx, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbProxyObject, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRasterImageDef, OdDbRasterImageDefReactor, OdDbRasterVariables, OdDbRay, OdDbRegAppTableRecord, OdDbRegion, OdDbRenderSettings, OdDbMentalRayRenderSettings, OdDbRapidRTRenderSettings, OdDbRenderEnvironment, OdDbRenderGlobal, OdDbRenderEntry, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSectionSettings, OdDbSectionManager, OdDbSectionViewStyle, OdDbShape, OdDbSolid, OdDbSortentsTable, OdDbSpatialFilter, OdDbSpatialIndex, OdDbSpline, OdDbSubDMesh, OdDbSun, OdDbSurface, OdDbSweptSurface, OdDbSymbolTable, OdDbSymbolTableRecord, OdDbTable, OdDbTableContent, OdDbTableStyle, OdDbTableTemplate, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbUnderlayDefinition, OdDbNavisworksDefinition, OdDbUnderlayReference, OdDbNavisworksReference, OdDbVbaProject, OdDbViewport, OdDbViewportTableRecord, OdDbViewTableRecord, OdDbVisualStyle, OdDbWipeoutVariables, OdDbXline, OdDbXrecord, OdDbLSObject, OdDbBlockRepresentationData, OdDbDynamicBlockPurgePreventer, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbSynergyMappings, OdDbViewBorder, OdDbViewRep, OdDbViewRepCutDefinition, OdDbViewRepDetailDefinition, OdDbViewRepImage, OdDbViewRepInventorSource, OdDbViewRepModelPlaneDef, OdDbViewRepModelSpaceSource, OdDbViewRepModelSpaceViewSelSet, OdDbViewRepOrientation, OdDbViewRepOrientationDef, OdDbViewRepProjectionDef, OdDbViewRepSectionDefinition, OdDbViewRepSource, OdDbViewRepFusionSource, OdDbViewRepSourceMgr, OdDbViewRepStandard, OdDbViewSymbol, RText, OdDbAssocPersSubentManager, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistory, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, OdDbShWedge, OdVLObject, OdDbBlockTableRecord, OdDbDimAssoc, OdDbEvalGraph, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbScale, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMDatabase, CFxBIMDatabaseReference, CFxBIMEntity, CFxBIMEntityReference, CFxBIMMaterial, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, CFxBIMSectionView, and CFxBIMStorage.
◆ dxfIn()
|
virtual |
Reads the DXF format data of this object from the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Returns
- Returns the filer status.
This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented in OdDbProxyObject, OdDb2dPolyline, OdDb3dPolyline, OdDbBlockBegin, OdDbBlockReference, OdDbBlockTable, OdDbDictionaryVar, OdDbEntity, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, OdDbSequenceEnd, OdDbSymbolTable, OdDbTextStyleTableRecord, and OdDbViewportTable.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented in OdDbBreakData, OdDbBreakPointRef, OdDbMLeader, OdDb2dPolyline, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbSolidBackground, OdDbGradientBackground, OdDbImageBackground, OdDbGroundPlaneBackground, OdDbSkyBackground, OdDbIBLBackground, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbColor, OdDbDataLink, OdDbDataTable, OdDbDetailViewStyle, OdDbDiametricDimension, OdDbDictionary, OdDbDictionaryVar, OdDbDictionaryWithDefault, OdDbDimension, OdDbDimStyleTable, OdDbDimStyleTableRecord, OdDbEllipse, OdDbEntity, OdDbEvalExpr, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbField, OdDbFilter, OdDbFormattedTableData, OdDbGeoData, OdDbGeoPositionMarker, OdDbGroup, OdDbHatch, OdDbHelix, OdDbIdBuffer, OdDbIndex, OdDbLayerFilter, OdDbLayerIndex, OdDbLayerTableRecord, OdDbLayout, OdDbLeader, OdDbLight, OdDbLine, OdDbLinetypeTableRecord, OdDbLinkedData, OdDbLinkedTableData, OdDbLoftedSurface, OdDbMaterial, OdDbMInsertBlock, OdDbMLeaderStyle, OdDbMline, OdDbMlineStyle, OdDbModelDocViewStyle, OdDbMotionPath, OdDbMPolygon, OdDbMText, OdDbCurvePath, OdDbPointPath, OdDbNurbSurface, OdDbObjectContextData, OdDbAnnotScaleObjectContextData, OdDbMTextObjectContextData, OdDbTextObjectContextData, OdDbMTextAttributeObjectContextData, OdDbBlkRefObjectContextData, OdDbDimensionObjectContextData, OdDbAlignedDimensionObjectContextData, OdDbAngularDimensionObjectContextData, OdDbDiametricDimensionObjectContextData, OdDbOrdinateDimensionObjectContextData, OdDbRadialDimensionObjectContextData, OdDbRadialDimensionLargeObjectContextData, OdDbFcfObjectContextData, OdDbHatchScaleContextData, OdDbHatchViewContextData, OdDbLeaderObjectContextData, OdDbMLeaderObjectContextData, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPersSubentManager, OdDbPlaceHolder, OdDbPlaneSurface, OdDbPlotSettings, OdDbPoint, OdDbPointCloud, OdDbPointCloudColorMap, OdDbPointCloudDef, OdDbPointCloudDefReactor, OdDbPointCloudDefEx, OdDbPointCloudDefReactorEx, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, OdDbProxyObject, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRasterImageDef, OdDbRasterImageDefReactor, OdDbRasterVariables, OdDbRay, OdDbRegAppTableRecord, OdDbRegion, OdDbRenderSettings, OdDbMentalRayRenderSettings, OdDbRapidRTRenderSettings, OdDbRenderEnvironment, OdDbRenderGlobal, OdDbRenderEntry, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSectionSettings, OdDbSectionManager, OdDbSectionViewStyle, OdDbShape, OdDbSolid, OdDbSortentsTable, OdDbSpatialFilter, OdDbSpatialIndex, OdDbSpline, OdDbSubDMesh, OdDbSun, OdDbSurface, OdDbSweptSurface, OdDbSymbolTable, OdDbSymbolTableRecord, OdDbTable, OdDbTableContent, OdDbTableStyle, OdDbTableTemplate, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbUnderlayDefinition, OdDbNavisworksDefinition, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, OdDbVbaProject, OdDbVertex, OdDbViewport, OdDbViewportTableRecord, OdDbViewTableRecord, OdDbVisualStyle, OdDbWipeoutVariables, OdDbXline, OdDbXrecord, OdDbLSObject, OdDbBlockXYGrip, OdDbBlockPolarGrip, OdDbBlockRotationGrip, OdDbBlockLookupGrip, OdDbBlockVisibilityGrip, OdDbBlockRepresentationData, OdDbDynamicBlockPurgePreventer, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbSynergyMappings, OdDbViewBorder, OdDbViewRep, OdDbViewRepCutDefinition, OdDbViewRepDetailDefinition, OdDbViewRepImage, OdDbViewRepInventorSource, OdDbViewRepModelPlaneDef, OdDbViewRepModelSpaceSource, OdDbViewRepModelSpaceViewSelSet, OdDbViewRepOrientation, OdDbViewRepOrientationDef, OdDbViewRepProjectionDef, OdDbViewRepSectionDefinition, OdDbViewRepSource, OdDbViewRepFusionSource, OdDbViewRepSourceMgr, OdDbViewRepStandard, OdDbViewSymbol, RText, OdDbAssocPersSubentManager, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistory, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, OdDbShWedge, OdVLObject, OdDbBlockTableRecord, OdDbDimAssoc, OdDbEvalGraph, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbScale, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMDatabase, CFxBIMDatabaseReference, CFxBIMEntity, CFxBIMEntityReference, CFxBIMMaterial, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, CFxBIMSectionView, and CFxBIMStorage.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be read.
- Returns
- Returns the filer status.
This function is called by dxfIn() to allow the object to read its data.
When overriding this function:
1) Call assertWriteEnabled(). 2) Call the parent class's dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().
Reimplemented in OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbDimStyleTableRecord, OdDbEntity, OdDbFace, OdDbFaceRecord, OdDbLayerTableRecord, OdDbLine, OdDbLinetypeTableRecord, OdDbOrdinateDimension, OdDbPoint, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbRadialDimension, OdDbRegAppTableRecord, OdDbRotatedDimension, OdDbShape, OdDbSolid, OdDbSymbolTable, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbViewport, OdDbViewportTableRecord, OdDbViewTableRecord, and OdDbPolyline.
◆ dxfOut()
|
virtual |
Writes the DXF format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.
Reimplemented in AECDbEntity, AECDbObject, OdDb2dPolyline, OdDb3dPolyline, OdDbBlockReference, OdDbEntity, OdDbLinetypeTable, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbShape, and OdDbSymbolTable.
◆ dxfOutFields()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Remarks
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented in OdDbBreakData, OdDbBreakPointRef, OdDbMLeader, OdDb2dPolyline, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbSolidBackground, OdDbGradientBackground, OdDbImageBackground, OdDbGroundPlaneBackground, OdDbSkyBackground, OdDbIBLBackground, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbColor, OdDbDataLink, OdDbDataTable, OdDbDetailViewStyle, OdDbDiametricDimension, OdDbDictionary, OdDbDictionaryVar, OdDbDictionaryWithDefault, OdDbDimension, OdDbDimStyleTable, OdDbDimStyleTableRecord, OdDbEllipse, OdDbEntity, OdDbEvalExpr, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbField, OdDbFilter, OdDbFormattedTableData, OdDbGeoData, OdDbGeoPositionMarker, OdDbGroup, OdDbHatch, OdDbHelix, OdDbIdBuffer, OdDbIndex, OdDbLayerFilter, OdDbLayerIndex, OdDbLayerTableRecord, OdDbLayout, OdDbLeader, OdDbLight, OdDbLine, OdDbLinetypeTableRecord, OdDbLinkedData, OdDbLinkedTableData, OdDbLoftedSurface, OdDbMaterial, OdDbMInsertBlock, OdDbMLeaderStyle, OdDbMline, OdDbMlineStyle, OdDbModelDocViewStyle, OdDbMotionPath, OdDbMPolygon, OdDbMText, OdDbCurvePath, OdDbPointPath, OdDbNurbSurface, OdDbObjectContextData, OdDbAnnotScaleObjectContextData, OdDbMTextObjectContextData, OdDbTextObjectContextData, OdDbMTextAttributeObjectContextData, OdDbBlkRefObjectContextData, OdDbDimensionObjectContextData, OdDbAlignedDimensionObjectContextData, OdDbAngularDimensionObjectContextData, OdDbDiametricDimensionObjectContextData, OdDbOrdinateDimensionObjectContextData, OdDbRadialDimensionObjectContextData, OdDbRadialDimensionLargeObjectContextData, OdDbFcfObjectContextData, OdDbHatchScaleContextData, OdDbHatchViewContextData, OdDbLeaderObjectContextData, OdDbMLeaderObjectContextData, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPersSubentManager, OdDbPlaceHolder, OdDbPlaneSurface, OdDbPlotSettings, OdDbPoint, OdDbPointCloud, OdDbPointCloudColorMap, OdDbPointCloudDef, OdDbPointCloudDefReactor, OdDbPointCloudDefEx, OdDbPointCloudDefReactorEx, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, OdDbProxyObject, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRasterImageDef, OdDbRasterImageDefReactor, OdDbRasterVariables, OdDbRay, OdDbRegAppTableRecord, OdDbRegion, OdDbRenderSettings, OdDbMentalRayRenderSettings, OdDbRapidRTRenderSettings, OdDbRenderEnvironment, OdDbRenderGlobal, OdDbRenderEntry, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSectionSettings, OdDbSectionManager, OdDbSectionViewStyle, OdDbSequenceEnd, OdDbShape, OdDbSolid, OdDbSortentsTable, OdDbSpatialFilter, OdDbSpatialIndex, OdDbSpline, OdDbSubDMesh, OdDbSun, OdDbSurface, OdDbSweptSurface, OdDbSymbolTable, OdDbSymbolTableRecord, OdDbTable, OdDbTableContent, OdDbTableStyle, OdDbTableTemplate, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbUnderlayDefinition, OdDbNavisworksDefinition, OdDbUnderlayReference, OdDbNavisworksReference, OdDbVbaProject, OdDbVertex, OdDbViewport, OdDbViewportTableRecord, OdDbViewTableRecord, OdDbVisualStyle, OdDbWipeoutVariables, OdDbXline, OdDbXrecord, OdDbLSObject, OdDbBlockXYGrip, OdDbBlockPolarGrip, OdDbBlockRotationGrip, OdDbBlockLookupGrip, OdDbBlockVisibilityGrip, OdDbBlockRepresentationData, OdDbDynamicBlockPurgePreventer, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbSynergyMappings, OdDbViewBorder, OdDbViewRep, OdDbViewRepCutDefinition, OdDbViewRepDetailDefinition, OdDbViewRepImage, OdDbViewRepInventorSource, OdDbViewRepModelPlaneDef, OdDbViewRepModelSpaceSource, OdDbViewRepModelSpaceViewSelSet, OdDbViewRepOrientation, OdDbViewRepOrientationDef, OdDbViewRepProjectionDef, OdDbViewRepSectionDefinition, OdDbViewRepSource, OdDbViewRepFusionSource, OdDbViewRepSourceMgr, OdDbViewRepStandard, OdDbViewSymbol, RText, OdDbAssocPersSubentManager, OdDbShBoolean, OdDbShBox, OdDbShBrep, OdDbShChamfer, OdDbShCylinder, OdDbShCone, OdDbShExtrusion, OdDbShFillet, OdDbShHistory, OdDbShHistoryNode, OdDbShLoft, OdDbShPrimitive, OdDbShPyramid, OdDbShRevolve, OdDbShSphere, OdDbShSubentColor, OdDbShSubentMaterial, OdDbShSweep, OdDbShTorus, OdDbShWedge, OdVLObject, OdDbBlockTableRecord, OdDbDimAssoc, OdDbEvalGraph, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbScale, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMDatabase, CFxBIMDatabaseReference, CFxBIMEntity, CFxBIMEntityReference, CFxBIMMaterial, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, CFxBIMSectionView, and CFxBIMStorage.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
This function is called by dxfOut() to allow the object to write its data.
When overriding this function:
1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.
Reimplemented in OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbDimStyleTableRecord, OdDbEntity, OdDbFace, OdDbFaceRecord, OdDbLayerTableRecord, OdDbLine, OdDbLinetypeTableRecord, OdDbOrdinateDimension, OdDbPoint, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbRadialDimension, OdDbRegAppTableRecord, OdDbRotatedDimension, OdDbShape, OdDbSolid, OdDbSymbolTable, OdDbSymbolTableRecord, OdDbText, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTableRecord, OdDbViewport, OdDbViewportTableRecord, and OdDbViewTableRecord.
◆ erase()
Sets the erased mode of this object.
- Parameters
-
eraseIt [in] Boolean to specify if object is to be erased or unerased.
- Remarks
- Erased objects are not deleted from the database or from memory.
Erased objects are not filed when the database is saved or sent to a DXF file.
◆ erased()
|
virtual |
Notification function called whenever an object has been erased or unerased.
- Parameters
-
pObject [in] Pointer to the object that was erased/unerased. erasing [in] True if and only if this object is being erased.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbBlockPropertiesTable, OdDbBreakData, OdDbDimAssoc, OdDbViewport, OdDbArcAlignedText, OdDbDictionary, OdDbLeader, OdDbRasterImageDefReactor, OdDbPointCloudDefReactor, and OdDbPointCloudDefReactorEx.
◆ extensionDictionary()
| OdDbObjectId OdDbObject::extensionDictionary | ( | ) | const |
Returns the Object ID of this object's extension dictionary.
- Remarks
- Returns a null ID if this object does not have an extension dictionary, or if its extension dictionary has been erased.
◆ getClassID()
| ODRX_SEALED_VIRTUAL OdResult OdDbObject::getClassID | ( | void * | pClsid | ) | const |
Returns the CLSID value associated with this object.
- Parameters
-
pClsid [out] Pointer to the CLSID value.
- Remarks
- Valid only on Windows with the Drawings built as a DLL.
◆ getDbHandle()
| OdDbHandle OdDbObject::getDbHandle | ( | ) | const |
Returns the persistent handle of this database object.
◆ getField() [1/2]
| OdDbObjectId OdDbObject::getField | ( | const OdString & | fieldName | ) | const |
Returns, and optionally opens, the specified field object from the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the new entry.
◆ getField() [2/2]
| OdDbObjectPtr OdDbObject::getField | ( | const OdString & | fieldName, |
| OdDb::OpenMode | mode | ||
| ) | const |
Returns, and optionally opens, the specified field object from the field dictionary of this object.
- Parameters
-
fieldName [in] Name (key) for the new entry. mode [in] Open mode.
◆ getFieldDictionary() [1/2]
| OdDbObjectId OdDbObject::getFieldDictionary | ( | ) | const |
Returns the field dictionary of this Object.
◆ getFieldDictionary() [2/2]
| OdDbObjectPtr OdDbObject::getFieldDictionary | ( | OdDb::OpenMode | mode | ) | const |
Returns, and optionally opens, the field dictionary of this Object.
- Parameters
-
mode [in] Open mode.
◆ getObjectSaveVersion()
|
virtual |
Returns the drawing and maintenance release version into which this object must be stored.
- Parameters
-
pFiler [in] Pointer to the DWG/DXF filer to be used. pMaintVer [out] Receives the maintenance version.
- Remarks
- The default implementation of this function returns filer->dwgVersion(). This function can be overridden in custom classes.
Do not use filer->dwgVersion() with dwg/dxf(in/out)Fields(); use self()->getObjectSaveVersion() instead.
◆ getPersistentReactors()
| OdDbObjectIdArray OdDbObject::getPersistentReactors | ( | ) | const |
Returns Object IDs of this object's persistent reactors.
◆ getTransientReactors()
| OdDbObjectReactorArray OdDbObject::getTransientReactors | ( | ) | const |
Returns this object's transient reactors.
◆ goodbye()
|
virtual |
Notification function called just before an object is deleted from memory.
- Parameters
-
pObject [in] Pointer to the object that is being deleted.
- Remarks
- An object is deleted when its reference count reaches 0.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbDictionary.
◆ gsNode()
|
virtual |
Returns the OdGsCache of an OdGiDrawable object.
Implements OdGiDrawable.
◆ handle()
|
inline |
Returns the persistent handle of this database object.
Definition at line 255 of file DbObject.h.
◆ handOverTo()
| void OdDbObject::handOverTo | ( | OdDbObject * | pNewObject, |
| bool | keepXData = true, |
||
| bool | keepExtDict = true |
||
| ) |
Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's objectId, handle, owner, and reactor list.
- Parameters
-
pNewObject [in] Pointer to the object with which to replace this object in the database. keepXData [in] This object's XData will be retained if and only if keepXData is true. keepExtDict [in] This object's extension dictionary will be retained if and only if keepExtDict is true.
- Remarks
- This object must be open OdDb::kForWrite.
The replacement object will opened OdDb::kForWrite, and must be closed.
It is up to the caller to delete the replaced (this) object.
Throws:
Cause eIllegalReplacement This object is NDBRO or NewObject is DBRO.
◆ hasFields()
| bool OdDbObject::hasFields | ( | ) | const |
Returns true if and only if this object has fields.
◆ hasPersistentReactor()
| bool OdDbObject::hasPersistentReactor | ( | const OdDbObjectId & | objId | ) | const |
This method returns true if objId is the Object ID of a reactor attached to this object. Otherwise, it returns false.
- Parameters
-
objId [in] Object ID of the persistent reactor.
◆ hasSaveVersionOverride()
| bool OdDbObject::hasSaveVersionOverride | ( | ) | const |
Returns true if and only if this object has its bit set to override the filer version.
◆ id()
|
virtual |
Returns the database ID corresponding to this object.
Implements OdGiDrawable.
◆ isAProxy()
| bool OdDbObject::isAProxy | ( | ) | const |
Returns true if and only if this object is a proxy object or entity.
◆ isDBRO()
| bool OdDbObject::isDBRO | ( | ) | const |
Returns true if and only this object is a database -resident object.
◆ isErased()
| bool OdDbObject::isErased | ( | ) | const |
Returns true if and only if this object is marked as erased.
◆ isEraseStatusToggled()
| bool OdDbObject::isEraseStatusToggled | ( | ) | const |
Returns true if and only if this object's erased status has been toggled since it was opened.
◆ isModified()
| bool OdDbObject::isModified | ( | ) | const |
Returns true if and only if this object's assertWriteEnabled() has been called since it was opened.
◆ isModifiedGraphics()
| bool OdDbObject::isModifiedGraphics | ( | ) | const |
Returns true if and only if an object derived from OdDbEntity has been modified.
- Remarks
This function returns true if and only if an object derived from OdDbEntity either
1) Calls assertWriteEnabled() 2) Calls recordGraphicsModified(true).
◆ isModifiedXData()
| bool OdDbObject::isModifiedXData | ( | ) | const |
Returns true if and only this object's assertWriteEnabled() and setXData() have been called since it was opened.
◆ isNewObject()
| bool OdDbObject::isNewObject | ( | ) | const |
Returns true if and only if this object has not been closed since it was created.
◆ isNotifyEnabled()
| bool OdDbObject::isNotifyEnabled | ( | ) | const |
Returns true if and only if this object is open OdDb::kForNotify.
◆ isNotifying()
| bool OdDbObject::isNotifying | ( | ) | const |
Returns true if and only if this object is sending notification.
◆ isOdDbObjectIdsInFlux()
| bool OdDbObject::isOdDbObjectIdsInFlux | ( | ) | const |
Returns true if and only if this object's Object ID is not valid because the OdDbObject::subDeepClone or OdDbObject::subWblockClone() have yet to be completed.
◆ isPersistent()
|
virtual |
Return true if and only if this object is database -resident (DBRO).
- Remarks
- Persistent objects belong to an object that must be opened and closed.
Non-persistent objects can be accessed through their pointers.
Implements OdGiDrawable.
◆ isReadEnabled()
| bool OdDbObject::isReadEnabled | ( | ) | const |
Returns true if and only if this object is open OdDb::kForRead.
◆ isReallyClosing()
| bool OdDbObject::isReallyClosing | ( | ) | const |
Returns true if and only if a call to close would completely close this object at this time.
- Remarks
- Returns true if and only if a this object is open OdDb::kForRead with only one reader, and is not in a transaction.
◆ isUndoing()
| bool OdDbObject::isUndoing | ( | ) | const |
Returns true if and only if this object is taking part in an Undo operation.
◆ isUndoRecordingDisabled()
| bool OdDbObject::isUndoRecordingDisabled | ( | ) | const |
◆ isWriteEnabled()
| bool OdDbObject::isWriteEnabled | ( | ) | const |
Returns true if and only if this object is open OdDb::kForWrite.
◆ mergeStyle()
|
virtual |
Returns the merge style of this object.
Reimplemented in OdDbDictionary, OdDbProxyObject, and OdDbXrecord.
◆ modified()
|
virtual |
Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.
- Parameters
-
pObject [in] Pointer to the object that is being closed after being modified.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbBreakData, OdDbPointCloudDefReactorEx, OdDbTable, OdDbViewport, OdDbMLeader, OdDbArcAlignedText, OdDbDimension, OdDbRasterImageDefReactor, OdDbFcf, CFxBIMSectionView, and OdDbPointCloudDefReactor.
◆ modifiedGraphics()
|
virtual |
Notification function called whenever an object derived from OdDbEntity is modified.
- Parameters
-
pObject [in] Pointer to the modified object.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
This function is called whenever the following has occurred.
1) The calling object is opened OdDb::kForWrite.
2) One of its member functions either
a Calls its assertWriteEnabled with recordModified == true. b Calls its recordGraphicsModified(true).
3) The calling object is being closed.
This function is called whenever the object as been modified. It therefore indicates only that the graphics for it may have changed.
Reimplemented in OdDbBreakData, OdDbDimAssoc, OdDbHatch, and OdDbLeader.
◆ modifiedXData()
|
virtual |
Notification function called whenever the XData has been written to the notifying object.
- Parameters
-
pObject [in] Pointer to the notifying object.
- Remarks
- Notification is made upon pObject->close() or pObject->cancel().
The notifying object is open OdDb::kForRead.
The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ modifyUndone()
|
virtual |
Notification function called whenever the notifying object is in the midst an Undo operation that is undoing modifications.
- Parameters
-
pObject [in] Pointer to the notifying object.
- Remarks
- The notifying object is open OdDb::kForRead.
The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ numRefs()
|
virtual |
Returns the reference count of this object.
Reimplemented from OdRxObject.
◆ objectClosed()
|
virtual |
Notification function called immediately before an object is closed.
- Parameters
-
objectId [in] Object ID of the object that is being closed.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ objectId()
| OdDbObjectId OdDbObject::objectId | ( | ) | const |
Returns the Object ID of this object.
- Remarks
- Returns a null ID if this object has not been added to a database.
◆ ODDB_DECLARE_MEMBERS()
| OdDbObject::ODDB_DECLARE_MEMBERS | ( | OdDbObject | ) |
◆ openedForModify()
|
virtual |
Notification function called whenever an object is opened for modify OdDb::kForWrite.
- Parameters
-
pObject [in] Pointer to the object that is being opened.
- Remarks
- The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbHatch, and OdDbDimAssoc.
◆ ownerId()
| OdDbObjectId OdDbObject::ownerId | ( | ) | const |
Returns the Object ID of this object's owner.
- Remarks
- Returns a null ID if this object has not been added to a database, or if OdDbObject::setOwnerId has not been called.
Throws:
Cause eNotInDatabase objectId().isNull()
◆ reappended()
|
virtual |
Notification function called whenever a Redo process processes the reappending of the notifying object to the database.
- Parameters
-
pObject [in] Pointer to the notifying object.
- Remarks
The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ recvPropagateModify()
|
virtual |
Allows a subobject of a complex object to notify its root object that it has been changed.
- Parameters
-
pSubObj [in] Pointer to the modifiedsubobject.
- Remarks
- Here's how it's supposed to work:
1) The subobject class's close() calls its triggers a "modified" notification which calls its xmitPropagateModify(). 2) The subobject class calls the its parent's recvPropagateModify() its object's pointer. 3) The owner's class's recvPropagateModify() sends a "modified" notification to the top of its class.
The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ release()
|
virtual |
Decrements the reference count of this object.
- Remarks
- This object is deleted when the reference count reaches zero.
Implements OdRxObject.
◆ releaseExtensionDictionary()
| bool OdDbObject::releaseExtensionDictionary | ( | ) |
Releases and erases this object's extension dictionary if it exists and is empty.
- Remarks
- Returns true if and only if either the dictionary did not exist or was released.
◆ removeField() [1/2]
|
virtual |
◆ removeField() [2/2]
|
virtual |
◆ removePersistentReactor()
|
virtual |
Removes the specified persistent reactor from this object's reactor list.
- Parameters
-
objId [in] Object ID of the persistent reactor.
- Remarks
- An object must be open OdDb::kForWrite in order to remove one of its persistent reactors.
◆ removeReactor()
| void OdDbObject::removeReactor | ( | OdDbObjectReactor * | pReactor | ) | const |
Removes the specified transient reactor from this object's reactor list.
- Parameters
-
pReactor [in] Pointer to the transient reactor object.
- Remarks
- An object must be open either OdDb::kForRead or OdDb::kForWrite in order to remove a transient reactor.
◆ saveAsClass()
For internal use only.
DOM
◆ setField()
|
virtual |
◆ setGsNode()
Assigns the specified OdGsCache to the calling object.
- Parameters
-
pNode [in] Pointer to the OdGsCache object.
Implements OdGiDrawable.
◆ setHasSaveVersionOverride()
| void OdDbObject::setHasSaveVersionOverride | ( | bool | hasSaveVersionOverride | ) |
Controls the flag specifying that this object overrides the save filer version.
- Parameters
-
hasSaveVersionOverride [in] Has save version override.
- Remarks
- By default, objects are saved in the highest of the your object's birth version and the filer version.
◆ setOdDbObjectIdsInFlux()
| void OdDbObject::setOdDbObjectIdsInFlux | ( | ) |
Called on a new created cloned object to indicate that its Object ID is not valid.
- Remarks
- The flags are cleared when the OdDbObject::subDeepClone or OdDbObject::subWblockClone() operation has been completed.
◆ setOwnerId()
|
virtual |
Sets this object's ownerId data member.
- Parameters
-
ownerId [in] Owner's objectId.
- Remarks
- This function lets this object know its owner; it does not notify the owner.
Throws:
Cause eNotInDatabase Owner is not in the database.
◆ setXData()
Sets the XData of this object.
- Parameters
-
pRb [in] A pointer to the ResBuf list containing the XData.
- Remarks
- The sublist for each RegApp, and the ResBuf list itself, must begin with a ResBuf with resbuf.restype == kDxfRegAppName and resbuf.rstring == a valid regAppName string.
Any existing XData for the specified regAppName will be replaced.
To remove the regAppName and its XData, just provide the regAppName with no data.
If you override this method, you should supermessage this classes parent class to add add the XData to the object.
◆ subClose()
|
virtual |
Called as the first operation as this object is being closed, for database -resident objects only.
- Remarks
- This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subClose().
3) If other actions are required before close, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in AECDbEntity, AECDbObject, AECDbStairWinderStyle, AECDbDispProps, AECDbDispRep, OdDb2dPolyline, OdDb3dPolyline, OdDb3dSolid, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbDictionary, OdDbDimension, OdDbField, OdDbGeoPositionMarker, OdDbHatch, OdDbLayout, OdDbMLeaderStyle, OdDbMline, OdDbMText, OdDbOle2Frame, OdDbPlotSettings, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRasterImageDef, OdDbRegion, OdDbSection, OdDbSurface, OdDbTable, OdDbText, OdDbTextStyleTableRecord, OdDbViewport, OdDbViewportTable, OdDbViewportTableRecord, OdDbViewTableRecord, RText, OdDbArcAlignedText, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockTableRecord, OdDbFcf, OdDbGroup, OdDbLeader, OdDbMLeader, OdDbPointCloudDef, OdDbRasterImage, CFxBIMDatabaseReference, and CFxBIMStorage.
◆ subDeepClone()
|
protectedvirtual |
Reimplemented in OdDbDimAssoc, OdDbCamera, OdDbEntity, OdDbGroup, OdDbProxyEntity, OdDbProxyObject, OdDbRasterImage, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionView, and OdDbMLeader.
◆ subErase()
|
virtual |
Called as the first operation as this object is being erased or unerased.
- Parameters
-
erasing [in] A copy of the erasing argument passed to erase().
- Remarks
- This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.
Returns eOk if and only if erase() is to continue.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subErase() returns anything other than eOk, immediately return it.
3) If other actions are required before erase, do them.
4) Return eOk.
If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented in OdDbCamera, OdDbDimStyleTableRecord, OdDbFaceRecord, OdDbLayerTableRecord, OdDbLight, OdDbLinetypeTableRecord, OdDbLongTransaction, OdDbMaterial, OdDbPlotSettings, OdDbPolyFaceMeshVertex, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbProxyObject, OdDbRasterImageDef, OdDbRegAppTableRecord, OdDbSequenceEnd, OdDbSymbolTableRecord, OdDbTable, OdDbTextStyleTableRecord, OdDbViewport, OdDbBlockTableRecord, OdDbEntity, OdDbPointCloudDef, OdDbScale, CFxBIMEntityReference, CFxBIMSection, and CFxBIMSectionView.
◆ subGetClassID()
Reimplemented in OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbBlockTable, OdDbCamera, OdDbCircle, OdDbDatabase, OdDbDiametricDimension, OdDbDictionary, OdDbDimension, OdDbDimStyleTable, OdDbDimStyleTableRecord, OdDbEllipse, OdDbEntity, OdDbExtrudedSurface, OdDbFace, OdDbGroup, OdDbHatch, OdDbHelix, OdDbLayerTable, OdDbLayerTableRecord, OdDbLayout, OdDbLeader, OdDbLight, OdDbLine, OdDbLinetypeTable, OdDbLinetypeTableRecord, OdDbLoftedSurface, OdDbMaterial, OdDbMInsertBlock, OdDbMLeaderStyle, OdDbMline, OdDbMlineStyle, OdDbMText, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPlotSettings, OdDbPoint, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegAppTable, OdDbRegAppTableRecord, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSectionSettings, OdDbSectionManager, OdDbShape, OdDbSolid, OdDbSortentsTable, OdDbSpline, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbTableStyle, OdDbText, OdDbTextStyleTable, OdDbTextStyleTableRecord, OdDbTrace, OdDbUCSTable, OdDbUCSTableRecord, OdDbDwfReference, OdDbDgnReference, OdDbPdfReference, OdDbViewport, OdDbViewportTable, OdDbViewportTableRecord, OdDbViewTable, OdDbViewTableRecord, OdDbXline, OdDbXrecord, OdDb2dPolyline, OdDbBlockTableRecord, OdDbFcf, OdDbMLeader, OdDbPolyline, OdDbRasterImage, and OdDbWipeout.
◆ subHandOverTo()
|
virtual |
Called as the first operation of the handOverTo function.
- Parameters
-
pNewObject [in] Pointer to the object with which to replace this object in the database.
- Remarks
- This function allows custom classes to populate the new object.
- Overriding this function in a child class allows a child instance to be notified each time an object is handed over.
This function is notified just before an object is to be handed over; giving this function the ability to cancel the handover.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subHandover().
3) If other actions are required before handover, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbBlockReference, OdDbEntity, OdDbPlotSettings, OdDbRasterImageDef, OdDbSurface, OdDbTextStyleTableRecord, OdDbBlockTableRecord, OdDbEvalGraph, OdDbPointCloudDef, and CFxBIMDatabaseReference.
◆ subObjModified()
|
virtual |
Notification function called whenever a method of the specified subobject has called assertWriteEnabled()
- Parameters
-
pObject [in] Pointer to the notifying object. pSubObj [in] A pointer to the subobject owned by pObject.
- Remarks
- Notification is made upon pObject->close() or pObject->cancel().
- This function is called only for the modification of the following:
Vertices of OdDb2dPolylines, OdDb3dPolylines, OdDbPolygonMeshs, and OdDbPolyFaceMeshes OdDbFaceRecords of OdDbPolyFaceMeshs OdDbAttributes owned by OdDbBlockReferences, classes derived from OdDbBlockReference, and OdDbMInsertBlocks
◆ subOpen()
|
virtual |
Notification function called by the Teigha framework immediately before an object is opened.
- Parameters
-
mode [in] Mode in which the object is being opened.
- Remarks
- This function is notified just before an object is to be opened; giving this function the ability to cancel the object being opened.
Returns eOk if and only if open() is to continue.
Overriding this function in a child class allows a child instance to be notified each time an object is opened.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subOpen() returns anything other than eOk, immediately return it.
3) If other actions are required before open, do them.
4) Return eOk.
The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.
Reimplemented in OdDbEntity.
◆ subSetAttributes()
|
virtual |
Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.
- Parameters
-
pTraits [in] Pointer to the OdGiDrawableTraits object to be set.
- Remarks
- When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.
A derived class may not remove flags for any reason.
The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.
Implements OdGiDrawable.
Reimplemented in AECDbEntity, OdDb3dSolid, OdDbAbstractViewTableRecord, OdDbAttributeDefinition, OdDbSolidBackground, OdDbGradientBackground, OdDbImageBackground, OdDbGroundPlaneBackground, OdDbSkyBackground, OdDbIBLBackground, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbDimension, OdDbEntity, OdDbGeoPositionMarker, OdDbLayerTableRecord, OdDbLayout, OdDbLight, OdDbLinetypeTableRecord, OdDbMaterial, OdDbMText, OdDbPoint, OdDbRasterImage, OdDbRegion, OdDbRenderSettings, OdDbMentalRayRenderSettings, OdDbRapidRTRenderSettings, OdDbRenderEnvironment, OdDbSubDMesh, OdDbSun, OdDbSurface, OdDbTextStyleTableRecord, OdDbViewport, OdDbVisualStyle, OdDbWipeout, OdDbBlockTableRecord, OdDbLeader, OdDbMLeader, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subSwapIdWith()
|
virtual |
Called as the first operation of swapIdWith
- Parameters
-
otherId [in] Object ID to be swapped with this object's Object ID. swapXdata [in] If and only if true, extended data are swapped. swapExtDict [in] If and only if true, extension dictionaries are swapped.
- Remarks
- This function is notified just before an object is to be opened; giving this function the ability to cancel the object being swapped or perform necessary actions.
When overriding this function:
1) If the OdDbObject's state is incorrect, throw exception.
2) Call parent class's subSwapIdWith().
3) If other actions are required before swapping IDs, do them.
The default implementation of this function does nothing. This function can be overridden in custom classes.
Reimplemented in OdDbEntity, OdDbSymbolTableRecord, and OdDbViewTableRecord.
◆ subViewportDraw()
|
virtual |
Implements OdGiDrawable.
Reimplemented in OdDbMLeader, OdDb3dSolid, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbDimension, OdDbEntity, OdDbFace, OdDbLayerTableRecord, OdDbLight, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbSection, OdDbSolid, OdDbSurface, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbViewRepImage, OdDbFcf, OdDbLeader, OdDbOle2Frame, OdDbPolyline, OdDbRasterImage, OdDbViewRepBlockReference, AECDbEntity, OdDbGeoPositionMarker, OdDbHatch, CFxBIMEntityReference, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, and OdDbLayout.
◆ subWblockClone()
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDbDataLink, OdDbTable, OdDbFcf, OdDbPointCloudDef, OdDbDimAssoc, OdDbDetailViewStyle, OdDbSectionViewStyle, AECDbDispRep, OdDbBlockTableRecord, OdDbCamera, OdDbDimension, OdDbEntity, OdDbGroup, OdDbProxyEntity, OdDbProxyObject, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionView, OdDbMLeader, and OdDbDatabase.
◆ subWorldDraw()
|
virtual |
Implements OdGiDrawable.
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDb3dSolid, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDimension, OdDbEllipse, OdDbEntity, OdDbFace, OdDbHatch, OdDbLayerTableRecord, OdDbLayout, OdDbLight, OdDbLine, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRay, OdDbRegion, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbNavisworksReference, OdDbViewport, OdDbXline, OdDbViewBorder, OdDbViewRepImage, RText, OdDbShHistory, OdDbShPrimitive, OdDbArcAlignedText, OdDbBlockTableRecord, OdDbFcf, OdDbLeader, OdDbMLeader, OdDbOle2Frame, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMRoomSectionEntity, AECDbEntity, OdDbGeoPositionMarker, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewSymbol, CFxBIMEntityReference, CFxBIMSection, and CFxBIMSectionEntity.
◆ swapIdWith()
| void OdDbObject::swapIdWith | ( | OdDbObjectId | otherId, |
| bool | swapXdata = false, |
||
| bool | swapExtDict = false |
||
| ) |
Swaps the objectIDs, handles, XData,and extension dictionary between this object and another object.
- Parameters
-
otherId [in] Object ID of object with which to swap. swapXdata [in] XData will be swapped if and only if swapXData is true. swapExtDict [in] Extension dictionaries will be swapped if and only if swapExtDict is true.
Throws:
Cause eIllegalReplacement Either object is NDBRO.
◆ unappended()
|
virtual |
Notification function called whenever the Undo process processes the appending of the notifying object to the database.
- Parameters
-
pObject [in] Pointer to the notifying object.
- Remarks
- The notifying object is marked as erased. It is not removed the database, and can be unerased, even 'before' it was created.
The default implementation of this function does nothing. This function can be overridden in custom classes.
◆ undoFiler()
| OdDbDwgFiler * OdDbObject::undoFiler | ( | ) |
Description: Returns the undo filer associated with this object.
- Remarks
- This function is typically used by custom classes using partial Undo to add Undo information to the filer that would be used by this object applyPartialUndo().
Throws:
Cause eNotOpenForWrite !isWriteEnabled()
◆ upgradeOpen()
| void OdDbObject::upgradeOpen | ( | ) |
Upgrades this object from OdDb::kForRead to OdDb::kForWrite.
◆ wblockClone()
| ODRX_SEALED_VIRTUAL OdDbObjectPtr OdDbObject::wblockClone | ( | OdDbIdMapping & | idMap, |
| OdDbObject * | pOwner, | ||
| bool | bPrimary = true |
||
| ) | const |
Performs a shallow clone of this object.
- Parameters
-
idMap [in/out] Object ID mapping object. pOwner [in] Pointer to the owner object.
- Remarks
- Returns a SmartPointer to the newly created clone, and adds a record to the specified ID mapping object. If the cloning operation fails, a null SmartPointer is returned.
A shallow clone is a clone of only this object.
This function should not be called by client code; use OdDbDatabase::wblockCloneObjects() instead.
The default implementation of this function calls subWblockClone() for all objects hard-referenced by this object. This function can be overridden in custom classes.
- See also
- <link OdDbObject::subWblockClone@OdDbIdMapping&@OdDbObject*@bool@const, subWblockClone()> <link OdDbObject::deepClone@OdDbIdMapping&@OdDbObject*@bool@const, deepClone()> <link OdDbObject::appendToOwner@OdDbIdPair&@OdDbObject*@OdDbIdMapping&, appendToOwner()>
◆ xData()
|
virtual |
Returns a linked list of ResBufs containing a copy of the XData of this object.
- Parameters
-
regappName [in] Registered application for which to return XData.
- Remarks
- If regappName is empty, all XData of this object will be returned.
If regappName is not empty, XData for only that application will be returned.
Returns a null SmartPointer if there are no XData.
◆ xDataTransformBy()
| void OdDbObject::xDataTransformBy | ( | const OdGeMatrix3d & | xfm | ) |
Applies the 3D transformation matrix to the XData of this object.
- Parameters
-
xfm [in] 3D transformation matrix.
- Remarks
- Applies the transformation matrix to only the following XData data types:
Value kDxfXdWorldXCoord 1011
kDxfXdWorldYCoord 1021
kDxfXdWorldZCoord 1031
kDxfXdWorldXDisp 1012
kDxfXdWorldYDisp 1022
kDxfXdWorldZDisp 1032
kDxfXdWorldXDir 1013
kDxfXdWorldYDir 1023
kDxfXdWorldZDir 1033
kDxfXdDist 1041
kDxfXdScale 1042
◆ xmitPropagateModify()
|
virtual |
Allows a subobject of a complex object to notify its root object that it has been changed.
- Remarks
- This function must be called within an subobject's close() method.
The owner can then propagate the notification that it has been been modified.
The default implementation of this function inform the database in which the owner resides has been modified; triggering any OdDbDatabaseReactors attached to it. This function can be overridden in custom classes.
When overriding this function, it should:
- Remarks
- Here's how it's supposed to work:
1) The subobject class's close() calls its triggers a "modified" notification which calls its xmitPropagateModify(). 2) The subobject class calls the its owner's recvPropagateModify() its object's pointer. 3) This owner's class's recvPropagateModify() sends a "modified" notification to the top of its class.
Friends And Related Function Documentation
◆ OdDbObjectImpl
|
friend |
Definition at line 1734 of file DbObject.h.
◆ OdDbObjectOverrule
|
friend |
Definition at line 1732 of file DbObject.h.
◆ OdDbPropertiesOverrule
|
friend |
Definition at line 1733 of file DbObject.h.
◆ OdDbSystemInternals
|
friend |
Definition at line 1731 of file DbObject.h.
Member Data Documentation
◆ m_pImpl
|
protected |
Definition at line 1735 of file DbObject.h.
The documentation for this class was generated from the following file: