CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | List of all members
OdDbDimension Class Reference

#include <DbDimension.h>

Inheritance diagram for OdDbDimension:
OdDbEntity OdDbObject OdGiDrawable OdRxObject OdDb2LineAngularDimension OdDb3PointAngularDimension OdDbAlignedDimension OdDbArcDimension OdDbDiametricDimension OdDbOrdinateDimension OdDbRadialDimension OdDbRadialDimensionLarge OdDbRotatedDimension

Public Types

enum  DimInspect {
  kShapeRemove = 0x00, kShapeRound = 0x01, kShapeAngular = 0x02, kShapeNone = 0x04,
  kShapeLabel = 0x10, kShapeRate = 0x20
}
 
- 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,
  kLastFlag = kDrawableNotPlottable
}
 
enum  DrawableType {
  kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3,
  kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground,
  kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground,
  kImageBasedLightingBackground
}
 

Public Member Functions

 ODDB_DECLARE_MEMBERS (OdDbDimension)
 
 OdDbDimension ()
 
OdGePoint3d textPosition () const
 
void setTextPosition (const OdGePoint3d &textPosition)
 
bool isUsingDefaultTextPosition () const
 
void useSetTextPosition ()
 
void useDefaultTextPosition ()
 
OdGeVector3d normal () const
 
void setNormal (const OdGeVector3d &normal)
 
virtual bool isPlanar () const
 
virtual OdResult getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const
 
double elevation () const
 
void setElevation (double elevation)
 
const OdString dimensionText () const
 
void setDimensionText (const OdString &dimensionText)
 
double textRotation () const
 
void setTextRotation (double textRotation)
 
OdDbObjectId dimensionStyle () const
 
void setDimensionStyle (OdDbObjectId objectID)
 
OdDbMText::AttachmentPoint textAttachment () const
 
void setTextAttachment (OdDbMText::AttachmentPoint attachmentPoint)
 
OdDb::LineSpacingStyle textLineSpacingStyle () const
 
void setTextLineSpacingStyle (OdDb::LineSpacingStyle lineSpacingStyle)
 
double textLineSpacingFactor () const
 
void setTextLineSpacingFactor (double lineSpacingFactor)
 
void getDimstyleData (OdDbDimStyleTableRecord *pRecord) const
 
void setDimstyleData (const OdDbDimStyleTableRecord *pDimstyle)
 
void setDimstyleData (OdDbObjectId dimstyleID)
 
double horizontalRotation () const
 
void setHorizontalRotation (double horizontalRotation)
 
OdDbObjectId dimBlockId () const
 
void setDimBlockId (const OdDbObjectId &dimBlockId, bool singleReferenced=true)
 
bool isSingleDimBlockReference () const
 
OdGePoint3d dimBlockPosition () const
 
void setDimBlockPosition (const OdGePoint3d &dimBlockPosition)
 
double dimBlockRotation () const
 
void setDimBlockRotation (double dimBlockRotation)
 
OdGeScale3d dimBlockScale () const
 
void setDimBlockScale (const OdGeScale3d &dimBlockScale)
 
OdGeMatrix3d dimBlockTransform () const
 
void recomputeDimBlock (bool forceUpdate=true)
 
double getMeasurement () const
 
double measurement ()
 
OdUInt16 getBgrndTxtColor (OdCmColor &bgrndTxtColor) const
 
void setBgrndTxtColor (const OdCmColor &bgrndTxtColor, OdUInt16 bgrndTxtFlags)
 
bool getExtLineFixLenEnable () const
 
void setExtLineFixLenEnable (bool extLineFixLenEnable)
 
double getExtLineFixLen () const
 
void setExtLineFixLen (double extLineFixLen)
 
OdDbObjectId getDimLinetype () const
 
void setDimLinetype (const OdDbObjectId &linetypeId)
 
OdDbObjectId getDimExt1Linetype () const
 
void setDimExt1Linetype (const OdDbObjectId &linetypeId)
 
OdDbObjectId getDimExt2Linetype () const
 
void setDimExt2Linetype (const OdDbObjectId &linetypeId)
 
bool getArrowFirstIsFlipped () const
 
bool getArrowSecondIsFlipped () const
 
void setArrowFirstIsFlipped (bool bIsFlipped)
 
void setArrowSecondIsFlipped (bool bIsFlipped)
 
bool inspection () const
 
void setInspection (bool val)
 
int inspectionFrame () const
 
void setInspectionFrame (int frame)
 
OdString inspectionLabel () const
 
