CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdDbDetailSymbol Class Reference

#include <DbDetailSymbol.h>

Inheritance diagram for OdDbDetailSymbol:
OdDbViewSymbol OdDbEntity OdDbObject OdGiDrawable OdRxObject

Public Types

enum  BoundaryType { kCircularBoundary , kRectangularBoundary , kCustomBoundary }
 
enum  OverriddenProperty { kNone = 0 , kModelEdge = 0x1 , kIdentifierPosition = 0x1 << 1 }
 
- Public Types inherited from OdDbEntity
enum  VisualStyleType { kFullVisualStyle , kFaceVisualStyle , kEdgeVisualStyle }
 
- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground , kEnvironmentBackground = 16 , kCustomBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbDetailSymbol)
 
 OdDbDetailSymbol ()
 
 ~OdDbDetailSymbol ()
 
BoundaryType boundaryType () const
 
OdDbDetailViewStyle::ModelEdge modelEdgeType () const
 
bool isOverriddenProperty (OdDbDetailSymbol::OverriddenProperty property) const
 
bool displayIdentifier () const
 
OdGePoint3d origin () const
 
const OdGeVector3d direction () const
 
const OdGeVector2dboundarySize () const
 
const OdGePoint3dmodelEdgeOrigin () const
 
double owningViewScale () const
 
double detailViewScale () const
 
const OdGeVector3dmodelEdgeDirection () const
 
OdResult modelEdgeBorderExtents (OdGeExtents3d &extents) const
 
OdGePoint3d identifierPosition () const
 
OdResult initializeIdentifierPositionAt (const OdGePoint3d &pt)
 
OdResult resetIdentifierPosition ()
 
OdResult setIdentifierPosition (const OdGePoint3d &pt)
 
OdResult setDetailViewScale (double viewScale)
 
OdResult setOwningViewScale (double viewScale)
 
OdResult setBoundaryType (OdDbDetailSymbol::BoundaryType bndType)
 
OdResult setModelEdgeType (OdDbDetailViewStyle::ModelEdge modelEdgeType)
 
OdResult setModelEdgeOrigin (const OdGePoint3d &pt)
 
OdResult setModelEdgeDirection (const OdGeVector3d &dir)
 
OdResult setDisplayIdentifier (const bool displayIdentifier)
 
OdResult setOrigin (const OdGePoint3d &pt)
 
OdResult setBoundarySize (const OdGeVector2d &size)
 
OdResult setPickPoints (const OdGePoint3dArray &pickPoints)
 
- Public Member Functions inherited from OdDbViewSymbol
 ODDB_DECLARE_MEMBERS (OdDbViewSymbol)
 
virtual ~OdDbViewSymbol ()
 
OdDbObjectId symbolStyleId () const
 
void setSymbolStyleId (const OdDbObjectId &styleId)
 
double scale () const
 
void setScale (double val)
 
OdResult getIdentifier (OdString &sName) const
 
OdResult setIdentifier (const OdString &sName)
 
OdDbObjectId owningViewRep () const
 
void setOwningViewRep (const OdDbObjectId &owner)
 
OdResult createDefinition (OdRxSymbolSketch *pSketchObject)
 
OdResult exportSymbolGeometry (OdGeCurve3dPtrArray &geomArr, const OdDbObjectId &viewRepId)
 
OdResult setSymbolGeometry (const OdDbObjectIdArray &entIds)
 
OdResult setSymbolGeometry (const OdArray< OdDbObject * > &entities)
 
OdResult updateDefinition ()
 
- Public Member Functions inherited from OdDbEntity
 ODDB_DECLARE_MEMBERS (OdDbEntity)
 
 OdDbEntity ()
 
OdDbObjectId blockId () const
 
OdCmColor color () const
 
virtual OdResult setColor (const OdCmColor &color, bool doSubents=true)
 
OdUInt16 colorIndex () const
 
virtual OdCmEntityColor entityColor () const
 
virtual OdResult setColorIndex (OdUInt16 colorIndex, bool doSubents=true)
 
OdDbObjectId colorId () const
 
virtual OdResult setColorId (OdDbObjectId colorId, bool doSubents=true)
 
OdCmTransparency transparency () const
 
virtual OdResult setTransparency (const OdCmTransparency &transparency, bool doSubents=true)
 
OdString plotStyleName () const
 
OdDb::PlotStyleNameType getPlotStyleNameId (OdDbObjectId &plotStyleNameId) const
 
virtual OdResult setPlotStyleName (const OdString &plotStyleName, bool doSubents=true)
 
virtual OdResult setPlotStyleName (OdDb::PlotStyleNameType plotStyleNameType, OdDbObjectId plotStyleNameId=OdDbObjectId::kNull, bool doSubents=true)
 
OdString layer () const
 
OdDbObjectId layerId () const
 
virtual OdResult setLayer (const OdString &layerName, bool doSubents=true, bool allowHiddenLayer=false)
 
virtual OdResult setLayer (OdDbObjectId layerId, bool doSubents=true, bool allowHiddenLayer=false)
 
OdString linetype () const
 
OdDbObjectId linetypeId () const
 
virtual OdResult setLinetype (const OdString &linetypeName, bool doSubents=true)
 
virtual OdResult setLinetype (OdDbObjectId linetypeID, bool doSubents=true)
 
OdString material () const
 
OdDbObjectId materialId () const
 
virtual OdResult setMaterial (const OdString &materialName, bool doSubents=true)
 
virtual OdResult setMaterial (OdDbObjectId materialID, bool doSubents=true)
 
OdDbObjectId visualStyleId (VisualStyleType vstype=kFullVisualStyle) const
 
virtual OdResult setVisualStyle (OdDbObjectId visualStyleId, VisualStyleType vstype=kFullVisualStyle, bool doSubents=true)
 
virtual const OdGiMappermaterialMapper () const
 
virtual void setMaterialMapper (const OdGiMapper *mapper, bool doSubents=true)
 
double linetypeScale () const
 
virtual OdResult setLinetypeScale (double linetypeScale, bool doSubents=true)
 
OdDb::Visibility visibility () const
 
ODRX_SEALED_VIRTUAL OdResult setVisibility (OdDb::Visibility visibility, bool doSubents=true) ODRX_FINAL
 
OdDb::Visibility tempVisibility () const
 
void setTempVisibility (OdDb::Visibility visibility)
 
OdDb::LineWeight lineWeight () const
 
virtual OdResult setLineWeight (OdDb::LineWeight lineWeight, bool doSubents=true)
 
virtual bool castShadows () const
 
virtual void setCastShadows (bool castShadows)
 
virtual bool receiveShadows () const
 
virtual void setReceiveShadows (bool receiveShadows)
 
virtual OdDb::CollisionType collisionType () const
 
void setPropertiesFrom (const OdDbEntity *pSource, bool doSubents=true)
 
virtual bool isPlanar () const
 
virtual OdResult getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const
 
void subHandOverTo (OdDbObject *pNewObject)
 
ODRX_SEALED_VIRTUAL OdResult transformBy (const OdGeMatrix3d &xfm) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult explode (OdRxObjectPtrArray &entitySet) const ODRX_FINAL
 
virtual OdResult explodeToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
virtual OdResult explodeGeometry (OdRxObjectPtrArray &entitySet) const
 
virtual OdResult explodeGeometryToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
virtual void subViewportDraw (OdGiViewportDraw *pVd) const
 
void setDatabaseDefaults (OdDbDatabase *pDb=0, bool doSubents=false)
 
virtual void applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
 
void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)
 
virtual OdResult dxfIn (OdDbDxfFiler *pFiler)
 
virtual void dxfOut (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
virtual OdGiDrawabledrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
virtual void subList () const
 
virtual OdResult subGetClassID (void *pClsid) const
 
void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual OdResult subErase (bool erasing) ODRX_OVERRIDE
 
virtual OdResult subOpen (OdDb::OpenMode mode) ODRX_OVERRIDE
 
void recordGraphicsModified (bool graphicsModified=true)
 
virtual void copyFrom (const OdRxObject *pSource)
 
ODRX_SEALED_VIRTUAL void list () const ODRX_FINAL
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL void highlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL bool isContentSnappable () const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdGePoint3dArray &gripPoints) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getStretchPoints (OdGePoint3dArray &stretchPoints) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult moveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_FINAL
 
virtual void dragStatus (const OdDb::DragStat status)
 
ODRX_SEALED_VIRTUAL void gripStatus (const OdDb::GripStat status) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL bool cloneMeForDragging () ODRX_FINAL
 
ODRX_SEALED_VIRTUAL bool hideMeForDragging () const ODRX_FINAL
 
virtual void saveAs (OdGiWorldDraw *pWd, OdDb::DwgVersion ver) const
 
ODRX_SEALED_VIRTUAL OdResult getCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_FINAL
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
OdResult boundingBoxIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker, OdGsMarker otherGsMarker) const
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult deleteSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult addSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdDbEntityPtr subentPtr (const OdDbFullSubentPath &path) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult transformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getSubentClassId (const OdDbFullSubentPath &path, void *clsId) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) ODRX_FINAL
 
ODRX_SEALED_VIRTUAL void subentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity) ODRX_FINAL
 
virtual OdGeMatrix3d getEcs () const
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
virtual void addRef () override
 
virtual void release () ODRX_NOEXCEPT override
 
virtual long numRefs () const override
 
OdDbObjectId objectId () const
 
OdDbHandle getDbHandle () const
 
OdDbHandle handle () const
 
OdDbObjectId ownerId () const
 
virtual void setOwnerId (OdDbObjectId ownerId)
 
OdDbDatabasedatabase () const
 
void createExtensionDictionary ()
 
OdDbObjectId extensionDictionary () const
 
bool releaseExtensionDictionary ()
 
OdDbXrecordPtr createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
 
void upgradeOpen ()
 
void downgradeOpen ()
 
void cancel ()
 
virtual void subClose ()
 
OdResult erase (bool eraseIt=true)
 
void handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
 
void swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual void audit (OdDbAuditInfo *pAuditInfo)
 
void dwgIn (OdDbDwgFiler *pFiler)
 
void dwgOut (OdDbDwgFiler *pFiler) const
 
virtual OdDb::DuplicateRecordCloning mergeStyle () const
 
virtual OdResBufPtr xData (const OdString &regappName=OdString::kEmpty) const
 
virtual void setXData (const OdResBuf *pRb)
 
bool hasXData (const OdChar *regappName=nullptr) const
 
bool isEraseStatusToggled () const
 
bool isErased () const
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
bool isNotifyEnabled () const
 
bool isModified () const
 
bool isModifiedXData () const
 
bool isModifiedGraphics () const
 
bool isNewObject () const
 
bool isNotifying () const
 
bool isUndoing () const
 
bool isReallyClosing () const
 
bool isDBRO () const
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
void assertNotifyEnabled () const
 
void disableUndoRecording (bool disable)
 
bool isUndoRecordingDisabled () const
 
OdDbDwgFilerundoFiler ()
 
void addReactor (OdDbObjectReactor *pReactor) const
 
void removeReactor (OdDbObjectReactor *pReactor) const
 
virtual void addPersistentReactor (const OdDbObjectId &objId)
 
virtual void removePersistentReactor (const OdDbObjectId &objId)
 
bool hasPersistentReactor (const OdDbObjectId &objId) const
 
OdDbObjectIdArray getPersistentReactors () const
 
OdDbObjectReactorArray getTransientReactors () const
 
virtual void recvPropagateModify (const OdDbObject *pSubObj)
 
virtual void xmitPropagateModify () const
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_FINAL
 
void setOdDbObjectIdsInFlux ()
 
bool isOdDbObjectIdsInFlux () const
 
virtual void copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
 
virtual void erased (const OdDbObject *pObject, bool erasing=true)
 
virtual void goodbye (const OdDbObject *pObject)
 
virtual void openedForModify (const OdDbObject *pObject)
 
virtual void subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
 
virtual void modifyUndone (const OdDbObject *pObject)
 
virtual void modifiedXData (const OdDbObject *pObject)
 
virtual void unappended (const OdDbObject *pObject)
 
virtual void reappended (const OdDbObject *pObject)
 
bool isAProxy () const
 
virtual void objectClosed (const OdDbObjectId &objectId)
 
virtual void modifiedGraphics (const OdDbObject *pObject)
 
bool hasSaveVersionOverride () const
 
void setHasSaveVersionOverride (bool hasSaveVersionOverride)
 
virtual OdDb::DwgVersion getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
 
virtual OdDbObjectPtr decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
virtual OdDbObjectPtr decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
 
void convertForSave (OdDb::DwgVersion ver)
 
virtual void composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
ODRX_SEALED_VIRTUAL OdResult getClassID (void *pClsid) const ODRX_FINAL
 
void setGsNode (OdGsCache *pNode)
 
OdGsCachegsNode () const
 
void xDataTransformBy (const OdGeMatrix3d &xfm)
 
bool hasFields () const
 
OdDbObjectId getField (const OdString &fieldName) const
 
OdDbObjectPtr getField (const OdString &fieldName, OdDb::OpenMode mode) const
 
virtual OdDbObjectId setField (const OdString &fieldName, OdDbField *pField)
 
virtual OdResult removeField (OdDbObjectId fieldId)
 
virtual OdDbObjectId removeField (const OdString &fieldName)
 
OdDbObjectId getFieldDictionary () const
 
OdDbObjectPtr getFieldDictionary (OdDb::OpenMode mode) const
 
virtual OdRxClasssaveAsClass (OdRxClass *pClass) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_FINAL
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_FINAL
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Member Functions

virtual void modified (const OdDbObject *pObject) ODRX_OVERRIDE
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler) ODRX_OVERRIDE
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const ODRX_OVERRIDE
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler) ODRX_OVERRIDE
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const ODRX_OVERRIDE
 
virtual bool subWorldDraw (OdGiWorldDraw *pWorldDraw) const ODRX_OVERRIDE
 
virtual OdResult subTransformBy (const OdGeMatrix3d &xfm) ODRX_OVERRIDE
 
virtual void subSetDatabaseDefaults (OdDbDatabase *db, bool doSubents) ODRX_OVERRIDE
 
- Protected Member Functions inherited from OdDbViewSymbol
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &idMap, OdDbObject *owner, bool bPrimary) const
 
 OdDbViewSymbol ()
 
- Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
virtual OdResult subGetTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const
 
virtual OdResult subExplode (OdRxObjectPtrArray &entitySet) const
 
virtual OdResult subGetCompoundObjectTransform (OdGeMatrix3d &xM) const
 
virtual bool subCloneMeForDragging ()
 
virtual bool subHideMeForDragging () const
 
virtual void subGripStatus (const OdDb::GripStat status)
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const
 
virtual OdResult subGetOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints, const OdGeMatrix3d &insertionMat) const
 
virtual bool subIsContentSnappable () const
 
virtual OdResult subGetGripPoints (OdGePoint3dArray &gripPoints) const
 
virtual OdResult subMoveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subGetGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const
 
virtual OdResult subMoveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags)
 
virtual OdResult subGetStretchPoints (OdGePoint3dArray &stretchPoints) const
 
virtual OdResult subMoveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset)
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual OdResult subIntersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const
 
virtual void subHighlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const
 
virtual OdDb::Visibility subVisibility () const
 
virtual OdResult subSetVisibility (OdDb::Visibility visibility, bool doSubents=true)
 
virtual OdResult subGetGeomExtents (OdGeExtents3d &extents) const
 
virtual OdResult subDeleteSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subAddSubentPaths (const OdDbFullSubentPathArray &paths)
 
virtual OdResult subMoveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags)
 
virtual OdResult subGetGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const
 
virtual OdResult subGetSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &pickPoint, const OdGeMatrix3d &xfm, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack=0) const
 
virtual OdResult subGetGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const
 
virtual OdDbEntityPtr subSubentPtr (const OdDbFullSubentPath &path) const
 
virtual OdResult subTransformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform)
 
virtual OdResult subGetSubentClassId (const OdDbFullSubentPath &path, void *clsId) const
 
virtual OdResult subGetSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) const
 
virtual void subSubentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity)
 
- Protected Member Functions inherited from OdDbObject
 OdDbObject ()
 
- 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 OdRxClassdesc ()
 
static void rxInit ()
 
static void rxUninit ()
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class represents a Detail Symbol entity.

Corresponding C++ library: AcModelDocObj <group OdModelDocObj_Classes>

Definition at line 37 of file DbDetailSymbol.h.

Member Enumeration Documentation

◆ BoundaryType

Defines boundary types for Detail Symbol entities.

Enumerator
kCircularBoundary 
kRectangularBoundary 
kCustomBoundary 

Definition at line 51 of file DbDetailSymbol.h.

◆ OverriddenProperty

Defines which property of the style is overridden.

Enumerator
kNone 
kModelEdge 
kIdentifierPosition 

Definition at line 62 of file DbDetailSymbol.h.

Constructor & Destructor Documentation

◆ OdDbDetailSymbol()

OdDbDetailSymbol::OdDbDetailSymbol ( )

Default constructor. Creates an OdDbDetailSymbol instance.

◆ ~OdDbDetailSymbol()

OdDbDetailSymbol::~OdDbDetailSymbol ( )

Member Function Documentation

◆ boundarySize()

const OdGeVector2d & OdDbDetailSymbol::boundarySize ( ) const

Returns the boundary size of this Detail Symbol entity.

◆ boundaryType()

BoundaryType OdDbDetailSymbol::boundaryType ( ) const

Returns the boundary type for this OdDbDetailSymbol object as a value defined in the BoundaryType enumeration.

◆ detailViewScale()

double OdDbDetailSymbol::detailViewScale ( ) const

Returns the scale parameter of the associated detail view.

◆ direction()

const OdGeVector3d OdDbDetailSymbol::direction ( ) const

Returns the direction of this Detail Symbol entity.

◆ displayIdentifier()

bool OdDbDetailSymbol::displayIdentifier ( ) const

Returns whether the identifier of this Detail Symbol entity must be displayed.

◆ dwgInFields()

virtual OdResult OdDbDetailSymbol::dwgInFields ( OdDbDwgFiler * pFiler)
protectedvirtual

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 OdDbViewSymbol.

◆ dwgOutFields()

virtual void OdDbDetailSymbol::dwgOutFields ( OdDbDwgFiler * pFiler) const
protectedvirtual

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 OdDbViewSymbol.

◆ dxfInFields()

virtual OdResult OdDbDetailSymbol::dxfInFields ( OdDbDxfFiler * pFiler)
protectedvirtual

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 OdDbViewSymbol.

◆ dxfOutFields()

virtual void OdDbDetailSymbol::dxfOutFields ( OdDbDxfFiler * pFiler) const
protectedvirtual

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 OdDbViewSymbol.

◆ identifierPosition()

OdGePoint3d OdDbDetailSymbol::identifierPosition ( ) const

Gets the identifier position of this Detail Symbol entity.

Returns
The identifier position.

◆ initializeIdentifierPositionAt()

OdResult OdDbDetailSymbol::initializeIdentifierPositionAt ( const OdGePoint3d & pt)

◆ isOverriddenProperty()

bool OdDbDetailSymbol::isOverriddenProperty ( OdDbDetailSymbol::OverriddenProperty property) const

Returns true only if the specified property is overridden.

Parameters
property[in] The property value to check if it's overridden from the corresponding detail view style. All applicable values are defined in the OverriddenProperty enumeration.

◆ modelEdgeBorderExtents()

OdResult OdDbDetailSymbol::modelEdgeBorderExtents ( OdGeExtents3d & extents) const

Calculates model edge border extents.

Parameters
extents[out] Calculated extents.
Returns
eOk - if successful, corresponding error type - otherwise.

◆ modelEdgeDirection()

const OdGeVector3d & OdDbDetailSymbol::modelEdgeDirection ( ) const

Returns the model edge direction of this Detail Symbol entity.

◆ modelEdgeOrigin()

const OdGePoint3d & OdDbDetailSymbol::modelEdgeOrigin ( ) const

Returns the origin of the model edge of of this Detail Symbol entity.

◆ modelEdgeType()

OdDbDetailViewStyle::ModelEdge OdDbDetailSymbol::modelEdgeType ( ) const

Returns the type of the model edge as a value defined in the OdDbDetailViewStyle::ModelEdge enumeration.

◆ modified()

virtual void OdDbDetailSymbol::modified ( const OdDbObject * pObject)
protectedvirtual

Notification from detail view style. Invalidates Gs cache.

Reimplemented from OdDbObject.

◆ ODDB_DECLARE_MEMBERS()

OdDbDetailSymbol::ODDB_DECLARE_MEMBERS ( OdDbDetailSymbol )

◆ origin()

OdGePoint3d OdDbDetailSymbol::origin ( ) const

Returns the origin of this Detail Symbol entity.

◆ owningViewScale()

double OdDbDetailSymbol::owningViewScale ( ) const

Returns the scale parameter of the parent view.

◆ resetIdentifierPosition()

OdResult OdDbDetailSymbol::resetIdentifierPosition ( )

◆ setBoundarySize()

OdResult OdDbDetailSymbol::setBoundarySize ( const OdGeVector2d & size)

◆ setBoundaryType()

OdResult OdDbDetailSymbol::setBoundaryType ( OdDbDetailSymbol::BoundaryType bndType)

◆ setDetailViewScale()

OdResult OdDbDetailSymbol::setDetailViewScale ( double viewScale)

◆ setDisplayIdentifier()

OdResult OdDbDetailSymbol::setDisplayIdentifier ( const bool displayIdentifier)

◆ setIdentifierPosition()

OdResult OdDbDetailSymbol::setIdentifierPosition ( const OdGePoint3d & pt)

◆ setModelEdgeDirection()

OdResult OdDbDetailSymbol::setModelEdgeDirection ( const OdGeVector3d & dir)

◆ setModelEdgeOrigin()

OdResult OdDbDetailSymbol::setModelEdgeOrigin ( const OdGePoint3d & pt)

◆ setModelEdgeType()

OdResult OdDbDetailSymbol::setModelEdgeType ( OdDbDetailViewStyle::ModelEdge modelEdgeType)

◆ setOrigin()

OdResult OdDbDetailSymbol::setOrigin ( const OdGePoint3d & pt)

◆ setOwningViewScale()

OdResult OdDbDetailSymbol::setOwningViewScale ( double viewScale)

◆ setPickPoints()

OdResult OdDbDetailSymbol::setPickPoints ( const OdGePoint3dArray & pickPoints)

◆ subSetDatabaseDefaults()

virtual void OdDbDetailSymbol::subSetDatabaseDefaults ( OdDbDatabase * pDb,
bool doSubents )
protectedvirtual

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 from OdDbViewSymbol.

◆ subTransformBy()

virtual OdResult OdDbDetailSymbol::subTransformBy ( const OdGeMatrix3d & xfm)
protectedvirtual

Reimplemented from OdDbViewSymbol.

◆ subWorldDraw()

virtual bool OdDbDetailSymbol::subWorldDraw ( OdGiWorldDraw * pWorldDraw) const
protectedvirtual

Reimplemented from OdDbViewSymbol.


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