#include <DbBlockTableRecord.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
| 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 | 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 inherited from OdDbObject | |
| OdDbObjectImpl * | m_pImpl |
Detailed Description
This class represents Block records in the OdDbBlockTable in an OdDbDatabase instance.
- See also
- <link Blocks, Overview of Blocks>
<group OdDb_Classes>
Definition at line 58 of file DbBlockTableRecord.h.
Member Typedef Documentation
◆ PreviewIcon
Definition at line 72 of file DbBlockTableRecord.h.
◆ TableType
Definition at line 71 of file DbBlockTableRecord.h.
Member Enumeration Documentation
◆ BlockScaling
This enumeration defines scaling methods for block references.
| Enumerator | |
|---|---|
| kAny | |
| kUniform | |
Definition at line 512 of file DbBlockTableRecord.h.
Constructor & Destructor Documentation
◆ OdDbBlockTableRecord()
| OdDbBlockTableRecord::OdDbBlockTableRecord | ( | ) |
This is the default constructor for objects of the OdDbBlockTableRecord class.
Member Function Documentation
◆ addAnnoScalestoBlkRefs()
Traverses through all block references of this block table record and adds annotation data to each of them.
- Parameters
-
scale [in] If true, set the block references user scale values to the current annotation scale value. If false, set the block references user scale values to 1:1.
◆ appendOdDbEntity()
| OdDbObjectId OdDbBlockTableRecord::appendOdDbEntity | ( | OdDbEntity * | pEntity | ) |
Appends the specified entity to this Block.
- Parameters
-
pEntity [in] Pointer to the entity.
- Returns
- Returns the Object ID of the newly appended entity.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed. This object is using partial Undo.
- Parameters
-
pFiler [in] A pointer to the undo filer with the partial undo information. pClass [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 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.
Reimplemented from OdDbObject.
◆ assumeOwnershipOf()
|
virtual |
This method causes the invoked block table record to assume the ownership of all the entities listed in the input entitiesToMove array, and provides an optimized way of moving entities between block table records.
- Parameters
-
entitiesToMove [in] Array of entities Object Ids.
◆ blockInsertUnits()
| OdDb::UnitsValue OdDbBlockTableRecord::blockInsertUnits | ( | ) | const |
Returns the block insertion units for this Block.
◆ blockScaling()
| BlockScaling OdDbBlockTableRecord::blockScaling | ( | ) | const |
Returns the scaling characteristics of references to this Block.
- Remarks
- blockScaling() returns one of the following:
Value Description kAny 0 Block references can be non-uniformly scaled. kUniform 1 Block references can be scaled only uniformly.
◆ comments()
| OdString OdDbBlockTableRecord::comments | ( | ) | const |
Returns the description text associated with this Block (DXF 4).
◆ copyFrom()
|
virtual |
Copies the contents of the specified object into this object when possible.
- Parameters
-
p [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.
Reimplemented from OdDbSymbolTableRecord.
◆ 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 from OdDbObject.
◆ dwgInFields()
|
virtual |
Reads the .dwg file data of this object.
- Parameters
-
pFiler [in] Filer object from which data are read.
- Remarks
- 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 OdDbSymbolTableRecord.
◆ DWGMAP_DECLARE_MEMBERS()
| OdDbBlockTableRecord::DWGMAP_DECLARE_MEMBERS | ( | OdDbBlockTableRecord | ) |
◆ 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 OdDbSymbolTableRecord.
◆ dxfInFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Remarks
- 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 OdDbSymbolTableRecord.
◆ dxfOutFields()
|
virtual |
Reads the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are read.
- Remarks
- 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 OdDbSymbolTableRecord.
◆ explodable()
| bool OdDbBlockTableRecord::explodable | ( | ) | const |
Returns true if and only if references to this Block can be exploded.
◆ geomExtentsBestFit()
| OdResult OdDbBlockTableRecord::geomExtentsBestFit | ( | OdGeExtents3d & | extents, |
| const OdGeMatrix3d & | parentXform = OdGeMatrix3d::kIdentity |
||
| ) | const |
This method gets copies of this object, applies parentXform to it and after this calculates extents on the resulting object.
- Parameters
-
extents [out] WCS extents of the block reference. parentXform [in] Transformation matrix for block reference's geometry.
◆ getBlockReferenceIds()
| void OdDbBlockTableRecord::getBlockReferenceIds | ( | OdDbObjectIdArray & | referenceIds, |
| bool | directOnly = true, |
||
| bool | forceValidity = false |
||
| ) |
Returns the Object ID's of all OdDbBlockReference entities that reference this Block.
- Parameters
-
referenceIds [out] Receives the BlockReference Object ID's. directOnly [in] If true, returns only direct references. forceValidity [in] If true, forces the loading of partially loaded drawings.
- Remarks
- If this Block is nested, references to the parent block(s) will be included if and only if directOnly is false. Older drawings do not explicitly store this information, and hence must be completely loaded.
- See also
- <link OdDbBlockTableRecord::getErasedBlockReferenceIds@OdDbObjectIdArray&, getErasedBlockReferenceIds() method>
◆ getErasedBlockReferenceIds()
| void OdDbBlockTableRecord::getErasedBlockReferenceIds | ( | OdDbObjectIdArray & | referenceIds | ) |
Returns the Object ID's of all erased OdDbBlockReference entities that directly reference this Block.
- Parameters
-
referenceIds [out] Receives the BlockReference Object ID's.
- See also
- <link OdDbBlockTableRecord::getBlockReferenceIds@OdDbObjectIdArray&@bool@bool, getBlockReferenceIds() method>
◆ getGeomExtents()
|
virtual |
Returns the WCS geometric extents of this object.
- Parameters
-
extents [out] Receives the extents.
- Returns
- Returns eOk if successful, or eInvalidExtents if not.
- Remarks
- The extents are the WCS corner points of a box, aligned with the WCS axes, that encloses the 3D extents of this Block.
Reimplemented from OdGiDrawable.
◆ getLayoutId()
| OdDbObjectId OdDbBlockTableRecord::getLayoutId | ( | ) | const |
Returns the Object ID of the OdDbLayout associated with this Block.
◆ getPreviewIcon()
| void OdDbBlockTableRecord::getPreviewIcon | ( | PreviewIcon & | previewIcon | ) | const |
Returns the preview icon associated with this Block.
- Parameters
-
previewIcon [out] Receives the Preview icon.
◆ getSortentsTable()
| OdDbSortentsTablePtr OdDbBlockTableRecord::getSortentsTable | ( | bool | createIfNotFound = true | ) |
Returns the SortentsTable associated with this block.
- Parameters
-
createIfNotFound [in] Create the SortentsTable if not found.
- Remarks
- The SortentsTable is opened for write.
- See also
- <link OdDbSortentsTable, OdDbSortentsTable class>
◆ hasAttributeDefinitions()
| bool OdDbBlockTableRecord::hasAttributeDefinitions | ( | ) | const |
Returns true if and only if this Block contains Attribute definitions.
- See also
- <link OdDbAttributeDefinition, OdDbAttributeDefinition class>
◆ hasPreviewIcon()
| bool OdDbBlockTableRecord::hasPreviewIcon | ( | ) | const |
Returns true if and only if this Block has a preview icon.
◆ isAnonymous()
| bool OdDbBlockTableRecord::isAnonymous | ( | ) | const |
Returns true if and only if this Block is anonymous (DXF 70, bit 0x01).
\sa <link Blocks, Overview of Blocks>
◆ isFromExternalReference()
| bool OdDbBlockTableRecord::isFromExternalReference | ( | ) | const |
Returns true if and only if this Block is an Xref (DXF 70, bit 0x04).
◆ isFromOverlayReference()
| bool OdDbBlockTableRecord::isFromOverlayReference | ( | ) | const |
Returns true if and only if this Block is an overlaid Xref (DXF 70, bit 0x08).
◆ isLayout()
| bool OdDbBlockTableRecord::isLayout | ( | ) | const |
Returns true if and only if this Block represents a layout.
◆ isUnloaded()
| bool OdDbBlockTableRecord::isUnloaded | ( | ) | const |
Returns true if and only if this Xref is unloaded (DXF 71).
◆ newIterator()
| OdDbObjectIteratorPtr OdDbBlockTableRecord::newIterator | ( | bool | atBeginning = true, |
| bool | skipDeleted = true, |
||
| bool | sorted = false |
||
| ) | const |
Returns an Iterator that can be used to traverse this Block.
- Parameters
-
atBeginning [in] True to start at the beginning, false to start at the end. skipDeleted [in] If and only if true, deleted records are skipped. sorted [in] If and only if true, the iterator will traverse the Block as sorted by this Block's SortentsTable.
- Returns
- Smart pointer to an iterator object.
◆ openBlockBegin()
| OdDbBlockBeginPtr OdDbBlockTableRecord::openBlockBegin | ( | OdDb::OpenMode | openMode = OdDb::kForRead | ) |
Opens and returns the OdDbBlockBegin object associated with this Block.
- Parameters
-
openMode [in] Mode in which to open the object.
- Remarks
- This function allows client applications to access the OdDbBlockBegin object to store and retrieve Xdata in a manner compatible with AutoLISP applications.
◆ openBlockEnd()
| OdDbBlockEndPtr OdDbBlockTableRecord::openBlockEnd | ( | OdDb::OpenMode | openMode = OdDb::kForRead | ) |
Opens and returns the OdDbBlockEnd object associated with this Block.
- Parameters
-
openMode [in] Mode in which to open the object.
- Remarks
- This function allows client applications to access the OdDbBlockEnd object to store and retrieve Xdata in a manner compatible with AutoLISP applications.
◆ origin()
| OdGePoint3d OdDbBlockTableRecord::origin | ( | ) | const |
Returns the WCS origin of this Block (DXF 10).
◆ pathName()
| OdString OdDbBlockTableRecord::pathName | ( | ) | const |
Returns the path and filename for the Xref drawing (DXF 1).
- Remarks
- Returns an empty string for non-Xref blocks.
◆ postProcessAnnotativeBTR()
| void OdDbBlockTableRecord::postProcessAnnotativeBTR | ( | int & | strippedCount, |
| bool | noModify = false, |
||
| bool | scale = true |
||
| ) |
This function is called when a block is set as annotative. All entities in the block are stripped of their annotative property. If a block has nested blocks, they are exploded to entities.
- Parameters
-
strippedCount [out] Number of entities in the block that were stripped of their annotative property. noModify [in] If true, no modifications to the entities in the block are made, but strippedCount value is computed. This mode can be used to check whether the block contains annotative entities. scale [in] If true, scale the entities in the block by the current annotation scale value.
◆ setBlockInsertUnits()
| void OdDbBlockTableRecord::setBlockInsertUnits | ( | OdDb::UnitsValue | blockInsertUnits | ) |
Sets the block insertion units for this Block.
- Parameters
-
blockInsertUnits [in] Block insert units.
◆ setBlockScaling()
| void OdDbBlockTableRecord::setBlockScaling | ( | BlockScaling | blockScaling | ) |
Sets the scaling characteristics of references to this Block.
- Parameters
-
blockScaling [in] Block scaling.
- Remarks
- blockScaling can be one of the following:
Value Description kAny 0 Block references can be non-uniformly scaled. kUniform 1 Block references can be scaled only uniformly.
◆ setComments()
Sets the description text associated with this Block (DXF 4).
- Parameters
-
comments [in] Description text.
◆ setExplodable()
| void OdDbBlockTableRecord::setExplodable | ( | bool | explodable | ) |
Controls if references to this Block can be exploded.
- Parameters
-
explodable [in] Explodable.
◆ setIsFromOverlayReference()
| void OdDbBlockTableRecord::setIsFromOverlayReference | ( | bool | bIsOverlay | ) |
Sets the BlockTableRecord's overlay flag.
- Parameters
-
bIsOverlay [in] True to set the record to be an overlay; false to set the record to be an insert type xref.
◆ setIsUnloaded()
| void OdDbBlockTableRecord::setIsUnloaded | ( | bool | isUnloaded | ) |
Sets the unloaded status of this Xref (DXF 71).
- Parameters
-
isUnloaded [in] Unloaded status.
◆ setLayoutId()
| void OdDbBlockTableRecord::setLayoutId | ( | const OdDbObjectId & | layoutId | ) |
Sets the Object ID of the OdDbLayout associated with this Block.
- Parameters
-
layoutId [in] Layout ID.
◆ setOrigin()
| void OdDbBlockTableRecord::setOrigin | ( | const OdGePoint3d & | origin | ) |
Sets the WCS origin of this Block (DXF 10).
- Parameters
-
origin [in] Origin point.
◆ setPathName()
Sets the path and filename for the Xref drawing (DXF 1).
- Parameters
-
pathName [in] Path and filename.
◆ setPreviewIcon()
| void OdDbBlockTableRecord::setPreviewIcon | ( | const PreviewIcon & | previewIcon | ) |
Sets the preview icon associated with this Block.
- Parameters
-
previewIcon [in] Preview icon.
◆ 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 operations. 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 from OdDbObject.
◆ 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 from OdDbSymbolTableRecord.
◆ subGetClassID()
Overridables.
Reimplemented from OdDbObject.
◆ 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 from OdDbObject.
◆ 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.
Reimplemented from OdDbObject.
◆ subWblockClone()
|
virtual |
This is subWblockClone, a member of class OdDbBlockTableRecord.
Reimplemented from OdDbObject.
◆ subWorldDraw()
|
virtual |
Returns true if the entity has no view-dependent graphics. In another case returns false.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw object.
Reimplemented from OdDbObject.
◆ xrefDatabase()
| OdDbDatabase * OdDbBlockTableRecord::xrefDatabase | ( | bool | includeUnresolved = false | ) | const |
Returns the database that defines this Xref.
- Parameters
-
includeUnresolved [in] Include unresolved Xrefs.
◆ xrefStatus()
| OdDb::XrefStatus OdDbBlockTableRecord::xrefStatus | ( | ) | const |
Returns the Xref status of this Block.
- Remarks
- xrefStatus() returns one of the following:
Value Description OdDb::kXrfNotAnXref 0 Not an Xref OdDb::kXrfResolved 1 Resolved OdDb::kXrfUnloaded 2 Unloaded OdDb::kXrfUnreferenced 3 Unreferenced OdDb::kXrfFileNotFound 4 File Not Found OdDb::kXrfUnresolved 5 Unresolved
The documentation for this class was generated from the following file: