#include <DbLeader.h>

Inheritance diagram for OdDbLeader:

Public Types
enum	AnnoType { kMText = 0 , kFcf = 1 , kBlockRef = 2 , kNoAnno = 3 , kText = 4 }

enum	gsMarkType { kArrowMark = 3 , kLeaderLineMark = kArrowMark + 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 , 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 (OdDbLeader)

	OdDbLeader ()

virtual OdGeVector3d	normal () const

virtual int	numVertices () const

virtual bool	appendVertex (const OdGePoint3d &vertex)

virtual void	removeLastVertex ()

virtual OdGePoint3d	firstVertex () const

virtual OdGePoint3d	lastVertex () const

virtual OdGePoint3d	vertexAt (int vertexIndex) const

virtual bool	setVertexAt (int vertexIndex, const OdGePoint3d &vertex)

bool	isArrowHeadEnabled () const

virtual bool	hasArrowHead () const

virtual void	enableArrowHead ()

virtual void	disableArrowHead ()

virtual bool	hasHookLine () const

virtual bool	isHookLineOnXDir () const

virtual void	setToSplineLeader ()

virtual void	setToStraightLeader ()

virtual bool	isSplined () const

virtual OdDbHardPointerId	dimensionStyle () const

virtual void	setDimensionStyle (const OdDbHardPointerId &dimStyleId)

virtual void	attachAnnotation (OdDbObjectId annoId)

virtual void	attachAnnotation (OdDbObjectId annoId, OdGeVector3d xDir, double annotationWidth, double annotationHeight, bool hookLineOnXDir)

virtual void	detachAnnotation ()

virtual OdDbObjectId	annotationObjId () const

virtual OdGeVector3d	annotationXDir () const

virtual OdGeVector3d	annotationOffset () const

virtual void	setAnnotationOffset (const OdGeVector3d &offset)

AnnoType	annoType () const

double	annoHeight () const

double	annoWidth () const

virtual double	dimasz () const

virtual OdCmColor	dimclrd () const

virtual double	dimgap () const

virtual OdDb::LineWeight	dimlwd () const

virtual OdDbObjectId	dimldrblk () const

virtual bool	dimsah () const

virtual double	dimscale () const

virtual int	dimtad () const

virtual OdDbObjectId	dimtxsty () const

virtual double	dimtxt () const

virtual void	setDimasz (double val)

virtual void	setDimclrd (const OdCmColor &val)

virtual void	setDimgap (double val)

virtual void	setDimldrblk (OdDbObjectId val)

virtual void	setDimldrblk (const OdString &val)

virtual void	setDimlwd (OdDb::LineWeight val)

virtual void	setDimsah (bool val)

virtual void	setDimscale (double val)

virtual void	setDimtad (int val)

virtual void	setDimtxsty (OdDbObjectId val)

virtual void	setDimtxt (double val)

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const ODRX_OVERRIDE

ODRX_SEALED_VIRTUAL void	subViewportDraw (OdGiViewportDraw *pVd) const ODRX_OVERRIDE

virtual OdResult	subExplode (OdRxObjectPtrArray &entitySet) const ODRX_OVERRIDE

virtual void	subClose () ODRX_OVERRIDE

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const ODRX_OVERRIDE

virtual bool	isPlanar () const

virtual OdResult	getPlane (OdGePlane &plane, OdDb::Planarity &planarity) const

virtual bool	isClosed () const

virtual bool	isPeriodic () const

virtual OdResult	getStartParam (double &startParam) const

virtual OdResult	getEndParam (double &endParam) const

virtual OdResult	getStartPoint (OdGePoint3d &startPoint) const

virtual OdResult	getEndPoint (OdGePoint3d &endPoint) const

virtual OdResult	getPointAtParam (double param, OdGePoint3d &pointOnCurve) const ODRX_OVERRIDE

virtual OdResult	getParamAtPoint (const OdGePoint3d &pointOnCurve, double &param) const ODRX_OVERRIDE

virtual OdResult	subTransformBy (const OdGeMatrix3d &xfm) ODRX_OVERRIDE

virtual OdResult	subGetTransformedCopy (const OdGeMatrix3d &xform, OdDbEntityPtr &pEnt) const ODRX_OVERRIDE

virtual OdResult	getDistAtParam (double param, double &dist) const

virtual OdResult	getParamAtDist (double dist, double &param) const

virtual OdResult	getFirstDeriv (double param, OdGeVector3d &firstDeriv) const

virtual OdResult	getSecondDeriv (double param, OdGeVector3d &secondDeriv) const

virtual OdResult	getArea (double &area) const

	TD_USING (OdDbCurve::getFirstDeriv)

	TD_USING (OdDbCurve::getSecondDeriv)

void	subSetDatabaseDefaults (OdDbDatabase *pDb, bool doSubents)

virtual OdResult	evaluateLeader ()

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

void	getDimstyleData (OdDbDimStyleTableRecord *pRecord) const

void	setDimstyleData (const OdDbDimStyleTableRecord *pDimstyle)

void	setDimstyleData (OdDbObjectId dimstyleID)

virtual void	setPlane (const OdGePlane &leaderPlane)

OdResult	subGetSubentPathsAtGsMarker (OdDb::SubentType type, OdGsMarker gsMark, const OdGePoint3d &, const OdGeMatrix3d &, OdDbFullSubentPathArray &subentPaths, const OdDbObjectIdArray *pEntAndInsertStack) const

OdResult	subGetGsMarkersAtSubentPath (const OdDbFullSubentPath &subPath, OdGsMarkerArray &gsMarkers) const

Public Member Functions inherited from OdDbCurve
	ODDB_DECLARE_MEMBERS (OdDbCurve)

	OdDbCurve ()

virtual OdResult	getDistAtPoint (const OdGePoint3d &pointOnCurve, double &dist) const

virtual OdResult	getPointAtDist (double dist, OdGePoint3d &pointOnCurve) const

virtual OdResult	getFirstDeriv (const OdGePoint3d &pointOnCurve, OdGeVector3d &firstDeriv) const

virtual OdResult	getSecondDeriv (const OdGePoint3d &pointOnCurve, OdGeVector3d &secondDeriv) const

virtual OdResult	getClosestPointTo (const OdGePoint3d &givenPoint, OdGePoint3d &pointOnCurve, bool extend=false) const

virtual OdResult	getClosestPointTo (const OdGePoint3d &givenPoint, const OdGeVector3d &normal, OdGePoint3d &pointOnCurve, bool extend=false) const

virtual OdResult	getSpline (OdDbSplinePtr *spline) const

virtual OdResult	extend (double param)

virtual OdResult	extend (bool extendStart, const OdGePoint3d &toPoint)

virtual OdResult	getOrthoProjectedCurve (const OdGePlane &projPlane, OdDbCurvePtr *pProjCurve) const

virtual OdResult	getProjectedCurve (const OdGePlane &projPlane, const OdGeVector3d &projDirection, OdDbCurvePtr *pProjCurve) const

virtual OdResult	getOffsetCurves (double offsetDistance, OdRxObjectPtrArray &offsetCurves) const

virtual OdResult	getOffsetCurvesGivenPlaneNormal (const OdGeVector3d &normal, double offsetDistance, OdRxObjectPtrArray &offsetCurves) const

virtual OdResult	getSplitCurves (const OdGeDoubleArray &params, OdRxObjectPtrArray &curveSegments) const

virtual OdResult	getSplitCurves (const OdGePoint3dArray &points, OdRxObjectPtrArray &curveSegments) const

virtual OdResult	reverseCurve ()

virtual OdResult	getOdGeCurve (OdGeCurve3d *&pGeCurve, const OdGeTol &tol=OdGeContext::gTol) const

virtual OdResult	setFromOdGeCurve (const OdGeCurve3d &geCurve, OdGeVector3d *normal=NULL, const OdGeTol &tol=OdGeContext::gTol)

virtual OdInt32	findVertexIndex (const OdDbVertex *vert) 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 OdGiMapper *	materialMapper () 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	explodeGeometry (OdRxObjectPtrArray &entitySet) const

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 OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdGiDrawable *	drawable ()

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

virtual OdGeMatrix3d	getEcs () const

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)

OdDbDatabase *	database () 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

OdDbDwgFiler *	undoFiler ()

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	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (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)

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)

OdGsCache *	gsNode () 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 OdRxClass *	saveAsClass (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 OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () 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 OdDbCurve
static OdResult	createFromOdGeCurve (const OdGeCurve3d &geCurve, OdDbCurve &pDbCurve, OdGeVector3d normal=NULL, const OdGeTol &tol=OdGeContext::gTol)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions inherited from OdDbEntity
virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *, bool bPrimary) const ODRX_OVERRIDE

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 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
OdDbObjectImpl *	m_pImpl

Detailed Description

This class represents Leader entities in an OdDbDatabase instance.

Definition at line 40 of file DbLeader.h.

Member Enumeration Documentation

◆ AnnoType

enum OdDbLeader::AnnoType

The type of annotation used by a Leader entity.

Enumerator
kMText
kFcf
kBlockRef
kNoAnno
kText

Definition at line 286 of file DbLeader.h.

◆ gsMarkType

enum OdDbLeader::gsMarkType

Enumerator
kArrowMark
kLeaderLineMark

Definition at line 753 of file DbLeader.h.

Constructor & Destructor Documentation

◆ OdDbLeader()

OdDbLeader::OdDbLeader ( )

Member Function Documentation

◆ annoHeight()

double OdDbLeader::annoHeight ( ) const

Returns the height of the annotation entity associated with this Leader entity (DXF 40).

◆ annotationObjId()

virtual OdDbObjectId OdDbLeader::annotationObjId ( ) const

virtual

Returns the annotation Object ID of the annotation entity associated with this Leader entity (DXF 340).

◆ annotationOffset()

virtual OdGeVector3d OdDbLeader::annotationOffset ( ) const

virtual

Returns the annotation offset of this Leader entity (DXF 213).

Remarks: The annotation offset determines the final leader endpoint of this Leader entity

Final Leader Endpoint kMText annotationOffset() + OdDbMText::location() � OdGeVector3d(dimgap(), 0, 0) kFcf annotationOffset() + OdDbFcf::location() � OdGeVector3d(dimgap(), 0, 0) kBlockRef annotationOffset() + OdDbBlockReference::position() kNoAnno lastVertex()

Remarks: dimgap() is subtracted if the annotation is to the right of the Leader entity (isHookLikeOnXDir() == true) and added if it is to the left.

◆ annotationXDir()

virtual OdGeVector3d OdDbLeader::annotationXDir ( ) const

virtual

Returns the OCS X-axis of the annotation entity associated with this Leader entity (DXF 211).

◆ annoType()

AnnoType OdDbLeader::annoType ( ) const

Returns the annotation type associated with this Leader entity (DXF 73).

Remarks: annoType() returns one of the following:

Value Entity type Description kMText 0 OdDbMText MText kFcf 1 OdDbFcf Feature control frame (Tolerance)
kBlockRef 2 OdDbBlockReference Block reference kNoAnno 3 – No annotation

◆ annoWidth()

double OdDbLeader::annoWidth ( ) const

Returns the width of the annotation entity associated with this Leader entity (DXF 41).

◆ appendVertex()

virtual bool OdDbLeader::appendVertex ( const OdGePoint3d & vertex )

virtual

Appends the specified WCS vertex to this Leader entity.

Parameters

vertex [in] Vertex to append.

Returns: Returns true if and only if the vertex was appended.

The specified vertex is projected onto the plane of this Leader, parallel to its normal.

Remarks: If the specified vertex is inside a 2e-10 cube surrounding the previous vertex, it will not be appended.

◆ attachAnnotation() [1/2]

virtual void OdDbLeader::attachAnnotation ( OdDbObjectId annoId )

virtual

Sets the annotation entity of this Leader entity (DXF 340).

Parameters

annoId [in] The Object ID of the annotation entity.

Remarks: This Leader entity is appended to the persistent reactor list of the annotation entity.

The annotation entity must be one of, or a subclass of one of, the following

Entity type Description kMText OdDbMText MText kFcf OdDbFcf Feature control frame (Tolerance)
kBlockRef OdDbBlockReference Block reference

Other than annoId, the parameters are usually set with evaluateLeader().

◆ attachAnnotation() [2/2]

virtual void OdDbLeader::attachAnnotation	(	OdDbObjectId	annoId,
		OdGeVector3d	xDir,
		double	annotationWidth,
		double	annotationHeight,
		bool	hookLineOnXDir
	)

virtual

Sets the annotation entity of this Leader entity (DXF 340).

Parameters

annoId	[in] The Object ID of the annotation entity.
xDir	[in] WCS X-axis of the annotation entity.
annotationWidth	[in] Annotation entity width.
annotationHeight	[in] Annotation entity height.
hookLineOnXDir	[in] True to set hookline codirectional with the OCS X-axis of this annotation entity, or false to set it antidirectional with it.

Remarks: This Leader entity is appended to the persistent reactor list of the annotation entity.

The annotation entity must be one of, or a subclass of one of, the following

Entity type Description kMText OdDbMText MText kFcf OdDbFcf Feature control frame (Tolerance)
kBlockRef OdDbBlockReference Block reference

Other than annoId, the parameters are usually set with evaluateLeader().

◆ detachAnnotation()

virtual void OdDbLeader::detachAnnotation ( )

virtual

Removes this Leader entity from the persistent reactor list of its annotation entity, and sets the annotation Object ID to NULL.

◆ dimasz()

virtual double OdDbLeader::dimasz ( ) const

virtual

Returns the DIMASZ value of this object.

Remarks: DIMASZ specifies the arrowhead size for dimensions.; The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimclrd()

virtual OdCmColor OdDbLeader::dimclrd ( ) const

virtual

Returns the DIMCLRD value of this object.

Remarks: DIMCLRD specifies the color of dimension lines, leader lines, and arrowheads.; The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimensionStyle()

virtual OdDbHardPointerId OdDbLeader::dimensionStyle ( ) const

virtual

Returns the dimension style (OdDbDimStyleTableRecord) used by this Leader entity (DXF 3).

◆ dimgap()

virtual double OdDbLeader::dimgap ( ) const

virtual

Returns the DIMGAP value of this object.

Remarks: DIMGAP specifies the gap between dimension text and dimension lines.

A negative value for DIMGAP draws a reference box round the dimension text.

Text is placed inside a dimension line only if there will be two line segments each as long as abs(DIMGAP).

Remarks: The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimldrblk()

virtual OdDbObjectId OdDbLeader::dimldrblk ( ) const

virtual

Returns the DIMLDRBLK value of this object.

Remarks: DIMLDRBLK specifies the arrowhead block at the ends of leader lines.

A null value specifies the default arrowhead is to be used.

Remarks: The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimlwd()

virtual OdDb::LineWeight OdDbLeader::dimlwd ( ) const

virtual

Returns the DIMLWD value of this object.

Remarks: DIMLWD specifies the lineweight for dimension lines.; The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimsah()

virtual bool OdDbLeader::dimsah ( ) const

virtual

Returns the DIMSAH value of this object.

Remarks: DIMSAH controls the generation of separate arrowheads for dimension lines.

Arrowhead Blocks false DIMBLK true DIMBLK1 and DIMBLK2

Remarks: The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimscale()

virtual double OdDbLeader::dimscale ( ) const

virtual

Returns the DIMSCALE value of this object.

Remarks: DIMSCALE is an scale factor applied to all dimension variables that regulate sizes, offsets, and distances.

DIMSCALE serves as an overall "volume control" for dimensions and leaders.

Description 0.0 A "reasonable" value is computed for model space viewports.

0.0 If set to the inverse of the plot scale, plotted dimensions will be at the sizes specified by the other dimension variables.

Remarks: The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimtad()

virtual int OdDbLeader::dimtad ( ) const

virtual

Returns the DIMTAD value of this object.

Remarks: DIMTAD specifies the dimension text vertical position.

Description 0 Centered about the dimension line. 1 Above the dimension line, unless DIMTIH==1 and the dimension line is not horizontal. 2 Side of the dimension line farthest from the defining points. 3 JIS standard.

Remarks: The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimtxsty()

virtual OdDbObjectId OdDbLeader::dimtxsty ( ) const

virtual

Returns the DIMTXSTY value of this object.

Remarks: DIMTXSTY specifies the text style of the dimension text.; The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ dimtxt()

virtual double OdDbLeader::dimtxt ( ) const

virtual

Returns the DIMTXT value of this object.

Remarks: DIMTXT specifies the size of the dimension text.; The value from the dimension style of this object will be returned unless that value has been overridden, in which case, the override value will be returned.

◆ disableArrowHead()

virtual void OdDbLeader::disableArrowHead ( )

virtual

Disables the arrowhead for this Leader entity (DXF 71).

◆ dwgInFields()

virtual OdResult OdDbLeader::dwgInFields ( OdDbDwgFiler * pFiler )

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

◆ dwgOutFields()

virtual void OdDbLeader::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.

◆ dxfInFields()

virtual OdResult OdDbLeader::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.

◆ dxfOutFields()

virtual void OdDbLeader::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.

◆ enableArrowHead()

virtual void OdDbLeader::enableArrowHead ( )

virtual

Enables the arrowhead for this Leader entity (DXF 71).

◆ erased()

virtual void OdDbLeader::erased	(	const OdDbObject *	pObject,
		bool	erasing = `true`
	)

virtual

Notification function called whenever an object has been erased or unerased.

Parameters

pObject	[in] Pointer to the object that was erased/unerased.
erasing	[in] True if and only if this object is being erased.

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

Reimplemented from OdDbObject.

◆ evaluateLeader()

virtual OdResult OdDbLeader::evaluateLeader ( )

virtual

Updates this the geometry of this leader per its relationship to its annotation entity.

◆ firstVertex()

virtual OdGePoint3d OdDbLeader::firstVertex ( ) const

virtual

Returns the WCS first vertex of this Leader entity.

◆ getArea()

virtual OdResult OdDbLeader::getArea ( double & area ) const

virtual

Returns the area of this Curve object.

Parameters

area	[out] Receives the area.

Returns: Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbCurve.

◆ getDimstyleData()

void OdDbLeader::getDimstyleData ( OdDbDimStyleTableRecord * pRecord ) const

Copies the dimension style settings, including overrides, of this 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.

◆ getDistAtParam()

virtual OdResult OdDbLeader::getDistAtParam	(	double	param,
		double &	dist
	)		const

virtual

Returns the distance along this Curve object from its start point to the point specified by param.

Parameters

param	[in] Parameter specifying point.
dist	[out] Receives the distance.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getEndParam()

virtual OdResult OdDbLeader::getEndParam ( double & endParam ) const

virtual

Returns the parameter corresponding to the end point of this Curve object.

Parameters

endParam [out] Receives the end parameter.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getEndPoint()

virtual OdResult OdDbLeader::getEndPoint ( OdGePoint3d & endPoint ) const

virtual

Returns the WCS end point of this Curve object.

Parameters

endPoint [out] Receives the end point.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getFirstDeriv()

virtual OdResult OdDbLeader::getFirstDeriv	(	double	param,
		OdGeVector3d &	firstDeriv
	)		const

virtual

Returns the first derivative of this Curve object at the specified WCS point.

Parameters

param	[in] Parameter specifying point.
firstDeriv	[out] Receives the first derivative.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getParamAtDist()

virtual OdResult OdDbLeader::getParamAtDist	(	double	dist,
		double &	param
	)		const

virtual

Returns the parameter corresponding to the point a specified distance along this Curve object from its start point.

Parameters

param	[out] Receives the parameter.
dist	[in] Distance along the curve.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getParamAtPoint()

virtual OdResult OdDbLeader::getParamAtPoint	(	const OdGePoint3d &	pointOnCurve,
		double &	param
	)		const

virtual

Returns the parameter corresponding to the specified WCS point on this Curve object.

Parameters

param	[out] Receives the parameter corresponding to pointOnCurve.
pointOnCurve	[in] Point to be evaluated.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getPlane()

virtual OdResult OdDbLeader::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.

◆ getPointAtParam()

virtual OdResult OdDbLeader::getPointAtParam	(	double	param,
		OdGePoint3d &	pointOnCurve
	)		const

virtual

Returns the WCS point on this Curve object corresponding to the specified parameter.

Parameters

param	[in] Parameter specifying point.
pointOnCurve	[out] Receives the point on this Curve object.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getSecondDeriv()

virtual OdResult OdDbLeader::getSecondDeriv	(	double	param,
		OdGeVector3d &	secondDeriv
	)		const

virtual

Returns the second derivative of this Curve object at the specified point.

Parameters

param	[in] Parameter specifying point.
secondDeriv	[out] Receives the first derivative.

Returns: Returns eOk if successful, or an appropriate error code if not.

Reimplemented from OdDbCurve.

◆ getStartParam()

virtual OdResult OdDbLeader::getStartParam ( double & startParam ) const

virtual

Returns the parameter corresponding to the start point of this Curve object.

Parameters

startParam [out] Receives the start parameter.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ getStartPoint()

virtual OdResult OdDbLeader::getStartPoint ( OdGePoint3d & startPoint ) const

virtual

Returns the WCS start point of this Curve object.

Parameters

startPoint [out] Receives the start point.

Returns: Returns eOk if successful, or an appropriate error code if not.

Implements OdDbCurve.

◆ hasArrowHead()

virtual bool OdDbLeader::hasArrowHead ( ) const

