CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OdDbShHistory Class Reference

#include <DbShHistory.h>

Inheritance diagram for OdDbShHistory:
OdDbObject OdGiDrawable OdRxObject

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbShHistory)
 
 OdDbShHistory ()
 
virtual ~OdDbShHistory ()
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const
 
virtual OdResult setShowHistory (bool bShowhistory)
 
virtual bool showHistory () const
 
virtual int numNodes () const
 
virtual OdResult setRecordHistory (bool bRecordHistory)
 
virtual bool recordHistory () const
 
virtual void clearHistory ()
 
virtual OdResult purgeGraph ()
 
virtual OdResult getGraph (OdDbObjectId &)
 
virtual OdResult createBox (double dXLen, double dYLen, double dZLen)
 
virtual OdResult createFrustum (double dHeight, double dXRadius, double dYRadius, double dTopXRadius)
 
virtual OdResult createSphere (double dRadius)
 
virtual OdResult createTorus (double dMajorRadius, double dMinorRadius)
 
virtual OdResult createWedge (double dXLen, double dYLen, double dZLen)
 
virtual OdResult createPyramid (double dHeight, int iSides, double dRadius, double dTopRadius)
 
virtual OdResult setSubentColor (const OdDbSubentId &subentId, const OdCmColor &color)
 
virtual OdResult setSubentMaterial (const OdDbSubentId &subentId, OdDbObjectId matId)
 
virtual OdResult createLoftedSolid (OdDbEntityPtrArray &crossSections, OdDbEntityPtrArray &guideCurves, OdDbEntity *pPathCurve, OdDbLoftOptions &loftOpt)
 
virtual OdResult createRevolvedSolid (OdDbEntity *pRevolveCurve, const OdGePoint3d &axisPoint, const OdGeVector3d &axisDir, double dAngleOfRevolution, double dStartAngle, OdDbRevolveOptions &revolveOpt)
 
virtual OdResult createSweptSolid (OdDbEntity *pSweepCurve, OdDbEntity *pPathCurve, const OdGeVector3d &directionVector, OdDbSweepOptions &sweepOpt)
 
virtual OdResult booleanOper (OdDbShHistory *pSecondEll, OdDb::BoolOperType operation)
 
virtual OdResult postInDatabase (OdDbObjectId &objId, OdDbDatabase *pDatabase)
 
virtual OdResult subTransformBy (const OdGeMatrix3d &xform)
 
virtual OdResult filletEdges (const OdArray< OdDbSubentId * > &edgeSubentIds, const OdGeDoubleArray &radius, const OdGeDoubleArray &startSetback, const OdGeDoubleArray &endSetback)
 
virtual OdResult chamferEdges (const OdArray< OdDbSubentId * > &edgeSubentIds, const OdDbSubentId &baseFaceSubentId, double baseDist, double otherDist)
 
virtual OdDb3dSolid::GeomType determineGeomType (OdDb3dSolidGeomParams **params, OdDb3dSolid::GeomType requiredType) const
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~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
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabase * database () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
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 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
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () 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)
 
bool isUndoRecordingDisabled () const
 
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 void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_FINAL
 
void setGsNode (OdGsCache *pNode)
 
OdGsCache * gsNode () 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
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_FINAL
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_FINAL
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Additional Inherited Members

- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground , kEnvironmentBackground = 16 , kCustomBackground
}
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
static void rxInit ()
 
static void rxUninit ()
 
- Protected Member Functions inherited from OdDbObject
 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 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImpl * m_pImpl
 

Detailed Description

<group OdDbSh_Classes>

Definition at line 40 of file DbShHistory.h.

Constructor & Destructor Documentation

◆ OdDbShHistory()

OdDbShHistory::OdDbShHistory ( )

◆ ~OdDbShHistory()

virtual OdDbShHistory::~OdDbShHistory ( )
virtual

Member Function Documentation

◆ booleanOper()

virtual OdResult OdDbShHistory::booleanOper ( OdDbShHistory * pSecondEll,
OdDb::BoolOperType operation )
virtual

◆ chamferEdges()

virtual OdResult OdDbShHistory::chamferEdges ( const OdArray< OdDbSubentId * > & edgeSubentIds,
const OdDbSubentId & baseFaceSubentId,
double baseDist,
double otherDist )
virtual

◆ clearHistory()

virtual void OdDbShHistory::clearHistory ( )
virtual

◆ createBox()

virtual OdResult OdDbShHistory::createBox ( double dXLen,
double dYLen,
double dZLen )
virtual

◆ createFrustum()

virtual OdResult OdDbShHistory::createFrustum ( double dHeight,
double dXRadius,
double dYRadius,
double dTopXRadius )
virtual

◆ createLoftedSolid()

virtual OdResult OdDbShHistory::createLoftedSolid ( OdDbEntityPtrArray & crossSections,
OdDbEntityPtrArray & guideCurves,
OdDbEntity * pPathCurve,
OdDbLoftOptions & loftOpt )
virtual

◆ createPyramid()

virtual OdResult OdDbShHistory::createPyramid ( double dHeight,
int iSides,
double dRadius,
double dTopRadius )
virtual

◆ createRevolvedSolid()

virtual OdResult OdDbShHistory::createRevolvedSolid ( OdDbEntity * pRevolveCurve,
const OdGePoint3d & axisPoint,
const OdGeVector3d & axisDir,
double dAngleOfRevolution,
double dStartAngle,
OdDbRevolveOptions & revolveOpt )
virtual

◆ createSphere()

virtual OdResult OdDbShHistory::createSphere ( double dRadius)
virtual

◆ createSweptSolid()

virtual OdResult OdDbShHistory::createSweptSolid ( OdDbEntity * pSweepCurve,
OdDbEntity * pPathCurve,
const OdGeVector3d & directionVector,
OdDbSweepOptions & sweepOpt )
virtual

◆ createTorus()

virtual OdResult OdDbShHistory::createTorus ( double dMajorRadius,
double dMinorRadius )
virtual

◆ createWedge()

virtual OdResult OdDbShHistory::createWedge ( double dXLen,
double dYLen,
double dZLen )
virtual

◆ determineGeomType()

virtual OdDb3dSolid::GeomType OdDbShHistory::determineGeomType ( OdDb3dSolidGeomParams ** params,
OdDb3dSolid::GeomType requiredType ) const
virtual

◆ dwgInFields()

virtual OdResult OdDbShHistory::dwgInFields ( OdDbDwgFiler * pFiler)
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 from OdDbObject.

◆ dwgOutFields()

virtual void OdDbShHistory::dwgOutFields ( OdDbDwgFiler * pFiler) const
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 from OdDbObject.

◆ dxfInFields()

virtual OdResult OdDbShHistory::dxfInFields ( OdDbDxfFiler * pFiler)
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 from OdDbObject.

◆ dxfOutFields()

virtual void OdDbShHistory::dxfOutFields ( OdDbDxfFiler * pFiler) const
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 from OdDbObject.

◆ filletEdges()

virtual OdResult OdDbShHistory::filletEdges ( const OdArray< OdDbSubentId * > & edgeSubentIds,
const OdGeDoubleArray & radius,
const OdGeDoubleArray & startSetback,
const OdGeDoubleArray & endSetback )
virtual

◆ getGraph()

virtual OdResult OdDbShHistory::getGraph ( OdDbObjectId & )
virtual

◆ numNodes()

virtual int OdDbShHistory::numNodes ( ) const
virtual

◆ ODDB_DECLARE_MEMBERS()

OdDbShHistory::ODDB_DECLARE_MEMBERS ( OdDbShHistory )

◆ postInDatabase()

virtual OdResult OdDbShHistory::postInDatabase ( OdDbObjectId & objId,
OdDbDatabase * pDatabase )
virtual

◆ purgeGraph()

virtual OdResult OdDbShHistory::purgeGraph ( )
virtual

◆ recordHistory()

virtual bool OdDbShHistory::recordHistory ( ) const
virtual

◆ setRecordHistory()

virtual OdResult OdDbShHistory::setRecordHistory ( bool bRecordHistory)
virtual

◆ setShowHistory()

virtual OdResult OdDbShHistory::setShowHistory ( bool bShowhistory)
virtual

◆ setSubentColor()

virtual OdResult OdDbShHistory::setSubentColor ( const OdDbSubentId & subentId,
const OdCmColor & color )
virtual

◆ setSubentMaterial()

virtual OdResult OdDbShHistory::setSubentMaterial ( const OdDbSubentId & subentId,
OdDbObjectId matId )
virtual

◆ showHistory()

virtual bool OdDbShHistory::showHistory ( ) const
virtual

◆ subTransformBy()

virtual OdResult OdDbShHistory::subTransformBy ( const OdGeMatrix3d & xform)
virtual

◆ subWorldDraw()

virtual bool OdDbShHistory::subWorldDraw ( OdGiWorldDraw * pWd) const
virtual

Creates a viewport-independent geometric representation of this object.

Parameters
pWd[in] Pointer to the OdGiWorldDraw interface. Returns true if and only if the geometric representation can be generated in a viewport-independent manner.

Reimplemented from OdDbObject.

The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:26