#include <DbEntity.h>
Friends | |
| class | OdDbPropertiesOverrule |
| class | OdDbOsnapOverrule |
| class | OdDbTransformOverrule |
| class | OdDbGripOverrule |
| class | OdDbSubentityOverrule |
| class | OdDbHighlightOverrule |
| class | OdDbVisibilityOverrule |
| class | OdDbGeometryOverrule |
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 is the base class for all graphical objects contained in an OdDbDatabase instance.
<group OdDb_Classes>
Definition at line 87 of file DbEntity.h.
Member Enumeration Documentation
◆ VisualStyleType
| Enumerator | |
|---|---|
| kFullVisualStyle | |
| kFaceVisualStyle | |
| kEdgeVisualStyle | |
Definition at line 356 of file DbEntity.h.
Constructor & Destructor Documentation
◆ OdDbEntity()
| OdDbEntity::OdDbEntity | ( | ) |
Member Function Documentation
◆ addSubentPaths()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::addSubentPaths | ( | const OdDbFullSubentPathArray & | paths | ) |
Add one or more subentities to an entity.
- Parameters
-
paths [in] The array of OdDbFullSubentPath objects.
◆ appendToOwner()
|
virtual |
This function appends this object to the specified owner object during the deep or wblock clone operation.
- Parameters
-
idPair [in] Original-to-clone ID mapping record for this clone. pOwnerObject [in] Pointer to the owner object. idMap [in/out] ID mapping object of the cloning operation in progress.
- Remarks
- This callback is called before the IDs are translated in the target database so the implementer should use only methods certainly not traversing hierarchy in the target database. To follow clone's references properly they should be translated using the ID mapping object.
The default implementation appends this object to OdDbDictionary or throws the eInvalidOwnerObject exception if the owner object is not a kind of dictionary.
- See also
- <link OdDbObject::subDeepClone@OdDbIdMapping&@OdDbObject*@bool@const, subDeepClone()> <link OdDbObject::subWblockClone@OdDbIdMapping&@OdDbObject*@bool@const, subWblockClone()> <link OdDbObject::deepClone@OdDbIdMapping&@OdDbObject*@bool@const, deepClone()> <link OdDbObject::wblockClone@OdDbIdMapping&@OdDbObject*@bool@const, wblockClone()>
Reimplemented from OdDbObject.
◆ applyPartialUndo()
|
virtual |
Notification function called each time an Undo operation is performed this object is using partial Undo.
- Parameters
-
pUndoFiler [in] A pointer to the undo filer with the partial undo information. pClassObj [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 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.
Throws:
Cause eNotThatKindOfClass pClassObj != OdDbObject::desc()
Reimplemented from OdDbObject.
Reimplemented in CFxBIMEntityReference, and CFxBIMRoomSectionEntity.
◆ blockId()
| OdDbObjectId OdDbEntity::blockId | ( | ) | const |
Returns the Object ID of the OdDbBlockTableRecord that owns this entity.
◆ boundingBoxIntersectWith() [1/2]
| OdResult OdDbEntity::boundingBoxIntersectWith | ( | const OdDbEntity * | pEnt, |
| OdDb::Intersect | intType, | ||
| const OdGePlane & | projPlane, | ||
| OdGePoint3dArray & | points, | ||
| OdGsMarker | thisGsMarker, | ||
| OdGsMarker | otherGsMarker | ||
| ) | const |
Uses the bounding box of this object to determine an intersection array of points.
◆ boundingBoxIntersectWith() [2/2]
| OdResult OdDbEntity::boundingBoxIntersectWith | ( | const OdDbEntity * | pEnt, |
| OdDb::Intersect | intType, | ||
| OdGePoint3dArray & | points, | ||
| OdGsMarker | thisGsMarker, | ||
| OdGsMarker | otherGsMarker | ||
| ) | const |
Uses the bounding box of this object to determine an intersection array of points.
◆ castShadows()
|
virtual |
Returns the CastShadows flag for this entity..
◆ cloneMeForDragging()
| ODRX_SEALED_VIRTUAL bool OdDbEntity::cloneMeForDragging | ( | ) |
Returns the cloneMeForDragging flag for this entity.
◆ collisionType()
|
virtual |
Returns the CollisionType for this entity.
- Remarks
- Subclasses may override this method to customize how the class interacts in collision-aware features.
◆ color()
| OdCmColor OdDbEntity::color | ( | ) | const |
Returns the color information of this entity as an OdCmColor instance.
◆ colorId()
| OdDbObjectId OdDbEntity::colorId | ( | ) | const |
Returns the Object ID of the OdDbColor object referenced by this entity.
◆ colorIndex()
| OdUInt16 OdDbEntity::colorIndex | ( | ) | const |
Returns the color index of this entity (DXF 62).
- Returns
- Returns a value in the range [0 .. 256].
0 indicates a color of BYBLOCK. 256 indicates a color of BYLAYER.
◆ copyFrom()
|
virtual |
Copies the contents of the specified object into this object when possible.
- Parameters
-
pSource [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.
Throws:
Cause eNullObjectPointer pSource->isNull()
Reimplemented from OdDbObject.
Reimplemented in AECDbWindow, OdDbMLeader, OdDbTable, OdDb3dSolid, OdDbBody, OdDbRegion, OdDbSurface, and OdDbBlockReference.
◆ deleteSubentPaths()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::deleteSubentPaths | ( | const OdDbFullSubentPathArray & | paths | ) |
Deletes one or more subentities from an entity.
- Parameters
-
paths [in] The array of OdDbFullSubentPath objects.
◆ dragStatus()
|
virtual |
Notification function called when this entity is involved in a drag operation.
- Parameters
-
status [in] Status of the drag operation.
Reimplemented in AECDbEntity.
◆ 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.
- 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.
Reimplemented in OdDbMLeader, AECDbEntity, OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbGeoPositionMarker, OdDbHatch, OdDbHelix, OdDbLeader, OdDbLight, OdDbLine, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbNurbSurface, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, OdDbViewport, OdDbXline, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewBorder, OdDbViewRepImage, OdDbViewSymbol, RText, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMEntityReference, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ 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.
Reimplemented in OdDbMLeader, AECDbEntity, OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbGeoPositionMarker, OdDbHatch, OdDbHelix, OdDbLeader, OdDbLight, OdDbLine, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbNurbSurface, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbNavisworksReference, OdDbViewport, OdDbXline, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewBorder, OdDbViewRepImage, OdDbViewSymbol, RText, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMEntityReference, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ dxfIn()
|
virtual |
Reads the DXF format data of this object from the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer from which the data are to be read.
- Returns
- Returns the filer status.
This function calls this object's dxfInFields(pFiler), then loads any Xdata associated with this object.
Reimplemented from OdDbObject.
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDbBlockBegin, OdDbBlockReference, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, and OdDbSequenceEnd.
◆ 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.
Reimplemented in OdDbMLeader, OdDb2dPolyline, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbGeoPositionMarker, OdDbHatch, OdDbHelix, OdDbLeader, OdDbLight, OdDbLine, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbNurbSurface, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, OdDbVertex, OdDbViewport, OdDbXline, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewBorder, OdDbViewRepImage, OdDbViewSymbol, RText, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMEntityReference, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ dxfInFields_R12()
|
virtual |
Reads the DXF R12 format data of this object.
- Parameters
-
pFiler [in] Pointer to the filer from which data are to be 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 dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(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.
Reimplemented in OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbFace, OdDbFaceRecord, OdDbLine, OdDbOrdinateDimension, OdDbPoint, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbRadialDimension, OdDbRotatedDimension, OdDbShape, OdDbSolid, OdDbText, OdDbTrace, OdDbViewport, and OdDbPolyline.
◆ dxfOut()
|
virtual |
Writes the DXF format data of this object to the specified filer.
- Parameters
-
pFiler [in] Pointer to the filer to which the data are to be written.
- Remarks
- This function calls this object's dxfOutFields(pFiler) function, writes any Xdata associated with this object.
Reimplemented from OdDbObject.
Reimplemented in AECDbEntity, OdDb2dPolyline, OdDb3dPolyline, OdDbBlockReference, OdDbPolyFaceMesh, OdDbPolygonMesh, and OdDbShape.
◆ 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.
Reimplemented in OdDbMLeader, OdDb2dPolyline, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcAlignedText, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbFaceRecord, OdDbGeoPositionMarker, OdDbHatch, OdDbHelix, OdDbLeader, OdDbLight, OdDbLine, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbNurbSurface, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbProxyEntity, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbSequenceEnd, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbNavisworksReference, OdDbVertex, OdDbViewport, OdDbXline, OdDbAssocProjectedEntityPersSubentIdHolder, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewBorder, OdDbViewRepImage, OdDbViewSymbol, RText, OdDbFcf, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMEntityReference, CFxBIMRoomEntity, CFxBIMRoomSectionEntity, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ dxfOutFields_R12()
|
virtual |
Writes the DXF data of this object.
- Parameters
-
pFiler [in] Pointer to the filer to which data are to be written.
- Returns
- Returns the filer status.
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). 3) 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.
Reimplemented in OdDb2dPolyline, OdDb2dVertex, OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dPolylineVertex, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbFace, OdDbFaceRecord, OdDbLine, OdDbOrdinateDimension, OdDbPoint, OdDbPolyFaceMesh, OdDbPolyFaceMeshVertex, OdDbPolygonMesh, OdDbPolygonMeshVertex, OdDbRadialDimension, OdDbRotatedDimension, OdDbShape, OdDbSolid, OdDbText, OdDbTrace, and OdDbViewport.
◆ entityColor()
|
virtual |
Returns the OdCmEntityColor settings of this object.
◆ explode()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::explode | ( | OdRxObjectPtrArray & | entitySet | ) | const |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
- Remarks
- Entities resulting from the explosion are appended to the specified array. The newly created entities are not database resident. The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
◆ explodeGeometry()
|
virtual |
Explodes this entity into a set of simpler entities.
- Parameters
-
entitySet [in/out] Receives an array of pointers to the new entities.
- Remarks
- The newly created entities will be not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in AECDbEntity, OdDb3dPolyline, OdDbBlockReference, OdDbDimension, OdDbHatch, OdDbMline, OdDbMText, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbPolyline, OdDbViewport, and OdDb2dPolyline.
◆ explodeGeometryToBlock()
|
virtual |
Explodes this entity into a set of simpler entities, and adds them to the specified block.
- Parameters
-
pBlockRecord [in] Pointer to the Block Table Record. ids [in/out] Receives array of Object IDs of the new entities.
- Remarks
- The newly created entities are database resident or not depending on the block table record they are appended to. If block table record is database resident the entities are database resident too. If block table record is not database resident newly created entities are not database resident. Entities resulting from the explosion are appended to the specified array. The default implementation of this function calls subWorldDraw() and makes entities from geometry generated by subWorldDraw(). This function can be overridden in custom classes.
◆ explodeToBlock()
|
virtual |
Explodes this entity into a set of simpler entities, and adds them to the specified block table record.
- Parameters
-
pBlockRecord [in] Pointer to the Block Table Record. ids [in/out] Receives an array of Object IDs of the new entities.
- Remarks
- Entities resulting from the explosion are appended to the specified array.
The newly created entities are database resident or not depending on the block table record they are appended to. If block table record is database resident the entities are database resident as well. If block table record is not database resident newly created entities are not database resident.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
Reimplemented in OdDbBlockReference, and OdDbMInsertBlock.
◆ getCompoundObjectTransform()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getCompoundObjectTransform | ( | OdGeMatrix3d & | xM | ) | const |
Is applicable for compound objects only which return the kDrawableIsCompoundObject flag from subSetAttributes(). The matrix returned is the one that is passed to pushModelTransform before rendering nested objects. Default implementation returns OdDb::eNotApplicable and the identity matrix in xM.
◆ getEcs()
|
virtual |
Returns the entity coordinate system matrix.
- Remarks
- Default implementation returns Identity matrix.
Reimplemented in OdDb2dPolyline, OdDbArc, OdDbCircle, OdDbDimension, OdDbHatch, OdDbLine, OdDbMText, OdDbPolyline, OdDbShape, OdDbSolid, OdDbTrace, and OdDbUnderlayReference.
◆ getGeomExtents()
|
virtual |
Retrieves a WCS bounding box that represents the extents of this entity.
- Parameters
-
extents [out] Receives the WCS extents.
- Returns
- Returns eOk if successful or an appropriate error code if not.
- Remarks
- The default implementation of this function always returns eInvalidExtents.
Reimplemented from OdGiDrawable.
◆ getGripPoints() [1/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getGripPoints | ( | OdDbGripDataPtrArray & | grips, |
| const double | curViewUnitSize, | ||
| const int | gripSize, | ||
| const OdGeVector3d & | curViewDir, | ||
| const int | bitFlags | ||
| ) | const |
Returns OdDbGripData objects for grip points of this entity.
- Parameters
-
grips [in/out] Receives an array of OdDbGripData objects.
- Remarks
- Grip points are appended to the specified array.
◆ getGripPoints() [2/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getGripPoints | ( | OdGePoint3dArray & | gripPoints | ) | const |
Returns all grip points of this entity.
- Parameters
-
gripPoints [in/out] Receives an array of WCS grip points.
- Remarks
- Grip points are appended to the specified array.
◆ getGripPointsAtSubentPath()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getGripPointsAtSubentPath | ( | const OdDbFullSubentPath & | path, |
| OdDbGripDataPtrArray & | grips, | ||
| const double | curViewUnitSize, | ||
| const int | gripSize, | ||
| const OdGeVector3d & | curViewDir, | ||
| const OdUInt32 | bitflags | ||
| ) | const |
Gets the grip points and supporting information about the grips for a subentity.
- Parameters
-
path [in] The OdDbFullSubentPath to the subentity. grips [in/out] Receives an array of pointers of OdDbGripData objects, one object for each grip point in the subentity. curViewUnitSize [in] The size (in pixels) of one drawing unit in the current viewport. gripSize [in] The current grip size (in pixels). curViewDir [in] The view direction in the current viewport. bitflags [in] The bitmap of one or more flags specified by the GetGripPointsFlags enumeration.
◆ getGsMarkersAtSubentPath()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getGsMarkersAtSubentPath | ( | const OdDbFullSubentPath & | subPath, |
| OdGsMarkerArray & | gsMarkers | ||
| ) | const |
Returns all graphic system marker by subentity paths for complex entities, that has the ability to associate an integer identifier (GS marker) with each graphic primitive or with groups of primitives during draw themself.
- Parameters
-
subPath [in] The OdDbFullSubentPath to the subentity. gsMarkers [in/out] The array of integer identifiers (GS markers).
◆ getOsnapPoints() [1/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getOsnapPoints | ( | OdDb::OsnapMode | osnapMode, |
| OdGsMarker | gsSelectionMark, | ||
| const OdGePoint3d & | pickPoint, | ||
| const OdGePoint3d & | lastPoint, | ||
| const OdGeMatrix3d & | xWorldToEye, | ||
| OdGePoint3dArray & | snapPoints | ||
| ) | const |
Returns all appropriate object snap points of this entity.
- Parameters
-
osnapMode [in] The object snap mode being queried. gsSelectionMark [in] The GS marker of the subentity being queried. pickPoint [in] The WCS point being queried. lastPoint [in] The WCS point picked before pickPoint. xWorldToEye [in] The WCS->DCS transformation matrix. snapPoints [in/out] Receives an array of UCS object snap points.
- Remarks
- Object snap points are appended to the specified array.
osnapMode must be one of the following:
Value Description OdDb::kOsModeEnd 1 Endpoint OdDb::kOsModeMid 2 Midpoint OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Unknown
◆ getOsnapPoints() [2/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getOsnapPoints | ( | OdDb::OsnapMode | osnapMode, |
| OdGsMarker | gsSelectionMark, | ||
| const OdGePoint3d & | pickPoint, | ||
| const OdGePoint3d & | lastPoint, | ||
| const OdGeMatrix3d & | xWorldToEye, | ||
| OdGePoint3dArray & | snapPoints, | ||
| const OdGeMatrix3d & | insertionMat | ||
| ) | const |
Returns all appropriate object snap points of this entity.
- Parameters
-
osnapMode [in] The object snap mode being queried. gsSelectionMark [in] The GS marker of the subentity being queried. pickPoint [in] The WCS point being queried. lastPoint [in] The WCS point picked before pickPoint. xWorldToEye [in] The WCS->DCS transformation matrix. snapPoints [in/out] Receives an array of UCS object snap points.
- Remarks
- Object snap points are appended to the specified array.
osnapMode must be one of the following:
Value Description OdDb::kOsModeEnd 1 Endpoint OdDb::kOsModeMid 2 Midpoint OdDb::kOsModeCen 3 Center OdDb::kOsModeNode 4 Node OdDb::kOsModeQuad 5 Quadrant OdDb::kOsModeIntersec 6 Intersection OdDb::kOsModeIns 7 Insertion point OdDb::kOsModePerp 8 Perpendicular OdDb::kOsModeTan 9 Tangent OdDb::kOsModeNear 10 Nearest OdDb::kOsModeApint 11 Apparent intersection OdDb::kOsModePar 12 Parallel OdDb::kOsModeStart 13 Unknown
◆ getPlane()
|
virtual |
Returns the plane that contains this entity.
- Parameters
-
plane [out] Receives the plane that contains this entity. planarity [out] Receives the planarity of this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
planarity and plane return values as follows::
Value Description plane kNonPlanar 0 Non-planar Not set kPlanar 1 Planar Entity plane kLinear 2 Linear Arrbitrary plane containing this entity
Reimplemented in OdDbArc, OdDbCircle, OdDbEllipse, OdDbLine, OdDbPoint, OdDbRay, OdDbSolid, OdDbTrace, OdDbXline, OdDb2dPolyline, OdDb3dPolyline, OdDbBlockReference, OdDbDimension, OdDbFace, OdDbHatch, OdDbLeader, OdDbMText, OdDbPlaneSurface, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbPolyline, OdDbRegion, OdDbShape, OdDbSpline, OdDbText, and OdDbMLeader.
◆ getPlotStyleNameId()
| OdDb::PlotStyleNameType OdDbEntity::getPlotStyleNameId | ( | OdDbObjectId & | plotStyleNameId | ) | const |
Returns the PlotStyleName of this entity.
- Parameters
-
plotStyleNameId [out] Receives the Object ID of the Plot Style Name of this entity.
◆ getStretchPoints()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getStretchPoints | ( | OdGePoint3dArray & | stretchPoints | ) | const |
Returns all stretch points of this entity.
- Parameters
-
stretchPoints [in/out] Receives an array of WCS stretch points.
- Remarks
- Stretch points are appended to the specified array.
◆ getSubentClassId()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getSubentClassId | ( | const OdDbFullSubentPath & | path, |
| void * | clsId | ||
| ) |
Obtains the CLSID of the wrapper coclass for the subentity.
- Parameters
-
path [in] The OdDbFullSubentPath to the subentity. clsId [in/out] The pointer to a CLSID structure whose contents are set to the CLSID of the wrapper for the subentity.
◆ getSubentPathGeomExtents()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getSubentPathGeomExtents | ( | const OdDbFullSubentPath & | path, |
| OdGeExtents3d & | extents | ||
| ) |
Returns the geometric extents for a subentity.
- Parameters
-
path [in] The OdDbFullSubentPath to the subentity. extents [in/out] The geometric extents, expressed in world coordinates, of the subentity.
◆ getSubentPathsAtGsMarker()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getSubentPathsAtGsMarker | ( | OdDb::SubentType | type, |
| OdGsMarker | gsMark, | ||
| const OdGePoint3d & | pickPoint, | ||
| const OdGeMatrix3d & | xfm, | ||
| OdDbFullSubentPathArray & | subentPaths, | ||
| const OdDbObjectIdArray * | pEntAndInsertStack = 0 |
||
| ) | const |
Returns all subentity paths by graphic system marker for complex entities, that has the ability to associate an integer identifier (GS marker) with each graphic primitive or with groups of primitives during draw themself.
- Parameters
-
type [in] The subentity type being queried. gsMarker [in] The GS marker of the subentity being queried. pickPoint [in] The WCS point being queried. xrm [in] The WCS->DCS transformation matrix. subentPaths [out] The array of OdDbFullSubentPath objects. pEntAndInsertStack [in] The array of objectIds of the objects that are the nested containers of the subentity.
- Remarks
- Subentity type must be one of the following:
Value Description OdDb::kFaceSubentType 1 Face subentity OdDb::kEdgeSubentType 2 Edge subentity OdDb::kVertexSubentType 3 Vertex subentity OdDb::kMlineSubentCache 4 Not used yet OdDb::kClassSubentType 5 MultiType subentity
◆ getTransformedCopy()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::getTransformedCopy | ( | const OdGeMatrix3d & | xfm, |
| OdDbEntityPtr & | pCopy | ||
| ) | const |
Creates a copy of this entity, and applies the supplied transformation to the newly created copy.
- Parameters
-
xfm [in] 3D transformation matrix. pCopy [out] Receives a SmartPointer to the newly created copy.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ gripStatus()
| ODRX_SEALED_VIRTUAL void OdDbEntity::gripStatus | ( | const OdDb::GripStat | status | ) |
Notification function called when this entity is involved in a grip operation.
- Parameters
-
status [in] Status of the grip operation.
◆ hideMeForDragging()
| ODRX_SEALED_VIRTUAL bool OdDbEntity::hideMeForDragging | ( | ) | const |
Returns the hideMeForDragging flag for this entity.
◆ highlight()
| ODRX_SEALED_VIRTUAL void OdDbEntity::highlight | ( | bool | bDoIt = true, |
| const OdDbFullSubentPath * | pSubId = 0, |
||
| bool | highlightAll = false |
||
| ) | const |
◆ intersectWith() [1/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::intersectWith | ( | const OdDbEntity * | pEnt, |
| OdDb::Intersect | intType, | ||
| const OdGePlane & | projPlane, | ||
| OdGePoint3dArray & | points, | ||
| OdGsMarker | thisGsMarker = 0, |
||
| OdGsMarker | otherGsMarker = 0 |
||
| ) | const |
Intersects this entity with other entity if possible.
- Parameters
-
pEnt [in] Pointer to other entity intType [in] Determines type of intersection to be calculated
◆ intersectWith() [2/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::intersectWith | ( | const OdDbEntity * | pEnt, |
| OdDb::Intersect | intType, | ||
| OdGePoint3dArray & | points, | ||
| OdGsMarker | thisGsMarker = 0, |
||
| OdGsMarker | otherGsMarker = 0 |
||
| ) | const |
Intersects this entity with other entity if possible.
- Parameters
-
pEnt [in] Pointer to other entity intType [in] Determines type of intersection to be calculated
◆ isContentSnappable()
| ODRX_SEALED_VIRTUAL bool OdDbEntity::isContentSnappable | ( | ) | const |
◆ isPlanar()
|
virtual |
Returns true if and only if this entity is planar.
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDbArc, OdDbBlockReference, OdDbCircle, OdDbDimension, OdDbEllipse, OdDbHatch, OdDbLeader, OdDbLine, OdDbMText, OdDbNurbSurface, OdDbPoint, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRay, OdDbRegion, OdDbShape, OdDbSpline, OdDbText, OdDbTrace, OdDbXline, OdDbMLeader, and OdDbPolyline.
◆ layer()
| OdString OdDbEntity::layer | ( | ) | const |
Returns the name of the layer referenced by this entity (DXF 8).
◆ layerId()
| OdDbObjectId OdDbEntity::layerId | ( | ) | const |
Returns the Object ID of the OdDbLayerTableRecord referenced by this entity.
◆ linetype()
| OdString OdDbEntity::linetype | ( | ) | const |
Returns the name of the linetype referenced by this entity (DXF 6).
◆ linetypeId()
| OdDbObjectId OdDbEntity::linetypeId | ( | ) | const |
Returns the Object ID of the linetype referenced by this entity (DXF 6).
◆ linetypeScale()
| double OdDbEntity::linetypeScale | ( | ) | const |
Returns the linetype scale of this entity (DXF 48).
◆ lineWeight()
| OdDb::LineWeight OdDbEntity::lineWeight | ( | ) | const |
Returns the lineweight property of this entity (DXF 370).
◆ list()
| ODRX_SEALED_VIRTUAL void OdDbEntity::list | ( | ) | const |
This method is triggered by the standard LIST command and is to be display the dxf format contents of the entity to the display.
◆ material()
| OdString OdDbEntity::material | ( | ) | const |
Returns the name of the material referenced by this entity (DXF 347).
◆ materialId()
| OdDbObjectId OdDbEntity::materialId | ( | ) | const |
Returns the Object ID of the material referenced by this entity (DXF 347).
◆ materialMapper()
|
virtual |
Returns OdGiMapper used to map a material to the entity. Returns null if the default mapper is used.
◆ moveGripPointsAt() [1/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::moveGripPointsAt | ( | const OdDbVoidPtrArray & | grips, |
| const OdGeVector3d & | offset, | ||
| int | bitFlags | ||
| ) |
Moves the specified grip points of this entity.
- Parameters
-
gripAppData [in] Array of appData pointers from the OdDbGripData objects (one for each grip point to be moved). offset [in] The direction and magnitude of the grip points offset (WCS).
◆ moveGripPointsAt() [2/2]
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::moveGripPointsAt | ( | const OdIntArray & | indices, |
| const OdGeVector3d & | offset | ||
| ) |
Moves the specified grip points of this entity.
- Parameters
-
indices [in] Array of indicies. offset [in] The direction and magnitude of the grip points offset (WCS).
- Remarks
- Each element in gripPoints has a corresponding entry in indices, which specifies the index of the grip point as returned by getGripPoints.
◆ moveGripPointsAtSubentPaths()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::moveGripPointsAtSubentPaths | ( | const OdDbFullSubentPathArray & | paths, |
| const OdDbVoidPtrArray & | gripAppData, | ||
| const OdGeVector3d & | offset, | ||
| const OdUInt32 | bitflags | ||
| ) |
Applies a vector offset to one or more grip points exposed by subentities on the object.
- Parameters
-
paths [in] The array of OdDbFullSubentPath objects. gripAppData [in] The array of pointers of OdDbGripData objects. offset [in] The vector (in WCS coordinates) indicating the direction and magnitude of the translation. bitflags [in] The bitmap of one or more flags specified by the GetGripPointsFlags enumeration.
◆ moveStretchPointsAt()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::moveStretchPointsAt | ( | const OdIntArray & | indices, |
| const OdGeVector3d & | offset | ||
| ) |
Moves the specified stretch points of this entity.
- Parameters
-
stretchPoints [in] Array of moved grip points. indices [in] Array of indicies. offset [in] The direction and magnitude of the stretch points offset (WCS).
- Remarks
- Each element in stretchPoints has a corresponding entry in indices, which specifies the index of the stretch point as returned by getStretchPoints.
◆ ODDB_DECLARE_MEMBERS()
| OdDbEntity::ODDB_DECLARE_MEMBERS | ( | OdDbEntity | ) |
◆ plotStyleName()
| OdString OdDbEntity::plotStyleName | ( | ) | const |
Returns the name of the plotStyleName string associated with this entity (DXF 390).
◆ receiveShadows()
|
virtual |
Returns the ReceiveShadows flag for this entity..
◆ recordGraphicsModified()
Sets the bit flag indicating the entity's geometry is changed.
- Parameters
-
graphicsModified [in] New value.
- Remarks
- If true, assures that modifiedGraphics() will be called as the entity is being closed, even if the object was not opened for write.
◆ saveAs()
|
virtual |
Creates a geometric representation of this entity for saving proxy graphics or converting to previous formats.
- Parameters
-
pWd [in] Pointer to the OdGiWorldDraw object. ver [in] Specifies the reason why the method is called.
- Remarks
- The default implementation of this function calls worldDraw(). This function can be overridden in custom classes.
Reimplemented in OdDb3dSolid, OdDbBody, OdDbMPolygon, OdDbRegion, and OdDbSurface.
◆ setCastShadows()
|
virtual |
Controls the CastShadows flag for this entity.
- Parameters
-
castShadows [in] CastShadows flag.
◆ setColor()
Sets the color information of this entity from an OdCmColor instance.
- Parameters
-
color [in] OdCmColor object. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setColorId()
|
virtual |
Assigns the specified OdDbColor object to this entity.
- Parameters
-
colorId [in] Object ID of the OdDbColor object. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setColorIndex()
Sets the color index of this entity (DXF 62).
- Parameters
-
colorIndex [in] Color index. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
colorIndex will be in the range [0 .. 256]. 0 indicates a color of BYBLOCK. 256 indicates a color of BYLAYER.
Reimplemented in OdDbProxyEntity.
◆ setDatabaseDefaults()
| void OdDbEntity::setDatabaseDefaults | ( | OdDbDatabase * | pDb = 0, |
| bool | doSubents = false |
||
| ) |
Applies the default properties of the specified database to this entity.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
The following properties are set color layer linetype linetype scale lineweight plotstyle visibility
◆ setLayer() [1/2]
|
virtual |
Sets the layer to be referenced by this entity (DXF 8).
- Parameters
-
layerName [in] Name of the layer. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setLayer() [2/2]
|
virtual |
Sets the layer to be referenced by this entity (DXF 8).
- Parameters
-
layerId [in] Object ID of the LayerTableRecord. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setLinetype() [1/2]
|
virtual |
Sets the linetype to be referenced by this entity (DXF 6).
- Parameters
-
linetypeName [in] Name of the linetype. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setLinetype() [2/2]
|
virtual |
Sets the linetype to be referenced by this entity (DXF 6).
- Parameters
-
linetypeID [in] Object ID of the linetype. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setLinetypeScale()
|
virtual |
Sets the Linetype scale of this entity (DXF 48).
- Parameters
-
linetypeScale [in] Linetype scale factor. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setLineWeight()
|
virtual |
Sets the lineweight property of this entity (DXF 370).
- Parameters
-
lineWeight [in] Lineweight. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setMaterial() [1/2]
|
virtual |
Sets the material to be referenced by this entity (DXF 347).
- Parameters
-
materialName [in] Name of the material. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setMaterial() [2/2]
|
virtual |
Sets the material to be referenced by this entity (DXF 347).
- Parameters
-
materialID [in] Object ID of the material. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setMaterialMapper()
|
virtual |
Sets the mapper used to map a material to the entity.
- Parameters
-
mapper [in] The mapper of a material. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Remarks
- Use null to apply the default mapper.
◆ setPlotStyleName() [1/2]
|
virtual |
Sets the plot style of this entity.
- Parameters
-
plotStyleName [in] Name of the plot style. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
Reimplemented in OdDbProxyEntity.
◆ setPlotStyleName() [2/2]
|
virtual |
Sets the plot style of this entity.
- Parameters
-
plotStyleNameType [in] Plot Style Name Type. plotStyleNameId [in] Object ID of the plot style name. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
plotStyleNameId is used only when plotStyleNameType == kPlotStyleNameById.
plotStyleNameType must be one of the following:
Value OdDb::kPlotStyleNameByLayer 0 OdDb::kPlotStyleNameByBlock 1 OdDb::kPlotStyleNameIsDictDefault 2 OdDb::kPlotStyleNameById 3
Reimplemented in OdDbProxyEntity.
◆ setPropertiesFrom()
| void OdDbEntity::setPropertiesFrom | ( | const OdDbEntity * | pSource, |
| bool | doSubents = true |
||
| ) |
Copies the properties from the specified entity to this entity.
- Parameters
-
pSource [in] Pointer to the source entity. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
◆ setReceiveShadows()
|
virtual |
Controls the Receivehadows flag for this entity.
- Parameters
-
receiveShadows [in] ReceiveShadows flag.
◆ setTempVisibility()
| void OdDbEntity::setTempVisibility | ( | OdDb::Visibility | visibility | ) |
Sets the temporary (not saved to file) visibility status of this entity.
- Parameters
-
visibility [in] Visibility status, must be one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
◆ setTransparency()
|
virtual |
Sets the transparency setting of this entity, and returns eOk if successful.
- Parameters
-
transparency [in] OdCmTransparency object be assigned. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
If you override this function, you must call OdDbEntity::setTransparency(), passing to it the calling arguments.
◆ setVisibility()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::setVisibility | ( | OdDb::Visibility | visibility, |
| bool | doSubents = true |
||
| ) |
Sets the visibility status of this entity (DXF 60).
- Parameters
-
visibility [in] Visibility status. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
visibility must be one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
◆ setVisualStyle()
|
virtual |
Sets the visual style to be used by this entity.
- Parameters
-
visualStyleId [in] Object ID of the visual style. vstype [in] Type of the visual style. doSubents [in] If and only if true, applies the change to all sub-entities owned by this entity.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ subAddSubentPaths()
|
protectedvirtual |
◆ subCloneMeForDragging()
|
protectedvirtual |
Reimplemented in AECDbDimensionGroup, AECDbEntity, and AECDbRailing.
◆ subDeepClone()
|
protectedvirtual |
Reimplemented from OdDbObject.
Reimplemented in OdDbCamera, OdDbProxyEntity, OdDbRasterImage, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionView, and OdDbMLeader.
◆ subDeleteSubentPaths()
|
protectedvirtual |
Reimplemented in OdDbMLeader.
◆ subentGripStatus()
| ODRX_SEALED_VIRTUAL void OdDbEntity::subentGripStatus | ( | OdDb::GripStat | status, |
| const OdDbFullSubentPath & | subentity | ||
| ) |
◆ subentPtr()
| ODRX_SEALED_VIRTUAL OdDbEntityPtr OdDbEntity::subentPtr | ( | const OdDbFullSubentPath & | path | ) | const |
Create an object by OdDbFullSubentPath to the subentity.
- Parameters
-
path [in] The OdDbFullSubentPath to the subentity.
◆ 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 OdDbObject.
Reimplemented in OdDbCamera, OdDbFaceRecord, OdDbLight, OdDbPolyFaceMeshVertex, OdDbPolygonMeshVertex, OdDbProxyEntity, OdDbSequenceEnd, OdDbTable, OdDbViewport, CFxBIMEntityReference, CFxBIMSection, and CFxBIMSectionView.
◆ subExplode()
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDb3dPolyline, OdDb3dSolid, OdDbBody, OdDbHelix, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbPlaneSurface, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbPolyline, OdDbRegion, OdDbSubDMesh, OdDbSurface, OdDb2dPolyline, OdDbArcAlignedText, OdDbBlockReference, OdDbDimension, OdDbHatch, OdDbLeader, OdDbMLeader, OdDbProxyEntity, OdDbRasterImage, OdDbSpline, OdDbTable, CFxBIMEntityReference, and CFxBIMSectionEntity.
◆ subGetClassID()
Reimplemented from OdDbObject.
Reimplemented in OdDb2LineAngularDimension, OdDb3dPolyline, OdDb3dSolid, OdDb3PointAngularDimension, OdDbAlignedDimension, OdDbArc, OdDbArcDimension, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbCamera, OdDbCircle, OdDbDiametricDimension, OdDbDimension, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbHatch, OdDbHelix, OdDbLeader, OdDbLight, OdDbLine, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMText, OdDbOle2Frame, OdDbOrdinateDimension, OdDbPlaneSurface, OdDbPoint, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRadialDimension, OdDbRadialDimensionLarge, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbRotatedDimension, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbText, OdDbTrace, OdDbDwfReference, OdDbDgnReference, OdDbPdfReference, OdDbViewport, OdDbXline, OdDb2dPolyline, OdDbFcf, OdDbMLeader, OdDbPolyline, OdDbRasterImage, and OdDbWipeout.
◆ subGetCompoundObjectTransform()
|
protectedvirtual |
Reimplemented in OdDbBlockReference, OdDbDimension, and CFxBIMEntityReference.
◆ subGetGeomExtents()
|
protectedvirtual |
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDb3dSolid, OdDbArc, OdDbBlockBegin, OdDbBlockEnd, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDimension, OdDbEllipse, OdDbFaceRecord, OdDbGeoPositionMarker, OdDbLine, OdDbMInsertBlock, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbRay, OdDbRegion, OdDbSequenceEnd, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbTable, OdDbVertex, OdDbViewport, OdDbXline, OdDbFcf, OdDbMLeader, OdDbPolyline, OdDbRasterImage, OdDbViewRepBlockReference, CFxBIMEntityReference, CFxBIMSection, and CFxBIMSectionEntity.
◆ subGetGripPoints() [1/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subGetGripPoints() [2/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDbDetailSymbol, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subGetGripPointsAtSubentPath()
|
protectedvirtual |
◆ subGetGsMarkersAtSubentPath()
|
protectedvirtual |
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDb3dSolid, OdDbBody, OdDbFace, OdDbHatch, OdDbLeader, OdDbMline, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbPolyline, OdDbRegion, OdDbSolid, OdDbSubDMesh, OdDbSurface, OdDbTrace, OdDbBlockReference, OdDbMLeader, and OdDbViewRepBlockReference.
◆ subGetOsnapPoints() [1/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDbUnderlayReference, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subGetOsnapPoints() [2/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subGetStretchPoints()
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subGetSubentClassId()
|
protectedvirtual |
◆ subGetSubentPathGeomExtents()
|
protectedvirtual |
◆ subGetSubentPathsAtGsMarker()
|
protectedvirtual |
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDbFace, OdDbLeader, OdDbMline, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbSolid, OdDbTrace, OdDbBody, OdDbPolyline, OdDbBlockReference, OdDb3dSolid, OdDbRegion, OdDbSurface, OdDbHatch, OdDbMLeader, and OdDbSubDMesh.
◆ subGetTransformedCopy()
|
protectedvirtual |
Reimplemented in OdDb2dVertex, OdDbMline, OdDbMText, OdDbOle2Frame, OdDbSection, OdDbSequenceEnd, OdDbSurface, OdDbViewport, RText, OdDbPolyline, OdDbWipeout, OdDbArc, OdDbCircle, OdDbTable, OdDbBlockReference, OdDbDimension, OdDbHatch, OdDbText, CFxBIMEntityReference, CFxBIMSectionEntity, OdDbMLeader, and OdDbLeader.
◆ subGripStatus()
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subHandOverTo()
|
virtual |
Returns the WCS geometric extents of this entity.
- Parameters
-
extents [out] Receives the extents.
- Returns
- Returns eOk if successful, or eInvalidExtents if not.
The extents are the WCS corner points of a box, aligned with the WCS axes, that encloses the 3D extents of this entity.
Reimplemented from OdDbObject.
Reimplemented in OdDbSurface.
◆ subHideMeForDragging()
|
protectedvirtual |
Reimplemented in AECDbEntity.
◆ subHighlight()
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDbCamera, OdDbLight, OdDbTable, and OdDbViewBorder.
◆ subIntersectWith() [1/2]
|
protectedvirtual |
Reimplemented in OdDbRegion.
◆ subIntersectWith() [2/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, and OdDbRegion.
◆ subIsContentSnappable()
|
protectedvirtual |
Reimplemented in OdDbDwfReference, OdDbDgnReference, OdDbPdfReference, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subList()
|
virtual |
◆ subMoveGripPointsAt() [1/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subMoveGripPointsAt() [2/2]
|
protectedvirtual |
Reimplemented in AECDbEntity, OdDbMLeader, OdDbDetailSymbol, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subMoveGripPointsAtSubentPaths()
|
protectedvirtual |
◆ subMoveStretchPointsAt()
|
protectedvirtual |
Reimplemented in AECDbEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subOpen()
|
virtual |
Notification function called by the Teigha framework immediately before an object is opened.
- Parameters
-
mode [in] Mode in which the object is being opened.
- Remarks
- This function is notified just before an object is to be opened; giving this function the ability to cancel the object being opened.
Returns eOk if and only if open() is to continue.
Overriding this function in a child class allows a child instance to be notified each time an object is opened.
When overriding this function:
1) If the OdDbObject's state is incorrect, return something other than eOk.
2) If the parent class's subOpen() returns anything other than eOk, immediately return it.
3) If other actions are required before open, do them.
4) Return eOk.
The default implementation of this function does nothing but return eOk. 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.
Reimplemented in AECDbEntity, OdDb3dSolid, OdDbAttributeDefinition, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbDimension, OdDbGeoPositionMarker, OdDbLight, OdDbMText, OdDbPoint, OdDbRasterImage, OdDbRegion, OdDbSubDMesh, OdDbSurface, OdDbViewport, OdDbWipeout, OdDbLeader, OdDbMLeader, OdDbUnderlayReference, OdDbPdfReference, OdDbNavisworksReference, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionEntity, and CFxBIMSectionView.
◆ subSetDatabaseDefaults()
|
virtual |
Called by setDatabaseDefaults() after the values are set.
- Parameters
-
pDb [in] Pointer to the database whose default values are to be used. doSubents [in] Set to true if subentities should be processed
- Remarks
- If pDb is null, the database containing this entity is used.
This function allows custom classes to inspect and modify the values set by setDatabaseDefaults.
The default implementation of this function returns eNotApplicable. This function can be overridden in custom classes.
- Remarks
- This function is not intended to be called by the user.
Reimplemented in AECDbSpace, OdDbDimension, OdDbGeoPositionMarker, OdDbHatch, OdDbLeader, OdDbMline, OdDbMPolygon, OdDbMText, OdDbTable, OdDbViewport, OdDbFcf, OdDbMLeader, OdDbText, and OdDbOle2Frame.
◆ subSetVisibility()
|
protectedvirtual |
Reimplemented in OdDbProxyEntity.
◆ subSubentGripStatus()
|
protectedvirtual |
◆ subSubentPtr()
|
protectedvirtual |
Reimplemented in OdDbArc, OdDb3dSolid, OdDbBody, OdDbRegion, OdDbSurface, OdDb2dPolyline, OdDb3dPolyline, OdDbHatch, OdDbPolyline, OdDbVertex, OdDbMLeader, and OdDbMPolygon.
◆ subSwapIdWith()
|
virtual |
This function is called as the first operation of the swapIdWith() function.
- Parameters
-
otherId [in] Object ID of object with which to swap. swapXdata [in] XData will be swaped if and only if swapXData is true. swapExtDict [in] Extension dictionaries will be swapped if and only if swapExtDict is true.
- Remarks
- This function allows derived classes to implement custom behavior during the swapIdWith operation.
The default implementation of this function does nothing. This function can be overridden in custom classes.
- See also
- <link OdDbObject::swapIdWith@OdDbObjectId@bool@bool, OdDbObject::swapIdWith() method>
Reimplemented from OdDbObject.
◆ subTransformBy()
|
protectedvirtual |
Reimplemented in AECDbGeo, OdDb3dPolyline, OdDb3dSolid, OdDbArc, OdDbCamera, OdDbCircle, OdDbEllipse, OdDbExtrudedSurface, OdDbFace, OdDbHelix, OdDbLight, OdDbLoftedSurface, OdDbMInsertBlock, OdDbMline, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRay, OdDbRegion, OdDbRevolvedSurface, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbSweptSurface, OdDbTable, OdDbTrace, OdDbUnderlayReference, OdDbNavisworksReference, OdDbXline, RText, OdDb2dPolyline, OdDb2dVertex, OdDbArcAlignedText, OdDbBlockReference, OdDbDimension, OdDbFcf, OdDbHatch, OdDbLeader, OdDbLine, OdDbOle2Frame, OdDbPolyline, OdDbProxyEntity, OdDbRasterImage, OdDbText, OdDbViewport, OdDbDetailSymbol, CFxBIMEntityReference, CFxBIMSectionEntity, OdDbBody, OdDbMPolygon, OdDbGeoPositionMarker, OdDbPointCloudEx, OdDbSection, OdDbVertex, OdDbViewBorder, and OdDbMLeader.
◆ subTransformSubentPathsBy()
|
protectedvirtual |
◆ subViewportDraw()
|
virtual |
Reimplemented from OdDbObject.
Reimplemented in OdDbMLeader, OdDb3dSolid, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbDimension, OdDbFace, OdDbLight, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbSection, OdDbSolid, OdDbSurface, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbViewRepImage, OdDbFcf, OdDbLeader, OdDbOle2Frame, OdDbPolyline, OdDbRasterImage, OdDbViewRepBlockReference, AECDbEntity, OdDbGeoPositionMarker, OdDbHatch, CFxBIMEntityReference, CFxBIMRoomSectionEntity, CFxBIMSection, and CFxBIMSectionEntity.
◆ subVisibility()
|
protectedvirtual |
◆ subWblockClone()
|
protectedvirtual |
Reimplemented from OdDbObject.
Reimplemented in AECDbEntity, OdDbTable, OdDbFcf, OdDbCamera, OdDbDimension, OdDbProxyEntity, CFxBIMEntityReference, CFxBIMSection, CFxBIMSectionView, and OdDbMLeader.
◆ subWorldDraw()
|
virtual |
Reimplemented from OdDbObject.
Reimplemented in OdDb2dPolyline, OdDb3dPolyline, OdDb3dSolid, OdDbArc, OdDbAttribute, OdDbAttributeDefinition, OdDbBlockReference, OdDbBody, OdDbCamera, OdDbCircle, OdDbDimension, OdDbEllipse, OdDbFace, OdDbHatch, OdDbLight, OdDbLine, OdDbMInsertBlock, OdDbMline, OdDbMPolygon, OdDbMText, OdDbPoint, OdDbPointCloud, OdDbPointCloudEx, OdDbPolyFaceMesh, OdDbPolygonMesh, OdDbRay, OdDbRegion, OdDbSection, OdDbShape, OdDbSolid, OdDbSpline, OdDbSubDMesh, OdDbSurface, OdDbTable, OdDbText, OdDbTrace, OdDbUnderlayReference, OdDbNavisworksReference, OdDbViewport, OdDbXline, OdDbViewBorder, OdDbViewRepImage, RText, OdDbArcAlignedText, OdDbFcf, OdDbLeader, OdDbMLeader, OdDbOle2Frame, OdDbPolyline, OdDbRasterImage, OdDbWipeout, OdDbViewRepBlockReference, CFxBIMRoomSectionEntity, AECDbEntity, OdDbGeoPositionMarker, OdDbDetailSymbol, OdDbSectionSymbol, OdDbViewSymbol, CFxBIMEntityReference, CFxBIMSection, and CFxBIMSectionEntity.
◆ tempVisibility()
| OdDb::Visibility OdDbEntity::tempVisibility | ( | ) | const |
Returns the temporary (not saved) visibility status of this entity.
- Remarks
- tempVisibility() returns one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
◆ transformBy()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::transformBy | ( | const OdGeMatrix3d & | xfm | ) |
Applies the specified 3D transformation matrix to this entity.
- Parameters
-
xfm [in] 3D transformation matrix.
- Returns
- Returns eOk if successful, or an appropriate error code if not.
◆ transformSubentPathsBy()
| ODRX_SEALED_VIRTUAL OdResult OdDbEntity::transformSubentPathsBy | ( | const OdDbFullSubentPathArray & | paths, |
| const OdGeMatrix3d & | xform | ||
| ) |
Applies a geometric transformation to one or more subentities on an object.
- Parameters
-
paths [in] The array of OdDbFullSubentPath objects. xform [in] The WCS transformation to apply to each of the supplied subentities.
◆ transparency()
| OdCmTransparency OdDbEntity::transparency | ( | ) | const |
Returns the transparency setting of this entity.
◆ visibility()
| OdDb::Visibility OdDbEntity::visibility | ( | ) | const |
Returns the visibility status of this entity. It takes into account both permanent (DXF 60) and temporary visibility statuses: the entity is visible only if it's visible in both parts.
- Remarks
- visibility() returns one of the following:
Value OdDb::kInvisible 1 OdDb::kVisible 0
◆ visualStyleId()
| OdDbObjectId OdDbEntity::visualStyleId | ( | VisualStyleType | vstype = kFullVisualStyle | ) | const |
Returns the Object ID of the visual style used by this entity.
Friends And Related Function Documentation
◆ OdDbGeometryOverrule
|
friend |
Definition at line 1297 of file DbEntity.h.
◆ OdDbGripOverrule
|
friend |
Definition at line 1293 of file DbEntity.h.
◆ OdDbHighlightOverrule
|
friend |
Definition at line 1295 of file DbEntity.h.
◆ OdDbOsnapOverrule
|
friend |
Definition at line 1291 of file DbEntity.h.
◆ OdDbPropertiesOverrule
|
friend |
Definition at line 1290 of file DbEntity.h.
◆ OdDbSubentityOverrule
|
friend |
Definition at line 1294 of file DbEntity.h.
◆ OdDbTransformOverrule
|
friend |
Definition at line 1292 of file DbEntity.h.
◆ OdDbVisibilityOverrule
|
friend |
Definition at line 1296 of file DbEntity.h.
The documentation for this class was generated from the following file: