#include <DbMLeaderStyle.h>

Inheritance diagram for OdDbMLeaderStyle:

Public Types
enum	ContentType { kNoneContent = 0 , kBlockContent = 1 , kMTextContent = 2 , kToleranceContent = 3 }

enum	DrawMLeaderOrderType { kDrawContentFirst = 0 , kDrawLeaderFirst = 1 }

enum	DrawLeaderOrderType { kDrawLeaderHeadFirst = 0 , kDrawLeaderTailFirst = 1 }

enum	LeaderType { kInVisibleLeader = 0 , kStraightLeader = 1 , kSplineLeader = 2 }

enum	TextAttachmentDirection { kAttachmentHorizontal = 0 , kAttachmentVertical = 1 }

enum	TextAttachmentType { kAttachmentTopOfTop = 0 , kAttachmentMiddleOfTop = 1 , kAttachmentMiddle = 2 , kAttachmentMiddleOfBottom = 3 , kAttachmentBottomOfBottom = 4 , kAttachmentBottomLine = 5 , kAttachmentBottomOfTopLine = 6 , kAttachmentBottomOfTop = 7 , kAttachmentAllLine = 8 , kAttachmentCenter = 9 , kAttachmentLinedCenter = 10 }

enum	TextAngleType { kInsertAngle = 0 , kHorizontalAngle = 1 , kAlwaysRightReadingAngle = 2 }

enum	TextAlignmentType { kLeftAlignment = 0 , kCenterAlignment = 1 , kRightAlignment = 2 }

enum	BlockConnectionType { kConnectExtents = 0 , kConnectBase = 1 }

enum	LeaderDirectionType { kUnknownLeader = 0 , kLeftLeader = 1 , kRightLeader = 2 , kTopLeader = 3 , kBottomLeader = 4 }

enum	SegmentAngleType { kAny = 0 , k15 = 1 , k30 = 2 , k45 = 3 , k60 = 4 , k90 = 6 , kHorz = 12 }

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 (OdDbMLeaderStyle)

	OdDbMLeaderStyle ()

void	setDatabaseDefaults (OdDbDatabase *pDb)

virtual OdString	getName () const

virtual void	setName (const OdString &name)

virtual OdString	description () const

virtual void	setDescription (const OdString &description)

virtual OdUInt32	bitFlags () const

virtual void	setBitFlags (OdUInt32 flags)

void	setContentType (ContentType contentType)

ContentType	contentType () const

void	setDrawMLeaderOrderType (DrawMLeaderOrderType drawMLeaderOrderType)

DrawMLeaderOrderType	drawMLeaderOrderType () const

void	setDrawLeaderOrderType (DrawLeaderOrderType drawLeaderOrderType)

DrawLeaderOrderType	drawLeaderOrderType () const

void	setMaxLeaderSegmentsPoints (int maxLeaderSegmentsPoints)

int	maxLeaderSegmentsPoints () const

void	setFirstSegmentAngleConstraint (SegmentAngleType angle)

SegmentAngleType	firstSegmentAngleConstraint () const

void	setSecondSegmentAngleConstraint (SegmentAngleType angle)

SegmentAngleType	secondSegmentAngleConstraint () const

void	setLeaderLineType (LeaderType leaderLineType)

LeaderType	leaderLineType () const

void	setLeaderLineColor (const OdCmColor &leaderLineColor)

OdCmColor	leaderLineColor () const

void	setLeaderLineTypeId (OdDbObjectId leaderLineTypeId)

OdDbObjectId	leaderLineTypeId () const

void	setLeaderLineWeight (OdDb::LineWeight leaderLineWeight)

OdDb::LineWeight	leaderLineWeight () const

void	setEnableLanding (bool enableLanding)

bool	enableLanding () const

void	setLandingGap (double landingGap)

double	landingGap () const

void	setEnableDogleg (bool enableDogleg)

bool	enableDogleg () const

void	setDoglegLength (double doglegLength)

double	doglegLength () const

void	setArrowSymbolId (const OdString &name)

void	setArrowSymbolId (OdDbObjectId arrowSymbolId)

OdDbObjectId	arrowSymbolId () const

void	setArrowSize (double arrowSize)

double	arrowSize () const

void	setDefaultMText (const OdDbMTextPtr defaultMText)

OdDbMTextPtr	defaultMText () const

void	setTextStyleId (OdDbObjectId textStyleId)

OdDbObjectId	textStyleId () const

void	setTextAttachmentType (TextAttachmentType textAttachmentType, LeaderDirectionType leaderDirection)

TextAttachmentType	textAttachmentType (LeaderDirectionType leaderDirection) const

void	setTextAngleType (TextAngleType textAngleType)

TextAngleType	textAngleType () const

void	setTextAlignmentType (TextAlignmentType textAlignmentType)

TextAlignmentType	textAlignmentType () const

void	setTextAlignAlwaysLeft (bool bAlwaysLeft)

bool	textAlignAlwaysLeft () const

void	setTextColor (const OdCmColor &textColor)

OdCmColor	textColor () const

void	setTextHeight (double textHeight)

double	textHeight () const

void	setEnableFrameText (bool enableFrameText)

bool	enableFrameText () const

void	setAlignSpace (double alignSpace)

double	alignSpace () const

void	setBlockId (const OdString &name)

void	setBlockId (OdDbObjectId blockId)

OdDbObjectId	blockId () const

void	setBlockColor (const OdCmColor &blockColor)

OdCmColor	blockColor () const

void	setBlockScale (const OdGeScale3d &scale)

OdGeScale3d	blockScale () const

void	setEnableBlockScale (bool enableBlockScale)

bool	enableBlockScale () const

void	setBlockRotation (double rotation)

double	blockRotation () const

void	setEnableBlockRotation (bool enableBlockRotation)

bool	enableBlockRotation () const

void	setBlockConnectionType (BlockConnectionType blockConnectionType)

BlockConnectionType	blockConnectionType () const

void	setScale (double scale)

double	scale () const

bool	overwritePropChanged () const

OdDbObjectId	postMLeaderStyleToDb (OdDbDatabase *pDb, const OdString &styleName)

void	setAnnotative (bool isAnnotative)

bool	annotative () const

void	setBreakSize (double size)

double	breakSize () const

void	setTextAttachmentDirection (TextAttachmentDirection direction)

TextAttachmentDirection	textAttachmentDirection () const

void	setExtendLeaderToText (bool bSet)

bool	extendLeaderToText () const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual void	subClose ()

OdResult	subGetClassID (void *pClsid) 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)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

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 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 ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

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

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)

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	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)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

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 OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

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

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

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 OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

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

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

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 MLeader Style objects in an OdDbDatabase instance.

See also: TD_Db

OdDbMLeaderStyle objects are stored in the ACAD_MLEADERSTYLE dictionary in the Named Object Dictionary of an OdDbDatabase. <group OdDb_Classes>

Definition at line 48 of file DbMLeaderStyle.h.

Member Enumeration Documentation

◆ BlockConnectionType

enum OdDbMLeaderStyle::BlockConnectionType

Enumeration for the block connection type of MLeader block content.

Enumerator
kConnectExtents	MLeader should connect to the extents of the block.
kConnectBase	MLeader should connect to the base point of the block.

Definition at line 244 of file DbMLeaderStyle.h.

◆ ContentType

enum OdDbMLeaderStyle::ContentType

Enumeration for the content type of an MLeader.

Enumerator
kNoneContent	The MLeader has no content.
kBlockContent	The MLeader has block content.
kMTextContent	The MLeader has mtext content.
kToleranceContent	The MLeader has tolerance content.

Definition at line 54 of file DbMLeaderStyle.h.

◆ DrawLeaderOrderType

enum OdDbMLeaderStyle::DrawLeaderOrderType

Enumeration for MLeader Line draw order type.

Enumerator
kDrawLeaderHeadFirst	MLeader leaderline head should be drawn first.
kDrawLeaderTailFirst	MLeader leaderline tail should be drawn first.

Definition at line 94 of file DbMLeaderStyle.h.

◆ DrawMLeaderOrderType

enum OdDbMLeaderStyle::DrawMLeaderOrderType

Enumeration for the draw order type of an MLeader.

Enumerator
kDrawContentFirst	MLeader content should be drawn first.
kDrawLeaderFirst	MLeader leaderline should be drawn first.

Definition at line 79 of file DbMLeaderStyle.h.

◆ LeaderDirectionType

enum OdDbMLeaderStyle::LeaderDirectionType

Enumeration for the direction type of an MLeader.

Enumerator
kUnknownLeader	Unknown direction type.
kLeftLeader	Direction type of left.
kRightLeader	Direction type of right.
kTopLeader	Direction type of top.
kBottomLeader	Direction type of bottom.

Definition at line 259 of file DbMLeaderStyle.h.

◆ LeaderType

enum OdDbMLeaderStyle::LeaderType

Enumeration for the leader type of MLeader.

Enumerator
kInVisibleLeader	Invisible leader.
kStraightLeader	Straight line leader.
kSplineLeader	Spline leader.

Definition at line 109 of file DbMLeaderStyle.h.

◆ SegmentAngleType

enum OdDbMLeaderStyle::SegmentAngleType

Enumeration for the segment angle type of an MLeader.

Enumerator
kAny	Any.
k15	Angle of 15 degrees.
k30	Angle of 30 degrees.
k45	Angle of 45 degrees.
k60	Angle of 60 degrees.
k90	Angle of 90 degrees.
kHorz	Angle of 180 degrees.

Definition at line 290 of file DbMLeaderStyle.h.

◆ TextAlignmentType

enum OdDbMLeaderStyle::TextAlignmentType

Enumeration for MLeader text alignment type.

Enumerator
kLeftAlignment	MLeader text is left justified.
kCenterAlignment	MLeader text is center justified.
kRightAlignment	MLeader text is right justified.

Definition at line 224 of file DbMLeaderStyle.h.

◆ TextAngleType

enum OdDbMLeaderStyle::TextAngleType

Enumeration for the text angle type of MLeader text.

Enumerator
kInsertAngle	Text angle is specified according to the angle of the last leader line segment.
kHorizontalAngle	Text is unconditionally horizontal.
kAlwaysRightReadingAngle	Text angle is specified according to the angle of the last leader line segment, and text is always oriented right side up to be readable.

Definition at line 203 of file DbMLeaderStyle.h.

◆ TextAttachmentDirection

enum OdDbMLeaderStyle::TextAttachmentDirection

Enumeration for the text attachment direction of MLeader text.

Enumerator
kAttachmentHorizontal	Horizontal.
kAttachmentVertical	Vertical.

Definition at line 129 of file DbMLeaderStyle.h.

◆ TextAttachmentType

enum OdDbMLeaderStyle::TextAttachmentType

Enumeration for the text attachment type of MLeader text.

Enumerator
kAttachmentTopOfTop	Use the top of the top text line as the attachment point.
kAttachmentMiddleOfTop	Use the middle of the top text line as the attachment point.
kAttachmentMiddle	Use the middle of the text as the attachment point.
kAttachmentMiddleOfBottom	Use the middle of the bottom text line as the attachment point.
kAttachmentBottomOfBottom	Use the bottom of the bottom text line as the attachment point.
kAttachmentBottomLine	Use the bottom of bottom text line as the attachment point. Underline the bottom line.
kAttachmentBottomOfTopLine	Use the bottom of the top text line as the attachment point. Underline the top line.
kAttachmentBottomOfTop	Use the bottom of the top text line as the attachment point.
kAttachmentAllLine	Use the bottom of the top text line as the attachment point, and underline all content.
kAttachmentCenter	Use the center of the mtext as the attachment point for vertical attachment.
kAttachmentLinedCenter	Use the center of the mtext as the attachment point for vertical attachment, and overline/underline all content.

Definition at line 143 of file DbMLeaderStyle.h.

Constructor & Destructor Documentation

◆ OdDbMLeaderStyle()

OdDbMLeaderStyle::OdDbMLeaderStyle ( )

Member Function Documentation

◆ alignSpace()

double OdDbMLeaderStyle::alignSpace ( ) const

Returns the alignment space value for this OdDbMLeaderStyle.

◆ annotative()

bool OdDbMLeaderStyle::annotative ( ) const

Returns the annotative flag for this OdDbMLeaderStyle.

◆ arrowSize()

double OdDbMLeaderStyle::arrowSize ( ) const

Returns the arrow size for this OdDbMLeaderStyle.

◆ arrowSymbolId()

OdDbObjectId OdDbMLeaderStyle::arrowSymbolId ( ) const

Returns the arrow symbol for this OdDbMLeaderStyle as an OdDbObjectId.

◆ bitFlags()

virtual OdUInt32 OdDbMLeaderStyle::bitFlags ( ) const

virtual

Returns the set of bit flags this OdDbMLeaderStyle.

◆ blockColor()

OdCmColor OdDbMLeaderStyle::blockColor ( ) const

Returns the color for block content associated with this OdDbMLeaderStyle.

◆ blockConnectionType()

BlockConnectionType OdDbMLeaderStyle::blockConnectionType ( ) const

Returns the connection type for the associated block.

◆ blockId()

OdDbObjectId OdDbMLeaderStyle::blockId ( ) const

Returns the OdDbObjectId of the block associated with this OdDbMLeaderStyle.

◆ blockRotation()

double OdDbMLeaderStyle::blockRotation ( ) const

Returns the rotation value for the block referenced by this OdDbMLeaderStyle.

◆ blockScale()

OdGeScale3d OdDbMLeaderStyle::blockScale ( ) const

Returns the scale for the block associated with this by OdDbMLeaderStyle.

◆ breakSize()

double OdDbMLeaderStyle::breakSize ( ) const

Returns the gap used in the process of breaking leader lines.

◆ contentType()

ContentType OdDbMLeaderStyle::contentType ( ) const

Returns the content type for this OdDbMLeaderStyle.

◆ defaultMText()

OdDbMTextPtr OdDbMLeaderStyle::defaultMText ( ) const

Sets the default text used in an associated MText balloon.

Remarks: The returned MText object is cloned, and can be NULL if there is no default MText.

◆ description()

virtual OdString OdDbMLeaderStyle::description ( ) const

virtual

Returns the description of this OdDbMLeaderStyle.

◆ doglegLength()

double OdDbMLeaderStyle::doglegLength ( ) const

Returns the "dog leg" leader line length for this OdDbMLeaderStyle.

◆ drawLeaderOrderType()

DrawLeaderOrderType OdDbMLeaderStyle::drawLeaderOrderType ( ) const

Returns the leader line draw order for OdDbMLeader objects using this OdDbMLeaderStyle.

◆ drawMLeaderOrderType()

DrawMLeaderOrderType OdDbMLeaderStyle::drawMLeaderOrderType ( ) const

Returns the draw order for the content of OdDbMLeader objects using this OdDbMLeaderStyle.

◆ dwgInFields()

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

◆ dwgOutFields()

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

◆ dxfInFields()

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

◆ dxfOutFields()

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

◆ enableBlockRotation()

bool OdDbMLeaderStyle::enableBlockRotation ( ) const

Returns true if block rotation (set by setBlockRotation) is to be used, false otherwise.

◆ enableBlockScale()

bool OdDbMLeaderStyle::enableBlockScale ( ) const

Returns true if block scale (set by setBlockScale) is to be used, false otherwise.

◆ enableDogleg()

bool OdDbMLeaderStyle::enableDogleg ( ) const

Returns the "dog leg" flag for this OdDbMLeaderStyle, which controls dog leg leader lines.

◆ enableFrameText()

bool OdDbMLeaderStyle::enableFrameText ( ) const

Returns true if a frame is to be displayed around associated text, false otherwise.

◆ enableLanding()

bool OdDbMLeaderStyle::enableLanding ( ) const

Returns leader line landing for this OdDbMLeaderStyle.

◆ extendLeaderToText()

bool OdDbMLeaderStyle::extendLeaderToText ( ) const

Returns horizontal mleader lines extend to text mode.

◆ firstSegmentAngleConstraint()

SegmentAngleType OdDbMLeaderStyle::firstSegmentAngleConstraint ( ) const

Returns the constraint angle for the first segment (used for creating OdDbMLeader objects).

Remarks: A return value of kAny indicates that no constraint is used.

◆ getName()

virtual OdString OdDbMLeaderStyle::getName ( ) const

virtual

Returns the name of this OdDbMLeaderStyle.

◆ landingGap()

double OdDbMLeaderStyle::landingGap ( ) const

Returns the gap between the leader line tail and the MText associated with the OdDbMLeader.

◆ leaderLineColor()

OdCmColor OdDbMLeaderStyle::leaderLineColor ( ) const

Returns the leader line color for this OdDbMLeaderStyle.

◆ leaderLineType()

LeaderType OdDbMLeaderStyle::leaderLineType ( ) const

Returns the leader line type for this OdDbMLeaderStyle.

◆ leaderLineTypeId()

OdDbObjectId OdDbMLeaderStyle::leaderLineTypeId ( ) const

Returns the leader line linetype for this OdDbMLeaderStyle.

◆ leaderLineWeight()

OdDb::LineWeight OdDbMLeaderStyle::leaderLineWeight ( ) const

Returns the leader line lineweight for this OdDbMLeaderStyle.

◆ maxLeaderSegmentsPoints()

int OdDbMLeaderStyle::maxLeaderSegmentsPoints ( ) const

Returns the maximun number of segment points used for leader lines.

◆ ODDB_DECLARE_MEMBERS()

OdDbMLeaderStyle::ODDB_DECLARE_MEMBERS ( OdDbMLeaderStyle )

◆ overwritePropChanged()

bool OdDbMLeaderStyle::overwritePropChanged ( ) const

Returns true if properties were modified, false otherwise.

◆ postMLeaderStyleToDb()

OdDbObjectId OdDbMLeaderStyle::postMLeaderStyleToDb	(	OdDbDatabase *	pDb,
		const OdString &	styleName
	)

Add this OdDbMLeaderStyle to the specified OdDbDatabase object.

Parameters

pDb	[in] Pointer of the database which will receive the OdDbMLeaderStyle object.
styleName	[in] Name of the style.

Returns: Returns the OdDbObjectID of the newly added OdDbMLeaderStyle object.

◆ scale()

double OdDbMLeaderStyle::scale ( ) const

Returns the scale factor for this OdDbMLeaderStyle.

◆ secondSegmentAngleConstraint()

SegmentAngleType OdDbMLeaderStyle::secondSegmentAngleConstraint ( ) const

Sets the constraint angle for the second segment (used for creating OdDbMLeader objects).

Remarks: A return value of kAny indicates that no constraint is used.

◆ setAlignSpace()

void OdDbMLeaderStyle::setAlignSpace ( double alignSpace )

Sets the alignment space value for this OdDbMLeaderStyle.

Parameters

alignSpace [in] The alignment space value.

◆ setAnnotative()

void OdDbMLeaderStyle::setAnnotative ( bool isAnnotative )

Sets the annotative flag for this OdDbMLeaderStyle.

Parameters

isAnnotative [in] The annotative status.

◆ setArrowSize()

void OdDbMLeaderStyle::setArrowSize ( double arrowSize )

Sets the arrow size for this OdDbMLeaderStyle.

Parameters

arrowSize [in] The arrow size.

◆ setArrowSymbolId() [1/2]

void OdDbMLeaderStyle::setArrowSymbolId ( const OdString & name )

Sets the arrow symbol for this OdDbMLeaderStyle by name.

Parameters

name	[in] Name of the arrow symbol.

◆ setArrowSymbolId() [2/2]

void OdDbMLeaderStyle::setArrowSymbolId ( OdDbObjectId arrowSymbolId )

Sets the arrow symbol for this OdDbMLeaderStyle by OdDbObjectId.

Parameters

arrowSymbolId [in] OdDbObjectId of the arrow symbol.

◆ setBitFlags()

virtual void OdDbMLeaderStyle::setBitFlags ( OdUInt32 flags )

virtual

Sets the bit flags for this OdDbMLeaderStyle.

Parameters

flags [in] The bit flags for this OdDbMLeaderStyle.

◆ setBlockColor()

void OdDbMLeaderStyle::setBlockColor ( const OdCmColor & blockColor )

Sets the color for block content associated with this OdDbMLeaderStyle.

Parameters

blockColor [in] The color for block content.

◆ setBlockConnectionType()

void OdDbMLeaderStyle::setBlockConnectionType ( BlockConnectionType blockConnectionType )

Sets the connection type for the associated block.

Parameters

blockConnectionType [in] The connection type.

◆ setBlockId() [1/2]

void OdDbMLeaderStyle::setBlockId ( const OdString & name )

Sets the block to be associated with this OdDbMLeaderStyle by name.

Parameters

name	[in] The name of the standard block.

◆ setBlockId() [2/2]

void OdDbMLeaderStyle::setBlockId ( OdDbObjectId blockId )

Sets the block to be associated with this OdDbMLeaderStyle by OdDbObjectId.

Parameters

blockId [in] OdDbObjectId of the OdDbBlockTableRecord associated with this OdDbMLeaderStyle.

◆ setBlockRotation()

void OdDbMLeaderStyle::setBlockRotation ( double rotation )

Sets the rotation value for the block referenced by this OdDbMLeaderStyle.

Parameters

rotation [in] The rotation value.

◆ setBlockScale()

void OdDbMLeaderStyle::setBlockScale ( const OdGeScale3d & scale )

Sets the scale for the block associated with this by OdDbMLeaderStyle.

Parameters

scale [in] The block scale.

◆ setBreakSize()

void OdDbMLeaderStyle::setBreakSize ( double size )

Sets the gap used in the process of breaking leader lines.

Parameters

size	[in] The gap used in the process of breaking leader lines.

◆ setContentType()

void OdDbMLeaderStyle::setContentType ( ContentType contentType )

Sets the content type for this OdDbMLeaderStyle.

Parameters

contentType [in] The content type.

◆ setDatabaseDefaults()

void OdDbMLeaderStyle::setDatabaseDefaults ( OdDbDatabase * pDb )

◆ setDefaultMText()

void OdDbMLeaderStyle::setDefaultMText ( const OdDbMTextPtr defaultMText )

Sets the default text used in an associated MText balloon.

Parameters

defaultMText [in] The default text used in an associated MText balloon.

◆ setDescription()

virtual void OdDbMLeaderStyle::setDescription ( const OdString & description )

virtual

Sets the description of this OdDbMLeaderStyle.

Parameters

description [in] OdDbMLeaderStyle description string.

◆ setDoglegLength()

void OdDbMLeaderStyle::setDoglegLength ( double doglegLength )

Sets the "dog leg" leader line length for this OdDbMLeaderStyle.

Parameters

doglegLength [in] The "dog leg" leader line length.

◆ setDrawLeaderOrderType()

void OdDbMLeaderStyle::setDrawLeaderOrderType ( DrawLeaderOrderType drawLeaderOrderType )

Sets the leader line draw order for OdDbMLeader objects using this OdDbMLeaderStyle.

Parameters

drawLeaderOrderType [in] The Leader line draw order.

◆ setDrawMLeaderOrderType()

void OdDbMLeaderStyle::setDrawMLeaderOrderType ( DrawMLeaderOrderType drawMLeaderOrderType )

Sets the draw order for the content of OdDbMLeader objects using this OdDbMLeaderStyle.

Parameters

drawMLeaderOrderType [in] Draw order type for MLeader content.

◆ setEnableBlockRotation()

void OdDbMLeaderStyle::setEnableBlockRotation ( bool enableBlockRotation )

Enables/disables usage of the rotation value set by setBlockRotation().

Parameters

enableBlockRotation [in] true if block rotation is to be used, false otherwise.

◆ setEnableBlockScale()

void OdDbMLeaderStyle::setEnableBlockScale ( bool enableBlockScale )

Enables/disables usage of the scale value set by setBlockScale().

Parameters

enableBlockScale [in] true if block scale is to be used, false otherwise.

◆ setEnableDogleg()

void OdDbMLeaderStyle::setEnableDogleg ( bool enableDogleg )

Sets the "dog leg" flag for this OdDbMLeaderStyle, which controls dog leg leader lines.

Parameters

enableDogleg [in] "Dog leg" flag.

◆ setEnableFrameText()

void OdDbMLeaderStyle::setEnableFrameText ( bool enableFrameText )

Sets the display/hide property for the frame around associated text.

Parameters

enableFrameText [in] True if a frame is to be displayed around associated text, false otherwise.

◆ setEnableLanding()

void OdDbMLeaderStyle::setEnableLanding ( bool enableLanding )

Sets the leader line landing for this OdDbMLeaderStyle.

Parameters

enableLanding [in] The leader line landing.

Remarks: If landing is disabled, landing gap is ignored.

◆ setExtendLeaderToText()

void OdDbMLeaderStyle::setExtendLeaderToText ( bool bSet )

Sets horizontal mleader lines extend to text mode.

Parameters

bSet	[in] Extend to text mode status.

◆ setFirstSegmentAngleConstraint()

void OdDbMLeaderStyle::setFirstSegmentAngleConstraint ( SegmentAngleType angle )

Sets the constraint angle for the first segment (used for creating OdDbMLeader objects).

Parameters

angle [in] Constraint angle.

Remarks: A value of kAny for "angle" indicates that no constraint is used.

◆ setLandingGap()

void OdDbMLeaderStyle::setLandingGap ( double landingGap )

Sets the gap between the leader line tail and the MText associated with the OdDbMLeader.

Parameters

landingGap [in] The gap between the leader line tail and the MText associated with the OdDbMLeader.

◆ setLeaderLineColor()

void OdDbMLeaderStyle::setLeaderLineColor ( const OdCmColor & leaderLineColor )

Set the leader line color for this OdDbMLeaderStyle.

Parameters

leaderLineColor [in] The leader line color.

◆ setLeaderLineType()

void OdDbMLeaderStyle::setLeaderLineType ( LeaderType leaderLineType )

Sets the leader line type for this OdDbMLeaderStyle.

Parameters

leaderLineType [in] The leader line type.

◆ setLeaderLineTypeId()

void OdDbMLeaderStyle::setLeaderLineTypeId ( OdDbObjectId leaderLineTypeId )

Sets the leader line linetype for this OdDbMLeaderStyle.

Parameters

leaderLineTypeId [in] The linetype Id.

◆ setLeaderLineWeight()

void OdDbMLeaderStyle::setLeaderLineWeight ( OdDb::LineWeight leaderLineWeight )

Sets the leader line lineweight for this OdDbMLeaderStyle.

Parameters

leaderLineWeight [in] The leader line lineweight.

◆ setMaxLeaderSegmentsPoints()

void OdDbMLeaderStyle::setMaxLeaderSegmentsPoints ( int maxLeaderSegmentsPoints )

Sets the maximun number of segment points used for leader lines.

Parameters

maxLeaderSegmentsPoints [in] The maximum number of segment points.

Remarks: A value of 0 for maxLeaderSegmentsPoints indicates no limit.

◆ setName()

virtual void OdDbMLeaderStyle::setName ( const OdString & name )

virtual

Sets the name of this OdDbMLeaderStyle.

Parameters

name	[in] Holds the name of OdDbMLeaderStyle.

◆ setScale()

void OdDbMLeaderStyle::setScale ( double scale )

Sets the scale factor for this OdDbMLeaderStyle.

Parameters

scale [in] Scale factor.

◆ setSecondSegmentAngleConstraint()

void OdDbMLeaderStyle::setSecondSegmentAngleConstraint ( SegmentAngleType angle )

Sets the constraint angle for the second segment (used for creating OdDbMLeader objects).

Parameters

angle [in] Constraint angle.

Remarks: A value of kAny for "angle" indicates that no constraint is used.

◆ setTextAlignAlwaysLeft()

void OdDbMLeaderStyle::setTextAlignAlwaysLeft ( bool bAlwaysLeft )

Sets the "always create left aligned text" property for this OdDbMLeaderStyle.

Parameters

bAlwaysLeft [in] If true, text will be left aligned for newly created OdDbMLeader objects.

◆ setTextAlignmentType()

void OdDbMLeaderStyle::setTextAlignmentType ( TextAlignmentType textAlignmentType )

Sets the text alignment type for this OdDbMLeaderStyle.

Parameters

textAlignmentType [in] The text alignment type.

◆ setTextAngleType()

void OdDbMLeaderStyle::setTextAngleType ( TextAngleType textAngleType )

Sets the text angle type for this OdDbMLeaderStyle.

Parameters

textAngleType [in] The text angle type.

◆ setTextAttachmentDirection()

void OdDbMLeaderStyle::setTextAttachmentDirection ( TextAttachmentDirection direction )

Sets the text attachment direction of MText.

Parameters

direction [in] The text attachment direction of MText.

◆ setTextAttachmentType()

void OdDbMLeaderStyle::setTextAttachmentType	(	TextAttachmentType	textAttachmentType,
		LeaderDirectionType	leaderDirection
	)

Sets the text attachment type for this OdDbMLeaderStyle.

Parameters

textAttachmentType	[in] The text attachment type.
leaderDirection	[in] The leader direction type.

◆ setTextColor()

void OdDbMLeaderStyle::setTextColor ( const OdCmColor & textColor )

Sets the text color for this OdDbMLeaderStyle.

Parameters

textColor [in] The text color used for associated OdDbMText object.

◆ setTextHeight()

void OdDbMLeaderStyle::setTextHeight ( double textHeight )

Sets the text height for the associated OdDbMText object.

Parameters

textHeight [in] The text height.

◆ setTextStyleId()

void OdDbMLeaderStyle::setTextStyleId ( OdDbObjectId textStyleId )

Sets the text style for this OdDbMLeaderStyle by OdDbObjectId.

Parameters

textStyleId [in] The text style.

◆ subClose()

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

◆ subGetClassID()

OdResult OdDbMLeaderStyle::subGetClassID ( void * pClsid ) const

virtual

Reimplemented from OdDbObject.

◆ textAlignAlwaysLeft()

bool OdDbMLeaderStyle::textAlignAlwaysLeft ( ) const

Returns the "always create left aligned text" property for this OdDbMLeaderStyle.

◆ textAlignmentType()

TextAlignmentType OdDbMLeaderStyle::textAlignmentType ( ) const

Returns the text alignment type for this OdDbMLeaderStyle.

◆ textAngleType()

TextAngleType OdDbMLeaderStyle::textAngleType ( ) const

Returns the text angle type for this OdDbMLeaderStyle.

◆ textAttachmentDirection()

TextAttachmentDirection OdDbMLeaderStyle::textAttachmentDirection ( ) const

Returns the text attachment direction of MText.

◆ textAttachmentType()

TextAttachmentType OdDbMLeaderStyle::textAttachmentType ( LeaderDirectionType leaderDirection ) const

Returns the text attachment type for this OdDbMLeaderStyle.

Parameters

leaderDirection [in] The leader direction type.

Returns: Returns the text attachment type.

◆ textColor()

OdCmColor OdDbMLeaderStyle::textColor ( ) const

Returns the text color for this OdDbMLeaderStyle.

◆ textHeight()

double OdDbMLeaderStyle::textHeight ( ) const

Returns the text height for the associated OdDbMText object.

◆ textStyleId()

OdDbObjectId OdDbMLeaderStyle::textStyleId ( ) const

Returns the text style OdDbObjectId for this OdDbMLeaderStyle.

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

DbMLeaderStyle.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BlockConnectionType

◆ ContentType

◆ DrawLeaderOrderType

◆ DrawMLeaderOrderType

◆ LeaderDirectionType

◆ LeaderType

◆ SegmentAngleType

◆ TextAlignmentType

◆ TextAngleType

◆ TextAttachmentDirection

◆ TextAttachmentType

Constructor & Destructor Documentation

◆ OdDbMLeaderStyle()

Member Function Documentation

◆ alignSpace()

◆ annotative()

◆ arrowSize()

◆ arrowSymbolId()

◆ bitFlags()

◆ blockColor()

◆ blockConnectionType()

◆ blockId()

◆ blockRotation()

◆ blockScale()

◆ breakSize()

◆ contentType()

◆ defaultMText()

◆ description()

◆ doglegLength()

◆ drawLeaderOrderType()

◆ drawMLeaderOrderType()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfOutFields()

◆ enableBlockRotation()

◆ enableBlockScale()

◆ enableDogleg()

◆ enableFrameText()

◆ enableLanding()

◆ extendLeaderToText()

◆ firstSegmentAngleConstraint()

◆ getName()

◆ landingGap()

◆ leaderLineColor()

◆ leaderLineType()

◆ leaderLineTypeId()

◆ leaderLineWeight()

◆ maxLeaderSegmentsPoints()

◆ ODDB_DECLARE_MEMBERS()

◆ overwritePropChanged()

◆ postMLeaderStyleToDb()

◆ scale()

◆ secondSegmentAngleConstraint()

◆ setAlignSpace()

◆ setAnnotative()

◆ setArrowSize()

◆ setArrowSymbolId() [1/2]

◆ setArrowSymbolId() [2/2]

◆ setBitFlags()

◆ setBlockColor()

◆ setBlockConnectionType()

◆ setBlockId() [1/2]

◆ setBlockId() [2/2]

◆ setBlockRotation()

◆ setBlockScale()

◆ setBreakSize()

◆ setContentType()

◆ setDatabaseDefaults()

◆ setDefaultMText()

◆ setDescription()

◆ setDoglegLength()

◆ setDrawLeaderOrderType()

◆ setDrawMLeaderOrderType()

◆ setEnableBlockRotation()