#include <DbDimAssoc.h>
Protected Member Functions | |
| OdResult | setPointRefReactor (int ptType, bool isAdd=true) |
 Protected Member Functions inherited from OdDbObject | |
| OdDbObject () | |
| virtual OdResult | subGetClassID (void *pClsid) const |
| Protected Member Functions inherited from OdGiDrawable | |
| OdGiDrawable () | |
| virtual OdUInt32 | subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const |
| virtual OdUInt32 | subRegenSupportFlags () const |
Additional Inherited Members | |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| Protected Attributes inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class represents Associative Dimension objects in an OdDbDatabase instance.
Corresponding C++ library: TD_Db
<group OdDb_Classes>
Definition at line 304 of file DbDimAssoc.h.
Member Enumeration Documentation
◆ anonymous enum
| anonymous enum |
| Enumerator | |
|---|---|
| kMaxPointRefs | |
Definition at line 311 of file DbDimAssoc.h.
◆ AssocFlags
| Enumerator | |
|---|---|
| kFirstPointRef | |
| kSecondPointRef | |
| kThirdPointRef | |
| kFourthPointRef | |
Definition at line 341 of file DbDimAssoc.h.
◆ PointType
Definition at line 313 of file DbDimAssoc.h.
◆ RotatedDimType
| Enumerator | |
|---|---|
| kUnknown | |
| kParallel | |
| kPerpendicular | |
Definition at line 334 of file DbDimAssoc.h.
Constructor & Destructor Documentation
◆ OdDbDimAssoc()
| OdDbDimAssoc::OdDbDimAssoc | ( | ) |
Member Function Documentation
◆ addToDimensionReactor()
◆ addToPointRefReactor()
| void OdDbDimAssoc::addToPointRefReactor | ( | ) |
◆ assocFlag() [1/2]
| OdInt32 OdDbDimAssoc::assocFlag | ( | ) | const |
Returns the associativity flag of this Associative Dimension object (DXF 90).
◆ assocFlag() [2/2]
| bool OdDbDimAssoc::assocFlag | ( | int | pointIndex | ) | const |
Returns the associativity flag of the specified Osnap Point Reference for this Associative Dimension object.
◆ 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 from OdDbObject.
◆ dimObjId()
| OdDbObjectId OdDbDimAssoc::dimObjId | ( | ) | const |
Returns the Object ID of the Dimension entity associated with this Associative Dimension object (DXF 330).
◆ 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 from OdDbObject.
◆ 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 from OdDbObject.
◆ 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 from OdDbObject.
◆ 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 from OdDbObject.
◆ 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 from OdDbObject.
◆ getDimAssocGeomIds()
| OdResult OdDbDimAssoc::getDimAssocGeomIds | ( | OdDbObjectIdArray & | geomIds | ) | const |
◆ isAllGeomErased()
| bool OdDbDimAssoc::isAllGeomErased | ( | ) | const |
◆ isTransSpatial()
| bool OdDbDimAssoc::isTransSpatial | ( | ) | const |
Returns the trans-space flag of this Associative Dimension object (DXF 70).
◆ 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 from OdDbObject.
◆ ODDB_DECLARE_MEMBERS()
| OdDbDimAssoc::ODDB_DECLARE_MEMBERS | ( | OdDbDimAssoc | ) |
◆ 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 from OdDbObject.
◆ pointRef()
| OdDbOsnapPointRefPtr OdDbDimAssoc::pointRef | ( | int | pointIndex | ) | const |
Returns the specified Osnap Point Reference for this Associative Dimension object.
- Parameters
-
pointIndex [in] Point index. The value should be 0, 1, 2, 3 or from the PointType enum
- Remarks
- pointIndex must be one of the following:
◆ post()
| OdResult OdDbDimAssoc::post | ( | OdDbObjectId | dimId, |
| OdDbObjectId & | dimAssocId, | ||
| bool | isActive = true |
||
| ) |
◆ removeAssociativity()
◆ removePointRef()
| OdResult OdDbDimAssoc::removePointRef | ( | int | ptType | ) |
◆ rotatedDimType()
| RotatedDimType OdDbDimAssoc::rotatedDimType | ( | ) | const |
Returns the rotated dimension type of this Associative Dimension object (DXF 71).
- Remarks
- rotatedDimType() returns one of the following:
Value kParallel 1 kPerpendicular 2
◆ setAssocFlag() [1/2]
| void OdDbDimAssoc::setAssocFlag | ( | int | assocFlag | ) |
◆ setAssocFlag() [2/2]
| void OdDbDimAssoc::setAssocFlag | ( | int | pointIndex, |
| bool | flagValue | ||
| ) |
◆ setDimObjId()
| void OdDbDimAssoc::setDimObjId | ( | const OdDbObjectId & | dimId | ) |
Sets the Object ID of the Dimension entity associated with this Associative Dimension object (DXF 330).
- Parameters
-
dimId [in] Dimension Object ID.
◆ setPointRef()
| void OdDbDimAssoc::setPointRef | ( | int | pointIndex, |
| OdDbOsnapPointRefPtr | pOsnapPointRef | ||
| ) |
Sets the specified Osnap Point Reference for this Associative Dimension object.
- Parameters
-
pointIndex [in] Point index. The value should be 0, 1, 2, 3 or from the PointType enum pOsnapPointRef [in] SmartPointer to the Osnap Point Reference.
◆ setPointRefReactor()
◆ setRotatedDimType()
| void OdDbDimAssoc::setRotatedDimType | ( | RotatedDimType | dimType | ) |
Sets the rotated dimension type of this Associative Dimension object (DXF 71).
- Remarks
- rotatedDimType must be one of the following:
Value kParallel 1 kPerpendicular 2
◆ setTransSpatial()
| void OdDbDimAssoc::setTransSpatial | ( | bool | value | ) |
Sets the trans-space flag of this Associative Dimension object (DXF 70).
- Parameters
-
transSpace [out] Trans-space flag.
◆ subDeepClone()
|
virtual |
Reimplemented from OdDbObject.
◆ subWblockClone()
|
virtual |
Reimplemented from OdDbObject.
◆ updateDimension()
The documentation for this class was generated from the following file: