#include <DbSortentsTable.h>
Public Member Functions inherited from Detailed Description
This class implements the SortentsTable, which specifies the DrawOrder of entities in an OdDbDatabase instance.
- Remarks
- Each instance of this class contains the DrawOrder for a single OdDbBlockRecord.
When drawing entities in a Block Table Record, an iterator traverses the Block Table Record in the order of ascending handles. If there is a HandlePair in the SortentsTable corresponding to the handle of the object about to be drawn, the entity specified by the entity ID in the HandlePair is drawn in its stead. If there is no such HandlePair, the entity referenced by the iterator is drawn.
<group OdDb_Classes>
Definition at line 62 of file DbSortentsTable.h.
Constructor & Destructor Documentation
◆ OdDbSortentsTable()
| OdDbSortentsTable::OdDbSortentsTable | ( | ) |
Member Function Documentation
◆ blockId()
| OdDbObjectId OdDbSortentsTable::blockId | ( | ) | const |
Returns the Object ID of the Block Table Record to which this SortentsTable belongs.
◆ 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.
◆ firstEntityIsDrawnBeforeSecond()
| bool OdDbSortentsTable::firstEntityIsDrawnBeforeSecond | ( | OdDbObjectId | firstID, |
| OdDbObjectId | secondID | ||
| ) | const |
2005 functions
Returns true if and only if the first entity is drawn before the second with this SortentsTable.
- Parameters
-
firstID [in] First entity ID. secondID [in] Second entity ID.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ getAbsoluteDrawOrder()
| void OdDbSortentsTable::getAbsoluteDrawOrder | ( | HandlePairsArray & | handlePairs | ) |
Returns this SortentsTable as an array of HandlePair pairs.
- Parameters
-
handlePairs [out] Receives an array of HandlePairs.
- Remarks
- Use of this function is not recommended.
◆ getFullDrawOrder()
| void OdDbSortentsTable::getFullDrawOrder | ( | OdDbObjectIdArray & | entityIds, |
| OdUInt8 | honorSortentsMask = 0 |
||
| ) | const |
Returns an array of the entity IDs of the entities in the associated Block Table Record, in the DrawOrder for this SortentsTable.
- Parameters
-
entityIds [out] Entity IDs. honorSortentsMask [in] SORTENTS mask.
- Remarks
- If (honorSortentsMask ^ SORTENTS) != honorSortentsMask, the entities are returned unsorted.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- As implemented, honorSortentsMask is ignored. It will be fully implemented in a future release.
◆ getRelativeDrawOrder()
| void OdDbSortentsTable::getRelativeDrawOrder | ( | OdDbObjectIdArray & | entityIds, |
| OdUInt8 | honorSortentsMask = 0 |
||
| ) | const |
Rearranges the specified entity IDs into their current relative DrawOrder for this SortentsTable.
- Parameters
-
entityIds [in/out] Entity IDs. honorSortentsMask [in] SORTENTS mask.
- Remarks
- If (honorSortentsMask ^ SORTENTS) != honorSortentsMask, the entities are returned unsorted.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- As implemented, honorSortentsMask is ignored. It will be fully implemented in a future release.
◆ getSortHandle()
| void OdDbSortentsTable::getSortHandle | ( | const OdDbObjectId & | id, |
| OdDbHandle & | h | ||
| ) | const |
Function returns the handle that indicates the draw order.
◆ moveAbove()
| void OdDbSortentsTable::moveAbove | ( | OdDbObjectIdArray & | entityIds, |
| OdDbObjectId | targetId | ||
| ) |
Moves the entities with specified entity IDs above the target entity in this SortentsTable.
- Parameters
-
entityIds [in] Entity IDs. targetId [in] Target entity ID.
◆ moveBelow()
| void OdDbSortentsTable::moveBelow | ( | OdDbObjectIdArray & | entityIds, |
| OdDbObjectId | targetId | ||
| ) |
Moves the entities with specified entity IDs below the target entity in this SortentsTable.
- Parameters
-
entityIds [in] Entity IDs. targetId [in] Target entity ID.
◆ moveToBottom()
| void OdDbSortentsTable::moveToBottom | ( | OdDbObjectIdArray & | entityIds | ) |
Moves the entities with specified entity IDs to the bottom of this SortentsTable.
- Parameters
-
entityIds [in] Entity IDs.
◆ moveToTop()
| void OdDbSortentsTable::moveToTop | ( | OdDbObjectIdArray & | entityIds | ) |
Moves the entities with specified entity IDs to the top of this SortentsTable.
- Parameters
-
entityIds [in] Entity IDs.
◆ ODDB_DECLARE_MEMBERS()
| OdDbSortentsTable::ODDB_DECLARE_MEMBERS | ( | OdDbSortentsTable | ) |
◆ setAbsoluteDrawOrder()
| void OdDbSortentsTable::setAbsoluteDrawOrder | ( | const HandlePairsArray & | handlePairs | ) |
Sets this SortentsTable from an array of HandlePair pairs.
- Parameters
-
handlePairs [in] HandlePairs.
- Remarks
- Use of this function is not recommended.
◆ setRelativeDrawOrder()
| void OdDbSortentsTable::setRelativeDrawOrder | ( | const OdDbObjectIdArray & | entityIds | ) |
Sets the relative DrawOrder for the specified entities in this SortentsTable.
- Parameters
-
entityIds [in] Entity IDs in DrawOrder.
- Remarks
- The DrawOrder of other entities are unaffected.
Returns eOk if successful, or an appropriate error code if not.
◆ subGetClassID()
Reimplemented from OdDbObject.
◆ swapOrder()
| void OdDbSortentsTable::swapOrder | ( | OdDbObjectId | firstId, |
| OdDbObjectId | secondId | ||
| ) |
Swaps the DrawOrder of the specified entities in this SortentsTable.
- Parameters
-
firstId [in] First entity ID. secondId [in] Second entity ID.
The documentation for this class was generated from the following file: