CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
OdDbBlockElement Class Reference

#include <DbBlockElement.h>

Inheritance diagram for OdDbBlockElement:
OdDbEvalConnectable OdDbEvalExpr OdDbObject OdGiDrawable OdRxObject OdDbBlockAction OdDbBlockGrip OdDbBlockParameter OdDbBlockActionWithBasePt OdDbBlockArrayAction OdDbBlockFlipAction OdDbBlockLookupAction OdDbBlockMoveAction OdDbBlockPolarStretchAction OdDbBlockStretchAction OdDbBlockAlignmentGrip OdDbBlockFlipGrip OdDbBlockLinearGrip OdDbBlockLookupGrip OdDbBlockPolarGrip OdDbBlockPropertiesTableGrip OdDbBlockRotationGrip OdDbBlockVisibilityGrip OdDbBlockXYGrip OdDbBlock1PtParameter OdDbBlock2PtParameter

Public Types

enum  HistoryCompression { kHistoryCompression0 , kHistoryCompression1 , kHistoryCompression2 , kHistoryCompression3 }
 
- 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 ,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_EVAL_DECLARE_MEMBERS (OdDbBlockElement)
 
virtual bool evaluate (const OdDbEvalContext *)
 
virtual bool connectionAllowed (const OdString &, OdDbEvalNodeId, const OdString &) const
 DOM OdDbEvalConnectable interface. More...
 
virtual bool connectTo (const OdString &, OdDbEvalNodeId, const OdString &)
 
virtual bool disconnectFrom (const OdString &, OdDbEvalNodeId, const OdString &)
 
virtual bool hasConnectionNamed (const OdString &) const
 
virtual bool getConnectedNames (const OdString &, unsigned long, OdStringArray &) const
 
virtual bool getConnectedObjects (const OdString &, OdDbEvalNodeIdArray &) const
 
virtual void getConnectionNames (OdStringArray &) const
 
virtual bool getConnectionType (const OdString &name, OdResBuf::ValueType &type) const
 
virtual OdResBufPtr getConnectionValue (const OdString &name) const
 
virtual OdString name () const
 DOM
More...
 
virtual void setName (const OdString &)
 
virtual OdDb::MaintReleaseVer getInstanceMaintenanceVersion ()
 
virtual OdDb::DwgVersion getInstanceVersion ()
 
virtual void getStretchPoints (OdGePoint3dArray &) const
 
virtual void moveStretchPointsAt (const OdIntArray &, const OdGeVector3d &)
 
virtual HistoryCompression historyCompression () const
 
virtual bool historyRequired () const
 
virtual bool hasInstanceData () const
 DOM static bool isNameUnique(class OdDbEvalGraph* graph, const OdString& name, OdString* result );. More...
 
virtual bool loadInstanceData (const OdResBuf *, bool bRequireEvaluate=false)
 
virtual OdResBufPtr saveInstanceData () const
 
virtual void updateConnections ()
 
virtual bool isMemberOfCurrentVisibilitySet () const
 
virtual void setMemberOfCurrentVisibilitySet (bool)
 
virtual OdResult transformBy (const OdGeMatrix3d &)
 
- Public Member Functions inherited from OdDbEvalConnectable
 ODDB_DECLARE_MEMBERS (OdDbEvalConnectable)
 
virtual ~OdDbEvalConnectable ()
 
virtual bool setConnectionValue (const OdString &connectionName, const OdResBuf *pValue)
 
- Public Member Functions inherited from OdDbEvalExpr
 ODDB_DECLARE_MEMBERS (OdDbEvalExpr)
 
 OdDbEvalExpr ()
 
virtual ~OdDbEvalExpr ()
 
OdDbEvalGraphPtr getGraph (OdDb::OpenMode openMode=OdDb::kForRead) const
 
OdDbEvalNodeId nodeId () const
 
virtual void addedToGraph (OdDbEvalGraph *pGraph)
 
virtual void removedFromGraph (OdDbEvalGraph *pGraph)
 
virtual void adjacentNodeRemoved (const OdDbEvalNodeId &adjNodeId)
 
virtual void adjacentEdgeRemoved (const OdDbEvalNodeId &adjEdgeNodeId)
 
virtual void adjacentEdgeAdded (const OdDbEvalNodeId &fromId, const OdDbEvalNodeId &toId, bool isInvertible)
 
virtual void movedFromGraph (OdDbEvalGraph *pFromGraph)
 
virtual void movedIntoGraph (OdDbEvalGraph *pIntoGraph)
 
virtual void copiedIntoGraph (OdDbEvalGraph *pIntoGraph)
 
virtual bool isActivatable () const
 
virtual void activated (OdDbEvalNodeIdArray &argumentActiveList)
 
virtual void graphEvalStart (bool nodeIsActive)
 
virtual void graphEvalEnd (bool nodeIsActive)
 
virtual void graphEvalAbort (bool nodeIsActive)
 
virtual bool equals (const OdDbEvalExpr *pOther) const
 
OdResBufPtr value () const
 
OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
void dwgOutFields (OdDbDwgFiler *pFiler) const
 
OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult postInDatabase (OdDbDatabase *)
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () 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 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
 
OdDbDwgFilerundoFiler ()
 
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 &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
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 OdGiDrawabledrawable ()
 
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_SEALED
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () 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 OdRxClasssaveAsClass (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_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbEvalConnectable
 OdDbEvalConnectable ()
 
- 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 OdDbEvalExpr
OdResBufPtr m_lastValue
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

See also
TD_Db

<group OdDb_Classes>

Definition at line 50 of file DbBlockElement.h.

Member Enumeration Documentation

◆ HistoryCompression

Enumerator
kHistoryCompression0 
kHistoryCompression1 
kHistoryCompression2 
kHistoryCompression3 

Definition at line 53 of file DbBlockElement.h.

Member Function Documentation

◆ connectionAllowed()

virtual bool OdDbBlockElement::connectionAllowed ( const OdString ,
OdDbEvalNodeId  ,
const OdString  
) const
virtual

DOM OdDbEvalConnectable interface.

Reimplemented from OdDbEvalConnectable.

◆ connectTo()

virtual bool OdDbBlockElement::connectTo ( const OdString thisConnectionName,
OdDbEvalNodeId  sourceConnectableId,
const OdString sourceConnectionName 
)
virtual

Connects this Connectable object to the specified Connectable object.

Remarks
Both objects must graph-resident.
Parameters
thisConnectionName[in] Connection name on this object.
sourceConnectableId[in] Object ID of the other Connectable object.
sourceConnectionName[in] Connection name on the other Connectable object.
Returns
Returns true if and only if successful.

Reimplemented from OdDbEvalConnectable.

◆ disconnectFrom()

virtual bool OdDbBlockElement::disconnectFrom ( const OdString thisConnectionName,
OdDbEvalNodeId  sourceConnectableId,
const OdString sourceConnectionName 
)
virtual

Disconnects this Connectable object from the specified Connectable object.

Remarks
Both objects must graph-resident.
Parameters
thisConnectionName[in] Connection name on this object.
sourceConnectableId[in] Object ID of the other Connectable object.
sourceConnectionName[in] Connection name on the other Connectable object.
Returns
Returns true if and only if successful.

Reimplemented from OdDbEvalConnectable.

◆ evaluate()

virtual bool OdDbBlockElement::evaluate ( const OdDbEvalContext )
virtual

DOM EvalExpr interface DOM virtual void adjacentNodeRemoved( const OdDbEvalNodeId& );

Reimplemented from OdDbEvalExpr.

◆ getConnectedNames()

virtual bool OdDbBlockElement::getConnectedNames ( const OdString thisConnectionName,
unsigned long  sourceConnectableId,
OdStringArray sourceConnectionNames 
) const
virtual

Returns an array Connection names shared between this OdDbEvalConnectable object and another.

Parameters
thisConnectionName[in] Connection name on this object.
sourceConnectableId[in] ID of the other Connectable object.
sourceConnectionNames[out] Receives an array of connection names.
Returns
Returns true if and only if successful.

Reimplemented from OdDbEvalConnectable.

◆ getConnectedObjects()

virtual bool OdDbBlockElement::getConnectedObjects ( const OdString thisConnectionName,
OdDbEvalNodeIdArray connectedObjects 
) const
virtual

Returns an array of Connectable objects to which this Connectable object is connected.

Parameters
thisConnectionName[in] Connection name on this object.
connectedObjects[out] Receives an array of object IDs.
Returns
Returns true if and only if successful.

Reimplemented from OdDbEvalConnectable.

◆ getConnectionNames()

virtual void OdDbBlockElement::getConnectionNames ( OdStringArray connectionNames) const
virtual

Returns an array of Connection names for this Connectable object.

Parameters
connectionNames[out] Receives an array of Connection names.

Reimplemented from OdDbEvalConnectable.

◆ getConnectionType()

virtual bool OdDbBlockElement::getConnectionType ( const OdString connectionName,
OdResBuf::ValueType connectionType 
) const
virtual

Returns the type of the specified connection for this Connectable object.

Parameters
connectionName[in] Connection name.
connectionType[out] Receives the connection type.
Returns
Returns true if and only if a connection with the specified name exists.

Reimplemented from OdDbEvalConnectable.

◆ getConnectionValue()

virtual OdResBufPtr OdDbBlockElement::getConnectionValue ( const OdString connectionName) const
virtual

Returns the value of the specified connection for this Connectable object.

Parameters
connectionName[in] Connection name.
Remarks
Returns a NULL SmartPointer if a connection with the specified name does not exist.

Reimplemented from OdDbEvalConnectable.

◆ getInstanceMaintenanceVersion()

virtual OdDb::MaintReleaseVer OdDbBlockElement::getInstanceMaintenanceVersion ( )
virtual

DOM virtual unsigned long alertState() const; DOM virtual void auditAlertState(); DOM OdDbObjectId getEntity(); DOM class AcRxClass * getRxEntity(void)

◆ getInstanceVersion()

virtual OdDb::DwgVersion OdDbBlockElement::getInstanceVersion ( )
virtual

◆ getStretchPoints()

virtual void OdDbBlockElement::getStretchPoints ( OdGePoint3dArray ) const
virtual

◆ hasConnectionNamed()

virtual bool OdDbBlockElement::hasConnectionNamed ( const OdString connectionName) const
virtual

Returns true if and only if this Connectable object has a connection with the specified name.

Parameters
connectionName[in] Connection name.

Reimplemented from OdDbEvalConnectable.

◆ hasInstanceData()

virtual bool OdDbBlockElement::hasInstanceData ( ) const
virtual

DOM static bool isNameUnique(class OdDbEvalGraph* graph, const OdString& name, OdString* result );.

◆ historyCompression()

virtual HistoryCompression OdDbBlockElement::historyCompression ( ) const
virtual

◆ historyRequired()

virtual bool OdDbBlockElement::historyRequired ( ) const
virtual

Reimplemented in OdDbBlockLookUpParameter.

◆ isMemberOfCurrentVisibilitySet()

virtual bool OdDbBlockElement::isMemberOfCurrentVisibilitySet ( ) const
virtual

DOM virtual bool onBeginEdit( OdDbBlockTableRecord* ); DOM virtual bool onEndEdit(OdDbBlockTableRecord*);

DOM void OnBeginEditCancelled(class AcDbObjectId,class AcDbObjectId) void OnBeginEditEnded(class AcDbObjectId,class AcDbObjectId) void OnBeginSaveCancelled(class AcDbObjectId,class AcDbObjectId) void OnBeginSaveEnded(class AcDbObjectId,class AcDbObjectId) void OnBeginSaveStarted(class AcDbObjectId,class AcDbObjectId) void OnEndEditCancelled(class AcDbObjectId,class AcDbObjectId) void OnEndEditStarted(class AcDbObjectId,class AcDbObjectId)

◆ loadInstanceData()

virtual bool OdDbBlockElement::loadInstanceData ( const OdResBuf ,
bool  bRequireEvaluate = false 
)
virtual

◆ moveStretchPointsAt()

virtual void OdDbBlockElement::moveStretchPointsAt ( const OdIntArray ,
const OdGeVector3d  
)
virtual

◆ name()

virtual OdString OdDbBlockElement::name ( ) const
virtual

DOM

◆ ODDB_EVAL_DECLARE_MEMBERS()

OdDbBlockElement::ODDB_EVAL_DECLARE_MEMBERS ( OdDbBlockElement  )

◆ saveInstanceData()

virtual OdResBufPtr OdDbBlockElement::saveInstanceData ( ) const
virtual

◆ setMemberOfCurrentVisibilitySet()

virtual void OdDbBlockElement::setMemberOfCurrentVisibilitySet ( bool  )
virtual

◆ setName()

virtual void OdDbBlockElement::setName ( const OdString )
virtual

◆ transformBy()

virtual OdResult OdDbBlockElement::transformBy ( const OdGeMatrix3d )
virtual

DOM enum Acad::ErrorStatus AcDbBlockElement::sync(class AcDbBlockElementEntity *) DOM virtual void transformDefinitionBy( const OdGeMatrix3d &);

◆ updateConnections()

virtual void OdDbBlockElement::updateConnections ( )
virtual

The documentation for this class was generated from the following file: