OdDgDimension Class

Class Hierarchy

Syntax

C++

class OdDgDimension : public OdDgGraphicsElement;

File

DgDimension.h

Description

This class is a base class for the different tool types available.

Remarks

The tool types each have a overridable worldDraw implementation, but generally draw the same way.

The tool type information stores what type of tool was used to generate the dimension style/settings.

Each tool class makes some assumptions about the settings, but all settings are available. Each subclass of the OdDgDimension represents a Microstation Dimensioning tool, and the creation of the dimension is controlled by this tool through assumptions about the settings. The tools' creation of the dimension is customizable, but should mimick the Microstation tools.

Therefore, the behaviour of each tool's class is customizable, although the settings set by a tool should mimick the settings and behaviours of the Microstation tools, resulting in a final predictable rendering by the worldDraw method.

Ultimately, all dimensions are drawn according to the settings stored to the file, whether stored in a DimStyle in the table, through an ID, or in the settings of the dimension class, and its member settings classes.

Corresponding C++ library: TG_Db

Group

OdDg Classes

OdDgDimension Enumerations

	Name	Description
	PlacementAlignment	Alignment behavior of the Tool. This does not set the rotation. This is a behavior for a tool to mimick.
	TerminatorArrowHeadType	Arrow head type applies to arrowheads (kOpened and kClosed and kFilled) and circles (kFilled or not).
	TerminatorOrientation	Terminators may be automatically placed (kAutomatic) by the tool and worldDraw method, or set statically to one of the three types (kOutside, kInside, kReversed).
	ToolType	This indicates which tool was used during the creation of the dimension, and therefore may lead to assumptions about settings/style.

OdDgDimension Methods

	Name	Description
	addPoint	Appends a single instance of OdDgDimPoint to the list.
	applyDimensionStyle	Initialize dimension properties by dimension style.
	breakAssociation	Break dimension association.
	clone	This is clone, a member of class OdDgDimension.
	dimensionType	This retrieves the enumeration value indicating which tool was used during the creation of the dimension, and therefore may lead to assumptions about settings/style.
	getAlignment	This is getAlignment, a member of class OdDgDimension.
	getAlignmentView	Retrieves the View number (OdUInt32) to which the PlacementAlignment applies, when set to kPaView mode. Only used in kPaView mode by a tool which has been overridden to make use of this property.
	getAltColorIndex	Retrieves the OdUInt32 value as an Alternate Color Index value.
	getAltLineStyleEntryId	Retrieves the OdInt32 value as an Alternate Line Style Entry Id. Lookup from Line Style Table.
	getAltLineWeight	Retrieves the OdUInt32 value as an Alternate Line Weight value.
	getAnnotationScale	Retrieves the Annotation Scale Factor of this dimension.
	getAnnotationScaleFlag	Return true if dimension uses annotation scale.
	getArrowHead	This is getArrowHead, a member of class OdDgDimension.
	getBoxTextFlag	Method to get/set the Box text frame flag.
	getCapsuleTextFlag	Method to get/set the Capsule text frame flag.
	getCentesimalFlag	Method to get/set the Centesimal flag.
	getCrossCenterFlag	Method to get/set the CrossCenter flag.
	getDimensionStyleEntryId	Get dimension style table record id for dimension
	getDimensionType	This retrieves the enumeration value indicating which tool type was used during the creation of the dimension, and therefore may lead to assumptions about settings/style.
	getDimExtClockwiseAngleFlag	Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether angle of angular or arc dimension clockwise or anticlockwise.
	getDimExtNoLineThruArrowTermFlag	Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through arrow terminator.
	getDimExtNoLineThruDotTermFlag	Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through dot terminator.
	getDimExtNoLineThruOriginTermFlag	Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through origin terminator.
	getDimExtNoLineThruStrokeTermFlag	Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through stroke terminator.
	getDimGeometry	Retrieves the settings class OdDgDimGeometry for this OdDgDimension.
	getDimTextFormat	Retrieves the settings class OdDgDimTextFormat for this OdDgDimension.
	getDimTextInfo	Retrieves the settings class OdDgDimTextInfo for this OdDgDimension.
	getDualFlag	Method to get/set the Dual flag.
	getEmbedFlag	Method to get/set the Embed flag.
	getExtendedFlags	Accessor method to get all included extended flags as single unsigned integer (16bit).
	getFitOptions	Retrieves the Fit Options of this dimension for automatic terminator orientation.
	getFlags	Accessor method to get all included flags as single unsigned integer (32bit).
	getHorizontalFlag	Method to get/set the Horizontal flag.
	getInlineTextLift	Retrieves the lift for dimension with inline text.
	getJoinerFlag	Method to get/set the Joiner flag, indicating whether the inner line is created if the text is moved outside (to reversed mode).
	getLeadingZero2Flag	Method to get/set the LeadingZero2 flag, indicating whether to leave the leading zero on a decimal value less than one, for the second label.
	getLeadingZerosFlag	Method to get/set the LeadingZeros flag, indicating whether to allow the leading zero to show on a decimal value less than 1.
	getLSDDimensionFontFlag	Retrieves type of LSD font flag. ( Special font or Dimension font )
	getNoAutoTextLiftFlag	Method to get/set the NoAutoTextLift flag.
	getNoLevelSymbFlag	Method to get/set the NoLevelSymb flag.
	getOption	This is getOption, a member of class OdDgDimension.
	getPoint	Retrieves a single instance of OdDgDimPoint by index from the list.
	getPointsCount	Retrieves the count of OdDgDimPoint in the list.
	getPrimaryAltFormatRetainFractionalAccuracy	Retrieves the retain fractional accuracy option for alternative format of primary unit string.
	getPrimaryRetainFractionalAccuracy	Retrieves the retain fractional accuracy option ( disable fraction simplification: if set - 8/64, otherwise 1/8 ) for primary unit string.
	getPrimaryToleranceAccuracy	Retrieves the primary tolerance accuracy if tolerance present.
	getPrimaryToleranceRetainFractionalAccuracy	Retrieves the retain fractional accuracy option for tolerance of primary unit string.
	getRelDimLineFlag	Method to get/set the RelDimLine flag.
	getRelStatFlag	Method to get/set the RelStat flag.
	getRotation	This is the overview for the getRotation method overload.
	getScaleFactor	Retrieves the Scale Factor of this dimension.
	getSecondaryAltFormatRetainFractionalAccuracy	Retrieves the retain fractional accuracy option for alternative format of secondary unit string.
	getSecondaryRetainFractionalAccuracy	Retrieves the retain fractional accuracy option for secondary unit string.
	getSecondaryToleranceAccuracy	Retrieves the secondary tolerance accuracy if tolerance present.
	getSecondaryToleranceRetainFractionalAccuracy	Retrieves the retain fractional accuracy option for tolerance of secondary unit string.
	getStackedFractionScale	Retrieves the Stacked Fraction Scale Factor of this dimension.
	getStackFractFlag	Method to get/set the StackFract flag, indicating whether to use the getStackedFractionType of the OdDgTextInfo class; whether numerator is vertically aligned over the denominator, rather than at an angle (font-dependent).
	getSuppressUnfitTerminators	Retrieves the Suppress Unfit Terminators of this dimension.
	getTermMode	This is getTermMode, a member of class OdDgDimension.
	getTextAboveOptimalFit	Retrieves the optimal fit of this dimension if text location is above.
	getTextHeapPadFlag	Method to get/set the TextHeapPad flag.
	getTextLocation	Retrieves the Text Location of this dimension.
	getTextStyleEntryId	Get text style table record entry id for dimension
	getThousandCommaFlag	Method to get/set the ThousandComma flag, indicating whether to use the separator for grouping thousands, etc. See DecimalComma flag.
	getToleranceFlag	Method to get/set the Tolerance flag.
	getTolmodeFlag	Method to get/set the Tolmode flag.
	getTrailingZeros2Flag	Method to get/set the TrailingZeros2 flag, indicating whether or not to drop the remaining zero digits to the length specified in the Accuracy parameter for the second label.
	getTrailingZerosFlag	Method to get/set the TrailingZeros flag, indicating whether or not to drop the remaining zero digits to the length specified in the Accuracy.
	getUnderlineTextFlag	Method to get/set the UnderlineText flag, indicating NTS "not to scale".
	Is3D	The dimensionality of the parent model is returned. True if 3D model.
	recomputeDimensionPoints	Recompute dimension points by association data.
	removeOption	This is removeOption, a member of class OdDgDimension.
	removePoint	Remove a single instance of OdDgDimPoint from the list.
	set3dFlag	For non-dbro elements only
	setAlignment	This is setAlignment, a member of class OdDgDimension.
	setAlignmentView	Sets the View number (OdUInt32) to which the PlacementAlignment applies, when set to kPaView mode. Only used in kPaView mode by a tool which has been overridden to make use of this property.
	setAltColorIndex	Sets the OdUInt32 value as an Alternate Color Index value.
	setAltLineStyleEntryId	Sets the OdInt32 value as an Alternate Line Style Entry Id. Lookup from Line Style Table.
	setAltLineWeight	Sets the OdUInt32 value as an Alternate Line Weight value.
	setAnnotationScale	Sets the Annotation Scale Factor of this dimension.
	setAnnotationScaleFlag	Set dimension annotation scale usage flag.
	setArrowHead	This is setArrowHead, a member of class OdDgDimension.
	setBoxTextFlag	This is setBoxTextFlag, a member of class OdDgDimension.
	setCapsuleTextFlag	This is setCapsuleTextFlag, a member of class OdDgDimension.
	setCentesimalFlag	This is setCentesimalFlag, a member of class OdDgDimension.
	setCrossCenterFlag	This is setCrossCenterFlag, a member of class OdDgDimension.
	setDimensionStyleEntryId	Set dimension style table record id for dimension
	setDimensionType	This sets the enumeration value indicating which tool type was used during the creation of the dimension, and therefore may lead to assumptions about settings/style.
	setDimExtClockwiseAngleFlag	This is setDimExtClockwiseAngleFlag, a member of class OdDgDimension.
	setDimExtNoLineThruArrowTermFlag	This is setDimExtNoLineThruArrowTermFlag, a member of class OdDgDimension.
	setDimExtNoLineThruDotTermFlag	This is setDimExtNoLineThruDotTermFlag, a member of class OdDgDimension.
	setDimExtNoLineThruOriginTermFlag	This is setDimExtNoLineThruOriginTermFlag, a member of class OdDgDimension.
	setDimExtNoLineThruStrokeTermFlag	This is setDimExtNoLineThruStrokeTermFlag, a member of class OdDgDimension.
	setDimGeometry	Sets the settings class OdDgDimGeometry for this OdDgDimension.
	setDimTextFormat	Sets the settings class OdDgDimTextFormat for this OdDgDimension.
	setDimTextInfo	Sets the settings class OdDgDimTextInfo for this OdDgDimension.
	setDualFlag	This is setDualFlag, a member of class OdDgDimension.
	setEmbedFlag	This is setEmbedFlag, a member of class OdDgDimension.
	setExtendedFlags	Accessor method to set all included flags as single unsigned integer (16bit).
	setFitOptions	Set the Fit Options of this dimension for automatic terminator orientation.
	setFlags	Accessor method to set all included flags as single unsigned integer (32bit).
	setHorizontalFlag	This is setHorizontalFlag, a member of class OdDgDimension.
	setInlineTextLift	Set the lift for dimension with inline text.
	setJoinerFlag	This is setJoinerFlag, a member of class OdDgDimension.
	setLeadingZero2Flag	This is setLeadingZero2Flag, a member of class OdDgDimension.
	setLeadingZerosFlag	This is setLeadingZerosFlag, a member of class OdDgDimension.
	setLSDDimensionFontFlag	Sets the View number (OdUInt32) to which the PlacementAlignment applies, when set to kPaView mode. Only used in kPaView mode by a tool which has been overridden to make use of this property.
	setNoAutoTextLiftFlag	This is setNoAutoTextLiftFlag, a member of class OdDgDimension.
	setNoLevelSymbFlag	This is setNoLevelSymbFlag, a member of class OdDgDimension.
	setOption	This is setOption, a member of class OdDgDimension.
	setPoint	Sets a single instance of OdDgDimPoint by index in the list. Must be allocated first. Use addPoint method, otherwise.
	setPrimaryAltFormatRetainFractionalAccuracy	Set the retain fractional accuracy option for for alternative format of primary unit string.
	setPrimaryRetainFractionalAccuracy	Set the retain fractional accuracy option for primary unit string.
	setPrimaryToleranceAccuracy	Set the primary tolerance accuracy if tolerance present.
	setPrimaryToleranceRetainFractionalAccuracy	Set the retain fractional accuracy option for for tolerance of primary unit string.
	setRelDimLineFlag	This is setRelDimLineFlag, a member of class OdDgDimension.
	setRelStatFlag	This is setRelStatFlag, a member of class OdDgDimension.
	setRotation	This is the overview for the setRotation method overload.
	setScaleFactor	Sets the Scale Factor of this dimension.
	setSecondaryAltFormatRetainFractionalAccuracy	Set the retain fractional accuracy option for alternative format of secondary unit string.
	setSecondaryRetainFractionalAccuracy	Set the retain fractional accuracy option for secondary unit string.
	setSecondaryToleranceAccuracy	Set the secondary tolerance accuracy if tolerance present.
	setSecondaryToleranceRetainFractionalAccuracy	Set the retain fractional accuracy option for tolerance of secondary unit string.
	setStackedFractionScale	Sets the Stacked Fraction Scale Factor of this dimension.
	setStackFractFlag	This is setStackFractFlag, a member of class OdDgDimension.
	setSuppressUnfitTerminators	Set the Suppress Unfit Terminators of this dimension.
	setTermMode	This is setTermMode, a member of class OdDgDimension.
	setTextAboveOptimalFit	Set the optimal fit of this dimension if text location is above.
	setTextHeapPadFlag	This is setTextHeapPadFlag, a member of class OdDgDimension.
	setTextLocation	Set the Text Location of this dimension.
	setTextStyleEntryId	Set text style table record entry id for dimension
	setThickness	This is setThickness, a member of class OdDgDimension.
	setThousandCommaFlag	This is setThousandCommaFlag, a member of class OdDgDimension.
	setToleranceFlag	This is setToleranceFlag, a member of class OdDgDimension.
	setTolmodeFlag	This is setTolmodeFlag, a member of class OdDgDimension.
	setTrailingZeros2Flag	This is setTrailingZeros2Flag, a member of class OdDgDimension.
	setTrailingZerosFlag	This is setTrailingZerosFlag, a member of class OdDgDimension.
	setUnderlineTextFlag	This is setUnderlineTextFlag, a member of class OdDgDimension.
	subExplode	This is subExplode, a member of class OdDgDimension.
	subGetGeomExtents	This is subGetGeomExtents, a member of class OdDgDimension.
	subSetAttributes	OdGiDrawable overridden
	subSetDatabaseDefaults	Called by setDatabaseDefaults() after the values are set.

Send feedback about this topic