void setInspectionLabel (const OdString &label)
 
OdString inspectionRate () const
 
void setInspectionRate (const OdString &label)
 
virtual OdResult dwgInFields (OdDbDwgFiler *pFiler)
 
virtual void dwgOutFields (OdDbDwgFiler *pFiler) const
 
virtual OdResult dxfInFields (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields (OdDbDxfFiler *pFiler) const
 
virtual OdResult dxfInFields_R12 (OdDbDxfFiler *pFiler)
 
virtual void dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
 
OdResult subGetClassID (void *pClsid) const
 
OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
bool subWorldDraw (OdGiWorldDraw *pWd) const
 
void subViewportDraw (OdGiViewportDraw *pVd) const
 
virtual OdResult subExplode (OdRxObjectPtrArray &entitySet) const ODRX_OVERRIDE
 
void subClose ()
 
virtual void modified (const OdDbObject *pObject)
 
virtual OdResult subTransformBy (const OdGeMatrix3d &xfm) ODRX_OVERRIDE
 
virtual OdResult subGetTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_OVERRIDE
 
void subSetDatabaseDefaults (OdDbDatabase *pDb, bool doSubents)
 
virtual void appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap) ODRX_OVERRIDE
 
virtual OdDbObjectPtr subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
void formatMeasurement (OdString &formattedMeasurement, double measurementValue, const OdString &dimensionText)
 
OdResult explodeGeometry (OdRxObjectPtrArray &entitySet) const
 
OdDbObjectPtr dimBlock (OdDb::OpenMode openMode=OdDb::kForRead)
 
virtual OdResult subGetCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_OVERRIDE
 
bool isDynamicDimension () const
 
void setDynamicDimension (bool bDynamic)
 
bool isConstraintObject () const
 
OdResult isConstraintObject (bool &isConstraintObject, bool &hasExpression, bool &isReferenceConstraint) const
 
bool isConstraintDynamic () const
 
OdResult setConstraintDynamic (bool bDynamic)
 
bool shouldParticipateInOPM () const
 
void setShouldParticipateInOPM (bool bShouldParticipate)
 
void setDIMTALN (bool val)
 
bool getDIMTALN () const
 
void removeTextField ()
 
void fieldToMText (OdDbMTextPtr &pDimMText)
 
void fieldFromMText (OdDbMTextPtr &pDimMText)
 
OdGeMatrix3d getEcs () const
 
void resetTextDefinedSize ()
 
void setTextDefinedSize (double width, double height)
 
void textDefinedSize (double &width, double &height) const
 
- 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_SEALED
 
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)
 
void subHandOverTo (OdDbObject *pNewObject)
 
ODRX_SEALED_VIRTUAL OdResult transformBy (const OdGeMatrix3d &xfm) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getTransformedCopy (const OdGeMatrix3d &xfm, OdDbEntityPtr &pCopy) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult explode (OdRxObjectPtrArray &entitySet) const ODRX_SEALED
 
virtual OdResult explodeToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
virtual OdResult explodeGeometryToBlock (OdDbBlockTableRecord *pBlockRecord, OdDbObjectIdArray *ids=0)
 
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 OdGiDrawabledrawable ()
 
virtual void subList () const
 
void subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
 
virtual OdResult subErase (bool erasing) ODRX_OVERRIDE
 
void recordGraphicsModified (bool graphicsModified=true)
 
virtual void copyFrom (const OdRxObject *pSource)
 
ODRX_SEALED_VIRTUAL void list () const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void highlight (bool bDoIt=true, const OdDbFullSubentPath *pSubId=0, bool highlightAll=false) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getOsnapPoints (OdDb::OsnapMode osnapMode, OdGsMarker gsSelectionMark, const OdGePoint3d &pickPoint, const OdGePoint3d &lastPoint, const OdGeMatrix3d &xWorldToEye, OdGePoint3dArray &snapPoints) const ODRX_SEALED
 
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_SEALED
 
ODRX_SEALED_VIRTUAL bool isContentSnappable () const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdGePoint3dArray &gripPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPoints (OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const int bitFlags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAt (const OdDbVoidPtrArray &grips, const OdGeVector3d &offset, int bitFlags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getStretchPoints (OdGePoint3dArray &stretchPoints) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveStretchPointsAt (const OdIntArray &indices, const OdGeVector3d &offset) ODRX_SEALED
 
virtual void dragStatus (const OdDb::DragStat status)
 
ODRX_SEALED_VIRTUAL void gripStatus (const OdDb::GripStat status) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool cloneMeForDragging () ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool hideMeForDragging () const ODRX_SEALED
 
virtual void saveAs (OdGiWorldDraw *pWd, OdDb::DwgVersion ver) const
 
ODRX_SEALED_VIRTUAL OdResult getCompoundObjectTransform (OdGeMatrix3d &xM) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult intersectWith (const OdDbEntity *pEnt, OdDb::Intersect intType, const OdGePlane &projPlane, OdGePoint3dArray &points, OdGsMarker thisGsMarker=0, OdGsMarker otherGsMarker=0) const ODRX_SEALED
 
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_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getGripPointsAtSubentPath (const OdDbFullSubentPath &path, OdDbGripDataPtrArray &grips, const double curViewUnitSize, const int gripSize, const OdGeVector3d &curViewDir, const OdUInt32 bitflags) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult moveGripPointsAtSubentPaths (const OdDbFullSubentPathArray &paths, const OdDbVoidPtrArray &gripAppData, const OdGeVector3d &offset, const OdUInt32 bitflags) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult deleteSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult addSubentPaths (const OdDbFullSubentPathArray &paths) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbEntityPtr subentPtr (const OdDbFullSubentPath &path) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult transformSubentPathsBy (const OdDbFullSubentPathArray &paths, const OdGeMatrix3d &xform) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentClassId (const OdDbFullSubentPath &path, void *clsId) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdResult getSubentPathGeomExtents (const OdDbFullSubentPath &path, OdGeExtents3d &extents) ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void subentGripStatus (OdDb::GripStat status, const OdDbFullSubentPath &subentity) ODRX_SEALED
 
- Public Member Functions inherited from OdDbObject
 ODDB_DECLARE_MEMBERS (OdDbObject)
 
 ~OdDbObject ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
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 OdResult subOpen (OdDb::OpenMode mode)
 
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 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 &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdDbObjectPtr wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
 
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_SEALED
 
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_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- 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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE
 
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
 
- Protected Attributes inherited from OdDbObject
OdDbObjectImplm_pImpl
 

Detailed Description

This class is the base class for all Dimension classes in an OdDbDatabase instance.

See also
TD_Db

<group OdDb_Classes>

Definition at line 51 of file DbDimension.h.

Member Enumeration Documentation

◆ DimInspect

Enumerator
kShapeRemove 
kShapeRound 
kShapeAngular 
kShapeNone 
kShapeLabel 
kShapeRate 

Definition at line 512 of file DbDimension.h.

Constructor & Destructor Documentation

◆ OdDbDimension()

OdDbDimension::OdDbDimension ( )

Member Function Documentation

◆ appendToOwner()

virtual void OdDbDimension::appendToOwner ( OdDbIdPair idPair,
OdDbObject pOwnerObject,
OdDbIdMapping ownerIdMap 
)
virtual

This function appends this object to the specified owner object.

Parameters
idPair[in] ID pair to append.
pOwnerObject[in] Pointer to the owner object.
ownerIdMap[in/out] Owner's ID map.
Remarks
Adds a record to the specified ID map.

This function is used internally to subDeepClone() and subWblockClone().

Throws:

Cause eInvalidOwnerObject !pOwnerObject->get()

Reimplemented from OdDbObject.

◆ dimBlock()

OdDbObjectPtr OdDbDimension::dimBlock ( OdDb::OpenMode  openMode = OdDb::kForRead)

◆ dimBlockId()

OdDbObjectId OdDbDimension::dimBlockId ( ) const

Returns the Object ID of the dimension block (OdDbBlockTableRecord) associated with this Dimension entity (DXF 2).

◆ dimBlockPosition()

OdGePoint3d OdDbDimension::dimBlockPosition ( ) const

Returns the WCS relative position of the block associated with this Dimension entity (DXF 12).

Remarks
dimBlockPosition is the insertion point of the block with respect to the primary definition point (DXF 10) of the dimension block.

◆ dimBlockRotation()

double OdDbDimension::dimBlockRotation ( ) const

Returns the rotation angle of the dimension block referenced by this Dimension entity (DXF 54).

Remarks
All angles are expressed in radians.

◆ dimBlockScale()

OdGeScale3d OdDbDimension::dimBlockScale ( ) const

Returns the scale of the dimension block referenced by this Dimension entity.

Remarks
This is not saved to a DXF file.

◆ dimBlockTransform()

OdGeMatrix3d OdDbDimension::dimBlockTransform ( ) const

Returns the transformation matrix applied to dimension block referenced by this Dimension entity.

Remarks
The transformation consists of position, scale, rotation angle and normal. It does not include block's base point.

◆ dimensionStyle()

OdDbObjectId OdDbDimension::dimensionStyle ( ) const

Returns the Object ID of the dimension style (OdDbDimStyleTableRecord) for this Dimension entity (DXF 3).

◆ dimensionText()

const OdString OdDbDimension::dimensionText ( ) const

Returns the user-supplied dimension text for this Dimension Entity (DXF 1).

Remarks
If no text is to appear, "." will be returned. If only the default text is to appear, "" will be returned. The default text is represented as "<>" within the returned text.

◆ dwgInFields()

virtual OdResult OdDbDimension::dwgInFields ( OdDbDwgFiler pFiler)
virtual

◆ dwgOutFields()

virtual void OdDbDimension::dwgOutFields ( OdDbDwgFiler pFiler) const
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 OdDbEntity.

Reimplemented in OdDbRotatedDimension, OdDbRadialDimensionLarge, OdDbRadialDimension, OdDbOrdinateDimension, OdDbDiametricDimension, OdDbArcDimension, OdDbAlignedDimension, OdDb3PointAngularDimension, and OdDb2LineAngularDimension.

◆ dxfInFields()

virtual OdResult OdDbDimension::dxfInFields ( OdDbDxfFiler pFiler)
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 OdDbEntity.

Reimplemented in OdDbRotatedDimension, OdDbRadialDimensionLarge, OdDbRadialDimension, OdDbOrdinateDimension, OdDbDiametricDimension, OdDbArcDimension, OdDbAlignedDimension, OdDb3PointAngularDimension, and OdDb2LineAngularDimension.

◆ dxfInFields_R12()

virtual OdResult OdDbDimension::dxfInFields_R12 ( OdDbDxfFiler pFiler)
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 OdDbEntity.

Reimplemented in OdDbRotatedDimension, OdDbRadialDimension, OdDbOrdinateDimension, OdDbDiametricDimension, OdDbAlignedDimension, OdDb3PointAngularDimension, and OdDb2LineAngularDimension.

◆ dxfOutFields()

virtual void OdDbDimension::dxfOutFields ( OdDbDxfFiler pFiler) const
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 OdDbEntity.

Reimplemented in OdDbRotatedDimension, OdDbRadialDimensionLarge, OdDbRadialDimension, OdDbOrdinateDimension, OdDbDiametricDimension, OdDbArcDimension, OdDbAlignedDimension, OdDb3PointAngularDimension, and OdDb2LineAngularDimension.

◆ dxfOutFields_R12()

virtual void OdDbDimension::dxfOutFields_R12 ( OdDbDxfFiler pFiler) const
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 OdDbEntity.

Reimplemented in OdDbRotatedDimension, OdDbRadialDimension, OdDbOrdinateDimension, OdDbDiametricDimension, OdDbAlignedDimension, OdDb3PointAngularDimension, and OdDb2LineAngularDimension.

◆ elevation()

double OdDbDimension::elevation ( ) const

Returns the elevation of this entity in the OCS (DXF 30).

Remarks
The elevation is the distance from the WCS origin to the plane of this entity.

◆ explodeGeometry()

OdResult OdDbDimension::explodeGeometry ( OdRxObjectPtrArray entitySet) const
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 from OdDbEntity.

◆ fieldFromMText()

void OdDbDimension::fieldFromMText ( OdDbMTextPtr pDimMText)

◆ fieldToMText()

void OdDbDimension::fieldToMText ( OdDbMTextPtr pDimMText)

◆ formatMeasurement()

void OdDbDimension::formatMeasurement ( OdString formattedMeasurement,
double  measurementValue,
const OdString dimensionText 
)

Returns the formatted measurement value.

Parameters
formattedMeasurement[out] Receives the formatted measurement.
measurementValue[in] Measurement value to be formatted.
dimensionText[in] Dimension text for formatting
Remarks
measurementValue is formatted per the specified dimension text and the effective dimension style.

◆ getArrowFirstIsFlipped()

bool OdDbDimension::getArrowFirstIsFlipped ( ) const

Returns the flip flag of the first arrowhead for this Dimension entity.

◆ getArrowSecondIsFlipped()

bool OdDbDimension::getArrowSecondIsFlipped ( ) const

Returns the flip flag of the second arrowhead for this Dimension entity.

◆ getBgrndTxtColor()

OdUInt16 OdDbDimension::getBgrndTxtColor ( OdCmColor bgrndTxtColor) const

Returns the background text color and flags for this Dimension entity.

Parameters
bgrndTxtColor[out] Receives the background text color.

◆ getDimExt1Linetype()

OdDbObjectId OdDbDimension::getDimExt1Linetype ( ) const

Returns the Object ID of the first extension line linetype for this Dimension entity.

◆ getDimExt2Linetype()

OdDbObjectId OdDbDimension::getDimExt2Linetype ( ) const

Returns the Object ID of the second extension line linetype for this Dimension entity.

◆ getDimLinetype()

OdDbObjectId OdDbDimension::getDimLinetype ( ) const

Returns the Object ID of the dimension line linetype for this Dimension entity.

◆ getDimstyleData()

void OdDbDimension::getDimstyleData ( OdDbDimStyleTableRecord pRecord) const

Copies the dimension style settings, including overrides, of this Dimension entity into the specified dimension style table record.

Parameters
pRecord[out] Receives the effective dimension style data associated with entity.
Remarks
The copied data includes the dimension style data with all applicable overrides.

◆ getDIMTALN()

bool OdDbDimension::getDIMTALN ( ) const

◆ getEcs()

OdGeMatrix3d OdDbDimension::getEcs ( ) const
virtual

Returns the entity coordinate system matrix.

Remarks
Default implementation returns Identity matrix.

Reimplemented from OdDbEntity.

◆ getExtLineFixLen()

double OdDbDimension::getExtLineFixLen ( ) const

Returns the extension line fixed length for this Dimension entity.

◆ getExtLineFixLenEnable()

bool OdDbDimension::getExtLineFixLenEnable ( ) const

Returns the extension line fixed length enable flag for this Dimension entity.

◆ getMeasurement()

double OdDbDimension::getMeasurement ( ) const

Returns the measurement (DXF 42) stored in this Dimension entity.

Remarks
Returns -1.0 if the stored measurement value is invalid.

Does not recompute the measurement.

This Dimension entity need not be opened for write to call this function.

See also
measurement()

◆ getPlane()

virtual OdResult OdDbDimension::getPlane ( OdGePlane plane,
OdDb::Planarity planarity 
) const
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 from OdDbEntity.

◆ horizontalRotation()

double OdDbDimension::horizontalRotation ( ) const

Returns the horizontal rotation angle for this Dimension entity (DXF 51).

Remarks
All angles are expressed in radians.

◆ inspection()

bool OdDbDimension::inspection ( ) const

◆ inspectionFrame()

int OdDbDimension::inspectionFrame ( ) const

◆ inspectionLabel()

OdString OdDbDimension::inspectionLabel ( ) const

◆ inspectionRate()

OdString OdDbDimension::inspectionRate ( ) const

◆ isConstraintDynamic()

bool OdDbDimension::isConstraintDynamic ( ) const

◆ isConstraintObject() [1/2]

bool OdDbDimension::isConstraintObject ( ) const

◆ isConstraintObject() [2/2]

OdResult OdDbDimension::isConstraintObject ( bool &  isConstraintObject,
bool &  hasExpression,
bool &  isReferenceConstraint 
) const

◆ isDynamicDimension()

bool OdDbDimension::isDynamicDimension ( ) const

◆ isPlanar()

virtual bool OdDbDimension::isPlanar ( ) const
inlinevirtual

Returns true if and only if this entity is planar.

Reimplemented from OdDbEntity.

Definition at line 107 of file DbDimension.h.

◆ isSingleDimBlockReference()

bool OdDbDimension::isSingleDimBlockReference ( ) const

Returns true and only if this Dimension entity has the only reference to its associated OdDbBlockTableRecord (DXF 70 bit 0x20).

◆ isUsingDefaultTextPosition()

bool OdDbDimension::isUsingDefaultTextPosition ( ) const

Returns true if and only if the dimension text for this Dimension entity is in the default position (DXF 70, bit 0x80 == 0).

◆ measurement()

double OdDbDimension::measurement ( )

Returns the measurement (DXF 42) for this Dimension entity.

Remarks
Recomputes the measurement if the stored measurement value is invalid (-1.0).

This Dimension entity must be opened for write to call this function.

See also
getMeasurement()

◆ modified()

virtual void OdDbDimension::modified ( const OdDbObject pObject)
virtual

Notification function called whenever an object is opened OdDb::kForWrite, a function has been called that could modify the contents of this object, and this object is now being closed.

Parameters
pObject[in] Pointer to the object that is being closed after being modified.
Remarks
The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ normal()

OdGeVector3d OdDbDimension::normal ( ) const

Returns the WCS normal to the plane of this entity (DXF 210).

◆ ODDB_DECLARE_MEMBERS()

OdDbDimension::ODDB_DECLARE_MEMBERS ( OdDbDimension  )

◆ recomputeDimBlock()

void OdDbDimension::recomputeDimBlock ( bool  forceUpdate = true)

Recomputes the dimension block referenced by this Dimension entity.

Remarks
The OdDbBlockTableRecord of the dimension block is updated to reflect any changes made to this Dimension entity since the last time the block table record was updated.
Parameters
forceUpdate[in] If true, the OdDbBlockTableRecord is updated even if the dimension has not been changed.

◆ removeTextField()

void OdDbDimension::removeTextField ( )

◆ resetTextDefinedSize()

void OdDbDimension::resetTextDefinedSize ( )

Resets defined width and defined height for MText

◆ setArrowFirstIsFlipped()

void OdDbDimension::setArrowFirstIsFlipped ( bool  bIsFlipped)

Sets the flip flag of the first arrowhead for this Dimension entity.

Parameters
bIsFlipped[in] Flip flag value.

◆ setArrowSecondIsFlipped()

void OdDbDimension::setArrowSecondIsFlipped ( bool  bIsFlipped)

Sets the flip flag of the second arrowhead for this Dimension entity.

Parameters
bIsFlipped[in] Flip flag value.

◆ setBgrndTxtColor()

void OdDbDimension::setBgrndTxtColor ( const OdCmColor bgrndTxtColor,
OdUInt16  bgrndTxtFlags 
)

Sets the background text color and flags for this Dimension entity.

Parameters
bgrndTxtColor[in] Background text color.
bgrndTxtFlags[in] Background text flags.

◆ setConstraintDynamic()

OdResult OdDbDimension::setConstraintDynamic ( bool  bDynamic)

◆ setDimBlockId()

void OdDbDimension::setDimBlockId ( const OdDbObjectId dimBlockId,
bool  singleReferenced = true 
)

Sets the Object ID of the dimension block (OdDbBlockTableRecord) associated with this Dimension entity.

Parameters
dimBlockId[in] Object ID of the OdDbBlockTableRecord.
singleReferenced[in] True if and only if the dimension block is referenced only by this Dimension entity (DXF 70 bit 0x20).

◆ setDimBlockPosition()

void OdDbDimension::setDimBlockPosition ( const OdGePoint3d dimBlockPosition)

DOM

Sets the relative position of the dimension block referenced by this Dimension entity, in WCS (DXF 12).

Parameters
dimBlockPosition[in] Dimension block position.
Remarks
For Teigha internal use only. Dimension update sets it to 0,0,0

◆ setDimBlockRotation()

void OdDbDimension::setDimBlockRotation ( double  dimBlockRotation)

DOM

Sets the rotation of the dimension block referenced by this Dimension entity (DXF 54).

Remarks
For Teigha internal use only. Dimension update sets it to 0.
Parameters
dimBlockRotation[in] Dimension block rotation in radians.

◆ setDimBlockScale()

void OdDbDimension::setDimBlockScale ( const OdGeScale3d dimBlockScale)

DOM

Sets the scale of the dimension block referenced by this Dimension entity.

Remarks
For Teigha internal use only. Dimension update sets it to 1,1,1
Parameters
dimBlockScale[in] Dimension block scale.

◆ setDimensionStyle()

void OdDbDimension::setDimensionStyle ( OdDbObjectId  objectID)

Sets the Object ID of the dimension style (OdDbDimStyleTableRecord) for this Dimension entity (DXF 3).

Parameters
objectID[in] Object ID.

◆ setDimensionText()

void OdDbDimension::setDimensionText ( const OdString dimensionText)

Sets the user-supplied dimension text for this Dimension Entity (DXF 1).

Parameters
dimensionText[in] Dimension text.
Remarks
If no text is to appear, supply ".". If only the default text is to appear, supply an empty string "". The default text is represented as "<>" within the supplied text.

◆ setDimExt1Linetype()

void OdDbDimension::setDimExt1Linetype ( const OdDbObjectId linetypeId)

Sets the Object ID of the first extension line linetype for this Dimension entity.

Parameters
linetypeId[in] First extension line linetype Object ID.

◆ setDimExt2Linetype()

void OdDbDimension::setDimExt2Linetype ( const OdDbObjectId linetypeId)

Sets the Object ID of the second extension line linetype for this Dimension entity.

Parameters
linetypeId[in] Second extension line linetype Object ID.

◆ setDimLinetype()

void OdDbDimension::setDimLinetype ( const OdDbObjectId linetypeId)

Sets the Object ID of the dimension line linetype for this Dimension entity.

Parameters
linetypeId[in] Dimension line linetype Object ID.

◆ setDimstyleData() [1/2]

void OdDbDimension::setDimstyleData ( const OdDbDimStyleTableRecord pDimstyle)

Copies the dimension style settings, including overrides, from the specified dimension style table record to this Dimension entity.

Parameters
pDimstyle[in] Pointer to a non- database -resident dimension style record.
Remarks
The copied data includes the dimension style with all applicable overrides.

◆ setDimstyleData() [2/2]

void OdDbDimension::setDimstyleData ( OdDbObjectId  dimstyleID)

Copies the dimension style settings, including overrides, from the specified dimension style table record to this Dimension entity.

Parameters
dimstyleID[in] Database-resident dimension style record.
Remarks
The copied data includes the dimension style with all applicable overrides.

◆ setDIMTALN()

void OdDbDimension::setDIMTALN ( bool  val)

◆ setDynamicDimension()

void OdDbDimension::setDynamicDimension ( bool  bDynamic)

◆ setElevation()

void OdDbDimension::setElevation ( double  elevation)

Sets the elevation of this entity in the OCS (DXF 30).

Parameters
elevation[in] Elevation.
Remarks
The elevation is the distance from the WCS origin to the plane of this entity.

◆ setExtLineFixLen()

void OdDbDimension::setExtLineFixLen ( double  extLineFixLen)

Sets the extension line fixed length for this Dimension entity.

Parameters
extLineFixLen[in] Extension line fixed length.

◆ setExtLineFixLenEnable()

void OdDbDimension::setExtLineFixLenEnable ( bool  extLineFixLenEnable)

Controls the extension line fixed length enable flag for this Dimension entity.

Parameters
extLineFixLenEnable[in] Extension line fixed length flag.

◆ setHorizontalRotation()

void OdDbDimension::setHorizontalRotation ( double  horizontalRotation)

Sets the horizontal rotation angle for this Dimension entity (DXF 51).

Parameters
horizontalRotation[in] Horizontal rotation angle.
Remarks
All angles are expressed in radians.

◆ setInspection()

void OdDbDimension::setInspection ( bool  val)

◆ setInspectionFrame()

void OdDbDimension::setInspectionFrame ( int  frame)

◆ setInspectionLabel()

void OdDbDimension::setInspectionLabel ( const OdString label)

◆ setInspectionRate()

void OdDbDimension::setInspectionRate ( const OdString label)

◆ setNormal()

void OdDbDimension::setNormal ( const OdGeVector3d normal)

Sets the WCS normal to the plane of this entity (DXF 210).

Parameters
normal[in] Normal.

◆ setShouldParticipateInOPM()

void OdDbDimension::setShouldParticipateInOPM ( bool  bShouldParticipate)

◆ setTextAttachment()

void OdDbDimension::setTextAttachment ( OdDbMText::AttachmentPoint  attachmentPoint)

Sets the dimension text attachment point for this Dimension entity (DXF 71).

Parameters
attachmentPoint[in] Attachment Point.

◆ setTextDefinedSize()

void OdDbDimension::setTextDefinedSize ( double  width,
double  height 
)

Sets defined width and defined height for MText

Parameters
width[in] MText width
height[in] MText height

◆ setTextLineSpacingFactor()

void OdDbDimension::setTextLineSpacingFactor ( double  lineSpacingFactor)

Sets the dimension text line spacing factor for this Dimension entity (DXF 41).

Parameters
lineSpacingFactor[in] Line spacing factor. [0.25 .. 4.0]
See also
OdDb::LineSpacingStyle

◆ setTextLineSpacingStyle()

void OdDbDimension::setTextLineSpacingStyle ( OdDb::LineSpacingStyle  lineSpacingStyle)

Sets the dimension text line spacing style for this Dimension entity (DXF 72).

Parameters
lineSpacingStyle[in] Line spacing style.

◆ setTextPosition()

void OdDbDimension::setTextPosition ( const OdGePoint3d textPosition)

Sets the position of the dimension text for this Dimension entity (DXF 11 as WCS).

Parameters
textPosition[in] Text position.
Remarks
This position is the middle center point of the dimension text, which is itself a middle-center justified MText entity.

◆ setTextRotation()

void OdDbDimension::setTextRotation ( double  textRotation)

Sets the rotation angle for the dimension text for this Dimension entity (DXF 53).

Parameters
textRotation[in] Text rotation.
Remarks
All angles are expressed in radians.

◆ shouldParticipateInOPM()

bool OdDbDimension::shouldParticipateInOPM ( ) const

◆ subClose()

void OdDbDimension::subClose ( )
virtual

Called as the first operation as this object is being closed, for database -resident objects only.

Remarks
This function is notified just before the current open operation is to be closed, giving this function the ability to perform necessary operatons.

When overriding this function:

1) If the OdDbObject's state is incorrect, throw exception.

2) Call parent class's subClose().

3) If other actions are required before close, do them.

The default implementation of this function does nothing. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subExplode()

virtual OdResult OdDbDimension::subExplode ( OdRxObjectPtrArray entitySet) const
virtual

Reimplemented from OdDbEntity.

◆ subGetClassID()

OdResult OdDbDimension::subGetClassID ( void pClsid) const
virtual

◆ subGetCompoundObjectTransform()

virtual OdResult OdDbDimension::subGetCompoundObjectTransform ( OdGeMatrix3d xM) const
virtual

Reimplemented from OdDbEntity.

◆ subGetTransformedCopy()

virtual OdResult OdDbDimension::subGetTransformedCopy ( const OdGeMatrix3d xfm,
OdDbEntityPtr pCopy 
) const
virtual

Reimplemented from OdDbEntity.

◆ subSetAttributes()

OdUInt32 OdDbDimension::subSetAttributes ( OdGiDrawableTraits pTraits) const
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 OdDbEntity.

◆ subSetDatabaseDefaults()

void OdDbDimension::subSetDatabaseDefaults ( OdDbDatabase pDb,
bool  doSubents 
)
virtual

This function is an override for OdDbEntity::subSetDatabaseDefaults() to set the dimension style of this entity to the current style for the specified database.

Reimplemented from OdDbEntity.

◆ subTransformBy()

virtual OdResult OdDbDimension::subTransformBy ( const OdGeMatrix3d xfm)
virtual

Reimplemented from OdDbEntity.

◆ subViewportDraw()

void OdDbDimension::subViewportDraw ( OdGiViewportDraw pVd) const
virtual

Reimplemented from OdDbEntity.

◆ subWblockClone()

virtual OdDbObjectPtr OdDbDimension::subWblockClone ( OdDbIdMapping ownerIdMap,
OdDbObject ,
bool  bPrimary 
) const
virtual

Reimplemented from OdDbEntity.

◆ subWorldDraw()

bool OdDbDimension::subWorldDraw ( OdGiWorldDraw pWd) const
virtual

Reimplemented from OdDbEntity.

◆ textAttachment()

OdDbMText::AttachmentPoint OdDbDimension::textAttachment ( ) const

Returns the dimension text attachment point for this Dimension entity (DXF 71).

◆ textDefinedSize()

void OdDbDimension::textDefinedSize ( double &  width,
double &  height 
) const

Gets defined width and defined height for MText

Parameters
width[out] MText width
height[out] MText height

◆ textLineSpacingFactor()

double OdDbDimension::textLineSpacingFactor ( ) const

Returns the dimension text line spacing factor for this Dimension entity (DXF 41).

See also
OdDb::LineSpacingStyle

◆ textLineSpacingStyle()

OdDb::LineSpacingStyle OdDbDimension::textLineSpacingStyle ( ) const

Returns the dimension text line spacing style for this Dimension entity (DXF 72).

◆ textPosition()

OdGePoint3d OdDbDimension::textPosition ( ) const

Returns the position of the dimension text for this Dimension entity (DXF 11 as WCS).

Remarks
This position is the middle center point of the dimension text, which is itself a middle-center justified MText entity.

◆ textRotation()

double OdDbDimension::textRotation ( ) const

Returns the rotation angle for the dimension text for this Dimension entity (DXF 53).

Remarks
All angles are expressed in radians.

◆ useDefaultTextPosition()

void OdDbDimension::useDefaultTextPosition ( )

Sets the dimension text for this Dimension entity to use the default position (DXF 70, clears bit 0x80).

◆ useSetTextPosition()

void OdDbDimension::useSetTextPosition ( )

Sets the dimension text for this Dimension entity to not use the default position (DXF 70, sets bit 0x80).


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