virtual

Returns true if arrowhead is currently enabled for this leader:

Arrow head is enabled (isArrowHeadEnabled() returns true).
DIMASZ (arrow size) is non-zero
First leader's segment length is greater or equal to (DIMASZ DIMSCALE 2).

◆ hasHookLine()

virtual bool OdDbLeader::hasHookLine ( ) const

virtual

Returns true if and only if this Leader entity has a hookline (DXF 75).

◆ isArrowHeadEnabled()

bool OdDbLeader::isArrowHeadEnabled ( ) const

Returns true if and only if this Leader entity has an arrowhead (DXF 71).

◆ isClosed()

virtual bool OdDbLeader::isClosed ( ) const

virtual

Returns true if and only if this Curve object is closed.

Reimplemented from OdDbCurve.

◆ isHookLineOnXDir()

virtual bool OdDbLeader::isHookLineOnXDir ( ) const

virtual

Returns true if the hookline is codirectional with the OCS X-axis of this Leader entity, or false if it is antidirectional with it.

◆ isPeriodic()

virtual bool OdDbLeader::isPeriodic ( ) const

virtual

Returns true if and only if this Curve object is periodic.

Reimplemented from OdDbCurve.

◆ isPlanar()

virtual bool OdDbLeader::isPlanar ( ) const

virtual

Returns true if and only if this entity is planar.

Reimplemented from OdDbEntity.

◆ isSplined()

virtual bool OdDbLeader::isSplined ( ) const

virtual

Returns true if and only if this Leader entity uses a spline-fit leader line (DXF 72).

◆ lastVertex()

virtual OdGePoint3d OdDbLeader::lastVertex ( ) const

virtual

Returns the WCS last vertex of this Leader entity.

◆ modifiedGraphics()

virtual void OdDbLeader::modifiedGraphics ( const OdDbObject * pObject )

virtual

Support for persistent reactor to annotation entity.

Reimplemented from OdDbObject.

◆ normal()

virtual OdGeVector3d OdDbLeader::normal ( ) const

virtual

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

◆ numVertices()

virtual int OdDbLeader::numVertices ( ) const

virtual

Returns the number of vertices in this Leader entity (DXF 76).

◆ ODDB_DECLARE_MEMBERS()

OdDbLeader::ODDB_DECLARE_MEMBERS ( OdDbLeader )

◆ removeLastVertex()

virtual void OdDbLeader::removeLastVertex ( )

virtual

Removes the last vertex of this Leader entity.

◆ setAnnotationOffset()

virtual void OdDbLeader::setAnnotationOffset ( const OdGeVector3d & offset )

virtual

Sets the annotation offset of this leader (DXF 213).

Parameters

offset [in] Annotation offset.

Remarks: The annotation offset determines the final leader endpoint of this Leader entity

Final Leader Endpoint kMText annotationOffset() + OdGeVector3d(� dimgap(), 0, 0) + OdDbMText::location() kFcf annotationOffset() + OdGeVector3d(� dimgap(), 0, 0) + OdDbFcf::location() kBlockRef annotationOffset() + OdDbBlockReference::position() kNoAnno lastVertex()

Remarks: dimgap() is added if isHookLikeOnXDir() is true, subtracted if it is false.

◆ setDimasz()

virtual void OdDbLeader::setDimasz ( double val )

virtual

Sets the DIMASZ override for this object.

Parameters

val	[in] New value for DIMASZ.

Remarks: DIMASZ specifies the arrowhead size for dimensions.

◆ setDimclrd()

virtual void OdDbLeader::setDimclrd ( const OdCmColor & val )

virtual

Sets the DIMCLRD override for this object.

Parameters

val	[in] New value for DIMCLRD.

Remarks: DIMCLRD specifies the color of dimension lines, leader lines, and arrowheads.

◆ setDimensionStyle()

virtual void OdDbLeader::setDimensionStyle ( const OdDbHardPointerId & dimStyleId )

virtual

Sets the dimension style (OdDbDimStyleTableRecord) to used by this Leader entity (DXF 3).

Parameters

dimStyleId [in] Object ID of the dimension style.

◆ setDimgap()

virtual void OdDbLeader::setDimgap ( double val )

virtual

Sets the DIMGAP override for this object.

Parameters

val	[in] New value for DIMGAP.

Remarks: DIMGAP specifies the gap between dimension text and dimension lines.

A negative value for DIMGAP draws a reference box round the dimension text.

Text is placed inside a dimension line only if there will be two line segments each as long as abs(DIMGAP).

◆ setDimldrblk() [1/2]

virtual void OdDbLeader::setDimldrblk ( const OdString & val )

virtual

◆ setDimldrblk() [2/2]

virtual void OdDbLeader::setDimldrblk ( OdDbObjectId val )

virtual

Sets the DIMLDRBLK override for this object.

Parameters

val	[in] New value for DIMLDRBLK.

Remarks: DIMLDRBLK specifies the arrowhead block at the ends of leader lines.

A null value specifies the default arrowhead is to be used.

◆ setDimlwd()

virtual void OdDbLeader::setDimlwd ( OdDb::LineWeight val )

virtual

Sets the DIMLWD override for this object.

Parameters

val	[in] New value for DIMLWD.

Remarks: DIMLWD specifies the lineweight for dimension lines.

◆ setDimsah()

virtual void OdDbLeader::setDimsah ( bool val )

virtual

Sets the DIMSAH override for this object.

Parameters

val	[in] New value for DIMSAH.

Remarks: DIMSAH controls the generation of separate arrowheads for dimension lines.

Arrowhead Blocks false DIMBLK true DIMBLK1 and DIMBLK2

◆ setDimscale()

virtual void OdDbLeader::setDimscale ( double val )

virtual

Sets the DIMSCALE override for this object.

Parameters

val	[in] New value for DIMSCALE.

Remarks: DIMSCALE is an scale factor applied to all dimension variables that regulate sizes, offsets, and distances.

DIMSCALE serves as an overall "volume control" for dimensions and leaders.

Description 0.0 A "reasonable" value is computed for model space viewports.

0.0 If set to the inverse of the plot scale, plotted dimensions will be at the sizes specified by the other dimension variables.

◆ setDimstyleData() [1/2]

void OdDbLeader::setDimstyleData ( const OdDbDimStyleTableRecord * pDimstyle )

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

Parameters

pDimstyle	[in] Pointer to a non- database -resident dimension style record.
dimstyleID	[in] Database-resident dimension style record.

Remarks: The copied data includes the dimension style with all applicable overrides.

◆ setDimstyleData() [2/2]

void OdDbLeader::setDimstyleData ( OdDbObjectId dimstyleID )

◆ setDimtad()

virtual void OdDbLeader::setDimtad ( int val )

virtual

Sets the DIMTAD override for this object.

Parameters

val	[in] New value for DIMTAD. [0..3]

Remarks: DIMTAD specifies the dimension text vertical position.

Description 0 Centered about the dimension line. 1 Above the dimension line, unless DIMTIH==1 and the dimension line is not horizontal. 2 Side of the dimension line farthest from the defining points. 3 JIS standard.

◆ setDimtxsty()

virtual void OdDbLeader::setDimtxsty ( OdDbObjectId val )

virtual

Sets the DIMTXSTY override for this object.

Parameters

val	[in] New value for DIMTXSTY.

Remarks: DIMTXSTY specifies the text style of the dimension text.

◆ setDimtxt()

virtual void OdDbLeader::setDimtxt ( double val )

virtual

Sets the DIMTXT override for this object.

Parameters

val	[in] New value for DIMTXT.

Remarks: DIMTXT specifies size of the dimension text.

◆ setPlane()

virtual void OdDbLeader::setPlane ( const OdGePlane & leaderPlane )

virtual

Sets the plane to contain this Leader entity.

Parameters

leaderPlane [in] Leader plane.

Remarks: Any associativity of this Leader entity will be broken.

◆ setToSplineLeader()

virtual void OdDbLeader::setToSplineLeader ( )

virtual

Sets this Leader entity to use a spline-fit leader line (DXF 72).

◆ setToStraightLeader()

virtual void OdDbLeader::setToStraightLeader ( )

virtual

Sets this Leader to use a straight line segments (DXF 72).

◆ setVertexAt()

virtual bool OdDbLeader::setVertexAt	(	int	vertexIndex,
		const OdGePoint3d &	vertex
	)

virtual

Sets the specified WCS vertex of this Leader entity.

Parameters

vertexIndex	[in] Vertex index.
vertex	[in] WCS value for the vertex.

Returns: Returns true if and only if the vertex was set.

◆ subClose()

virtual void OdDbLeader::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 OdDbLeader::subExplode ( OdRxObjectPtrArray & entitySet ) const

virtual

Reimplemented from OdDbEntity.

◆ subGetClassID()

virtual OdResult OdDbLeader::subGetClassID ( void * pClsid ) const

virtual

Reimplemented from OdDbEntity.

◆ subGetGsMarkersAtSubentPath()

OdResult OdDbLeader::subGetGsMarkersAtSubentPath	(	const OdDbFullSubentPath &	subPath,
		OdGsMarkerArray &	gsMarkers
	)		const

virtual

Reimplemented from OdDbEntity.

◆ subGetSubentPathsAtGsMarker()

OdResult OdDbLeader::subGetSubentPathsAtGsMarker	(	OdDb::SubentType	type,
		OdGsMarker	gsMark,
		const OdGePoint3d &	,
		const OdGeMatrix3d &	,
		OdDbFullSubentPathArray &	subentPaths,
		const OdDbObjectIdArray *	pEntAndInsertStack
	)		const

virtual

Reimplemented from OdDbEntity.

◆ subGetTransformedCopy()

virtual OdResult OdDbLeader::subGetTransformedCopy	(	const OdGeMatrix3d &	xform,
		OdDbEntityPtr &	pEnt
	)		const

virtual

Reimplemented from OdDbEntity.

◆ subSetAttributes()

virtual OdUInt32 OdDbLeader::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 OdDbLeader::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 OdDbLeader::subTransformBy ( const OdGeMatrix3d & xfm )

virtual

Reimplemented from OdDbEntity.

◆ subViewportDraw()

ODRX_SEALED_VIRTUAL void OdDbLeader::subViewportDraw ( OdGiViewportDraw * pVd ) const

virtual

Reimplemented from OdDbEntity.

◆ subWorldDraw()

virtual bool OdDbLeader::subWorldDraw ( OdGiWorldDraw * pWd ) const

virtual

Reimplemented from OdDbEntity.

◆ TD_USING() [1/2]

OdDbLeader::TD_USING ( OdDbCurve::getFirstDeriv )

◆ TD_USING() [2/2]

OdDbLeader::TD_USING ( OdDbCurve::getSecondDeriv )

◆ vertexAt()

virtual OdGePoint3d OdDbLeader::vertexAt ( int vertexIndex ) const

virtual

Returns the specified WCS vertex of this Leader entity.

Parameters

vertexIndex [in] Vertex index.

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

DbLeader.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AnnoType

◆ gsMarkType

Constructor & Destructor Documentation

◆ OdDbLeader()

Member Function Documentation

◆ annoHeight()

◆ annotationObjId()

◆ annotationOffset()

◆ annotationXDir()

◆ annoType()

◆ annoWidth()

◆ appendVertex()

◆ attachAnnotation() [1/2]

◆ attachAnnotation() [2/2]

◆ detachAnnotation()

◆ dimasz()

◆ dimclrd()

◆ dimensionStyle()

◆ dimgap()

◆ dimldrblk()

◆ dimlwd()

◆ dimsah()

◆ dimscale()

◆ dimtad()

◆ dimtxsty()

◆ dimtxt()

◆ disableArrowHead()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ enableArrowHead()

◆ erased()

◆ evaluateLeader()

◆ firstVertex()

◆ getArea()

◆ getDimstyleData()

◆ getDistAtParam()

◆ getEndParam()

◆ getEndPoint()

◆ getFirstDeriv()

◆ getParamAtDist()

◆ getParamAtPoint()

◆ getPlane()

◆ getPointAtParam()

◆ getSecondDeriv()

◆ getStartParam()

◆ getStartPoint()

◆ hasArrowHead()

◆ hasHookLine()

◆ isArrowHeadEnabled()

◆ isClosed()

◆ isHookLineOnXDir()

◆ isPeriodic()

◆ isPlanar()

◆ isSplined()

◆ lastVertex()

◆ modifiedGraphics()

◆ normal()

◆ numVertices()

◆ ODDB_DECLARE_MEMBERS()

◆ removeLastVertex()

◆ setAnnotationOffset()

◆ setDimasz()

◆ setDimclrd()

◆ setDimensionStyle()

◆ setDimgap()

◆ setDimldrblk() [1/2]

◆ setDimldrblk() [2/2]

◆ setDimlwd()

◆ setDimsah()

◆ setDimscale()

◆ setDimstyleData() [1/2]

◆ setDimstyleData() [2/2]

◆ setDimtad()