This class is a base class for the different tool types available.
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
File: DgDimension.h
Module: API Reference
This is the overview for the OdDgElement constructor overload. | |
(Inherited from OdDgElement) |
element class: primary stands for most commonly used entities (like geometry primitives) | |
| |
All types of elements... more | |
| |
| |
Alignment behavior of the Tool. This does not set the rotation. This is a behavior for a tool to mimick. | |
Arrow head type applies to arrowheads (kOpened and kClosed and kFilled) and circles (kFilled or not). | |
Terminators may be automatically placed (kAutomatic) by the tool and worldDraw method, or set statically to one of the three types (kOutside, kInside, kReversed). | |
This indicates which tool was used during the creation of the dimension, and therefore may lead to assumptions about settings/style. |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) |
The dimensionality of the parent model is returned. True if 3D model. | |
This is the overview for the addLinkage method overload. | |
Adds the specified persistent reactor to this element's reactor list. (Inherited from OdDgElement) | |
Appends a single instance of OdDgDimPoint to the list. | |
Adds the specified transient reactor to this element's reactor list. (Inherited from OdDgElement) | |
OdRxObject overridden (Inherited from OdDgElement) | |
Adds the XAttribute with specified handler ID. (Inherited from OdDgElement) | |
This function appends this object to the specified owner object. (Inherited from OdDgElement) | |
Initialize dimension properties by dimension style. | |
(Inherited from OdDgElement) | |
Throws an exception if this object is not open OdDg::kForNotify. (Inherited from OdDgElement) | |
Throws an exception if this object is not open OdDg::kForRead. (Inherited from OdDgElement) | |
Throws an exception if this object is not open OdDg::kForWrite, and controls automatic undo and notification of modifications. (Inherited from OdDgElement) | |
Break dimension association. | |
| |
Returns the cloneMeForDragging flag for this entity. (Inherited from OdDgElement) | |
Notification function called immediately before an element is closed. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Notification function called whenever the notifying element has had its clone() member function called. (Inherited from OdDgElement) | |
Writes object references of this object during wblock clone. (Inherited from OdDgElement) | |
Copies the contents of the specified object into this object when possible. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Returns the OdDgDatabase that contains this object. (Inherited from OdDgElement) | |
Determines the behavior for custom objects when saving. (Inherited from OdDgElement) | |
Performs a deep clone of this object. (Inherited from OdDgElement) | |
Reads the DGN format data of this object from the specified file. (Inherited from OdDgElement) | |
Reads the DGN data of this object. (Inherited from OdDgElement) | |
Writes the DGN format data of this object to the specified filer. (Inherited from OdDgElement) | |
Writes the DGN data of this object. (Inherited from OdDgElement) | |
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. | |
Controls the undo recording of this object in OdDgDatabase. (Inherited from OdDgElement) | |
Downgrades this object from OdDg::kForWrite to OdDg::kForRead, and returns isReadEnabled(); (Inherited from OdDgElement) | |
Notification function called when this entity is involved in a drag operation. (Inherited from OdDgElement) | |
Returns the Object ID of this object. (Inherited from OdDgElement) | |
Sets the erased mode of this object. (Inherited from OdDgElement) | |
Notification function called whenever an element has been erased or unerased. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
| |
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. | |
Retrieves the OdUInt32 value as an Alternate Color Index value. | |
Retrieves the OdInt32 value as an Alternate Line Style Entry Id. Lookup from Line Style Table. | |
Retrieves the OdUInt32 value as an Alternate Line Weight value. | |
Retrieves the Annotation Scale Factor of this dimension. | |
Return true if dimension uses annotation scale. | |
| |
Method to get/set the Box text frame flag. | |
Method to get/set the Capsule text frame flag. | |
Method to get/set the Centesimal flag. | |
The method returns the element class property. See Class enumeration ocumentation for more details. (Inherited from OdDgGraphicsElement) | |
details This ones are similar to get/setColorIndex() but use color tables to find/create indexed colors. (Inherited from OdDgGraphicsElement) | |
Operate with color indices. See OdDg::ColorIndexConstants for some special values. See OdDgColorTable for the methods to translate indices to RGB values and back (Inherited from OdDgGraphicsElement) | |
Method to get/set the CrossCenter flag. | |
Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether angle of angular or arc dimension clockwise or anticlockwise. | |
Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through arrow terminator. | |
Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through dot terminator. | |
Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through origin terminator. | |
Method to get/set the DimExtFlgNoLineThruArrowTerm extended flag, indicating whether line is drawn through stroke terminator. | |
Retrieves the settings class OdDgDimGeometry for this OdDgDimension. | |
Retrieves the settings class OdDgDimTextFormat for this OdDgDimension. | |
Retrieves the settings class OdDgDimTextInfo for this OdDgDimension. | |
Get dimension style table record id for dimension | |
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. | |
Method to get/set the Dual flag. | |
Operate with element fills. (Inherited from OdDgGraphicsElement) | |
Returns the element subtype. (Inherited from OdDgElement) | |
Returns the element type. (Inherited from OdDgElement) | |
Method to get/set the Embed flag. | |
Accessor method to get all included extended flags as single unsigned integer (16bit). | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Retrieves the Fit Options of this dimension for automatic terminator orientation. | |
Accessor method to get all included flags as single unsigned integer (32bit). | |
Get freeze group of current dimension | |
This is the overview for the getGeomExtents method overload. | |
(Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
The method returns the entry id of the graphics group. (Inherited from OdDgGraphicsElement) | |
This is the overview for the getGripPoints method overload. | |
Operate with element hatch pattern. (Inherited from OdDgGraphicsElement) | |
The H-bit means the following:... more (Inherited from OdDgGraphicsElement) | |
Method to get/set the Horizontal flag. | |
Retrieves the lift for dimension with inline text. | |
Returns the visibility status of this graphic element. (Inherited from OdDgGraphicsElement) | |
Method to get/set the Joiner flag, indicating whether the inner line is created if the text is moved outside (to reversed mode). | |
Retrieves type of LSD font flag. ( Special font or Dimension font ) | |
This is the overview for the getLastModifiedTime method overload. | |
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. | |
Method to get/set the LeadingZeros flag, indicating whether to allow the leading zero to show on a decimal value less than 1. | |
details (Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Operate with line styles. See OdDg::LineStyleConstants for some special values. (Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Operate with line weights. See OdDg::LineWeightConstants for some special values. (Inherited from OdDgGraphicsElement) | |
This is the overview for the getLinkages method overload. | |
Returns true if and only if this element is marked as locked. (Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
Method to get/set the NoAutoTextLift flag. | |
Method to get/set the NoLevelSymb flag. | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
| |
This is the overview for the getOsnapPoints method overload. | |
Returns this element's persistent reactors. (Inherited from OdDgElement) | |
Retrieves a single instance of OdDgDimPoint by index from the list. | |
Retrieves the count of OdDgDimPoint in the list. | |
Retrieves the retain fractional accuracy option for alternative format of primary unit string. | |
Retrieves the retain fractional accuracy option ( disable fraction simplification: if set - 8/64, otherwise 1/8 ) for primary unit string. | |
Retrieves the primary tolerance accuracy if tolerance present. | |
Retrieves the retain fractional accuracy option for tolerance of primary unit string. | |
(Inherited from OdDgGraphicsElement) | |
Method to get/set the RelDimLine flag. | |
Method to get/set the RelStat flag. | |
This is the overview for the getRotation method overload. | |
Retrieves the Scale Factor of this dimension. | |
Retrieves the retain fractional accuracy option for alternative format of secondary unit string. | |
Retrieves the retain fractional accuracy option for secondary unit string. | |
Retrieves the secondary tolerance accuracy if tolerance present. | |
Retrieves the retain fractional accuracy option for tolerance of secondary unit string. | |
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). | |
Retrieves the Stacked Fraction Scale Factor of this dimension. | |
(Inherited from OdDgElement) | |
Returns the String Linkage value. (Inherited from OdDgElement) | |
Retrieves the Suppress Unfit Terminators of this dimension. | |
| |
Retrieves the optimal fit of this dimension if text location is above. | |
Method to get/set the TextHeapPad flag. | |
Retrieves the Text Location of this dimension. | |
Get text style table record entry id for dimension | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Method to get/set the ThousandComma flag, indicating whether to use the separator for grouping thousands, etc. See DecimalComma flag. | |
Method to get/set the Tolerance flag. | |
Method to get/set the Tolmode flag. | |
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. | |
Method to get/set the TrailingZeros flag, indicating whether or not to drop the remaining zero digits to the length specified in the Accuracy. | |
Creates a copy of this element, and applies the supplied transformation to the newly created copy. (Inherited from OdDgElement) | |
Returns this element's transient reactors. (Inherited from OdDgElement) | |
Returns the transparency setting of this entity. (Inherited from OdDgGraphicsElement) | |
Method to get/set the UnderlineText flag, indicating NTS "not to scale". | |
(Inherited from OdDgGraphicsElement) | |
This is the overview for the getXAttributes method overload. | |
Returns the XData Linkage value. (Inherited from OdDgElement) | |
Notification function called just before an element is deleted from memory. (Inherited from OdDgElement) | |
Notification function called when this entity is involved in a grip operation. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Replaces this database -resident (DBRO) object with the specified non- database -resident (NDBRO) object, while retaining this object's elementId, handle, owner, and reactor list. (Inherited from OdDgElement) | |
This method returns true if elmId is the Element ID of a reactor attached to this element. Otherwise, it returns false. (Inherited from OdDgElement) | |
Returns the hideMeForDragging flag for this entity. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
This is the overview for the intersectWith method overload. | |
(Inherited from OdDgElement) | |
Returns true if and only this object is a database -resident object. (Inherited from OdDgElement) | |
Returns true if and only if this object is marked as erased. (Inherited from OdDgElement) | |
Operate with materials. (Inherited from OdDgGraphicsElement) | |
Returns true if and only if an object derived from OdDbEntity has been modified. (Inherited from OdDgElement) | |
Returns true if and only if this object has not been closed since it was created. (Inherited from OdDgElement) | |
Returns true if and only if this object is open OdDg::kForNotify. (Inherited from OdDgElement) | |
Returns true if and only if this object's Object ID is not valid because the OdDgElement::subDeepClone or OdDgElement::subWblockClone() have yet to be completed. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Returns true if and only if this object is open OdDg::kForRead. (Inherited from OdDgElement) | |
Returns true if and only if this object is taking part in an Undo operation. (Inherited from OdDgElement) | |
Returns true if and only if this object is open OdDg::kForWrite. (Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
Notification function called whenever an element is opened OdDg::kForWrite, a function has been called that could modify the contents of this element, and this element is now being closed. (Inherited from OdDgElement) | |
Notification function called whenever an geometry of element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement) | |
Notification function called whenever an element derived from OdDgGraphicsElement is modified. (Inherited from OdDgElement) | |
Notification function called whenever the attribute linkages has been written to the notifying element. (Inherited from OdDgElement) | |
Notification function called whenever the notifying element is in the midst an Undo operation that is undoing modifications. (Inherited from OdDgElement) | |
This is the overview for the moveGripPointsAt method overload. | |
Moves the specified stretch points of this entity. (Inherited from OdDgElement) | |
If true then composeForLoad will be called second time in single thread mode after multithread loading. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Notification function called whenever an element is opened for modify OdDg::kForWrite. (Inherited from OdDgElement) | |
Returns the element ID of this element's owner. (Inherited from OdDgElement) | |
Notification function called whenever a Redo process processes the reappending of the notifying element to the database. (Inherited from OdDgElement) | |
Recompute dimension points by association data. | |
Sets the bit flag indicating the entity's geometry is changed. (Inherited from OdDgElement) | |
Sets the bit flag indicating the element's geometry is changed. (Inherited from OdDgGraphicsElement) | |
Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Removes the linkages with specified application ID. (Inherited from OdDgElement) | |
| |
Removes the specified persistent reactor from this element's reactor list. (Inherited from OdDgElement) | |
Remove a single instance of OdDgDimPoint from the list. | |
Removes the specified transient reactor from this element's reactor list. (Inherited from OdDgElement) | |
Removes the XAttributes with specified handler ID. (Inherited from OdDgElement) | |
For non-dbro elements only | |
| |
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. | |
Sets the OdUInt32 value as an Alternate Color Index value. | |
Sets the OdInt32 value as an Alternate Line Style Entry Id. Lookup from Line Style Table. | |
Sets the OdUInt32 value as an Alternate Line Weight value. | |
Sets the Annotation Scale Factor of this dimension. | |
Set dimension annotation scale usage flag. If dAnnotationScale == 0, then annotation scale will be set from model of element | |
| |
| |
| |
| |
The method changes the element class property. See Class enumeration ocumentation for more details. (Inherited from OdDgGraphicsElement) | |
This is the overview for the setColor method overload. | |
(Inherited from OdDgGraphicsElement) | |
| |
Applies the default properties of the specified database to this entity. (Inherited from OdDgElement) | |
| |
| |
| |
| |
| |
Sets the settings class OdDgDimGeometry for this OdDgDimension. | |
Sets the settings class OdDgDimTextFormat for this OdDgDimension. | |
Sets the settings class OdDgDimTextInfo for this OdDgDimension. | |
Set dimension style table record id for dimension | |
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. | |
| |
| |
Accessor method to set all included flags as single unsigned integer (16bit). | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Set the Fit Options of this dimension for automatic terminator orientation. | |
Accessor method to set all included flags as single unsigned integer (32bit). | |
(Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
The method changes the graphics group entry id of the current element. (Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
| |
Set the lift for dimension with inline text. | |
Sets the visibility status of this graphic element. (Inherited from OdDgGraphicsElement) | |
| |
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. | |
Set the time of the last modification. (Inherited from OdDgElement) | |
| |
| |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Sets the linkages with specified application ID. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
This is the overview for the setMaterial method overload. | |
| |
| |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
Called on a new created cloned object to indicate that its Object ID is not valid. (Inherited from OdDgElement) | |
| |
Sets this element's ownerId data member. (Inherited from OdDgElement) | |
Sets a single instance of OdDgDimPoint by index in the list. Must be allocated first. Use addPoint method, otherwise. | |
Set the retain fractional accuracy option for for alternative format of primary unit string. | |
Set the retain fractional accuracy option for primary unit string. | |
Set the primary tolerance accuracy if tolerance present. | |
Set the retain fractional accuracy option for for tolerance of primary unit string. | |
(Inherited from OdDgGraphicsElement) | |
Copies the properties from the specified entity to this entity. (Inherited from OdDgElement) | |
| |
| |
This is the overview for the setRotation method overload. | |
Sets the Scale Factor of this dimension. | |
Set the retain fractional accuracy option for alternative format of secondary unit string. | |
Set the retain fractional accuracy option for secondary unit string. | |
Set the secondary tolerance accuracy if tolerance present. | |
Set the retain fractional accuracy option for tolerance of secondary unit string. | |
| |
Sets the Stacked Fraction Scale Factor of this dimension. | |
Sets the String Linkage value. (Inherited from OdDgElement) | |
Set the Suppress Unfit Terminators of this dimension. | |
| |
Set the optimal fit of this dimension if text location is above. | |
| |
Set the Text Location of this dimension. | |
Set text style table record entry id for dimension | |
| |
(Inherited from OdDgGraphicsElement) | |
(Inherited from OdDgGraphicsElement) | |
| |
| |
| |
| |
| |
Sets the transparency setting of this entity, and returns eOk if successful. (Inherited from OdDgGraphicsElement) | |
| |
(Inherited from OdDgGraphicsElement) | |
Sets the XAttributes with specified handler ID. (Inherited from OdDgElement) | |
Sets the XData Linkage value. (Inherited from OdDgElement) | |
Called as the first operation as this object is being closed, for database -resident objects only. When overriding this function: 1) If the OdDgElement's state is incorrect, return something other than eOk. 2) If the parent class's subClose() returns anything other than eOk, immediately return it. 3) If other actions are required before close, do them. 4) Return eOk. If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns false. The default implementation of this function does nothing but return eOk. This function can be overridden in... more (Inherited from OdDgElement) | |
Notification function called whenever a method of the specified subelement has called assertWriteEnabled() (Inherited from OdDgElement) | |
Called as the first operation as this object is being erased or unerased. (Inherited from OdDgElement) | |
Called as the first operation as this object is being erased or unerased. (Inherited from OdDgGraphicsElement) | |
| |
| |
This is the overview for the subGetGeomExtents method overload. | |
(Inherited from OdDgElement) | |
Called as the first operation of the handOverTo function. (Inherited from OdDgElement) | |
This is the overview for the subIntersectWith method overload. | |
(Inherited from OdDgGraphicsElement) | |
Notification function called by the ODA Drawings API for DGN immediately before an object is opened. (Inherited from OdDgElement) | |
OdGiDrawable overridden | |
(Inherited from OdDgElement) | |
OdGiDrawable overridden (Inherited from OdDgGraphicsElement) | |
Called by setDatabaseDefaults() after the values are set. | |
Called by setDatabaseDefaults() after the values are set. (Inherited from OdDgElement) | |
Called by setDatabaseDefaults() after the values are set. (Inherited from OdDgGraphicsElement) | |
Called as the first operation of swapIdWith (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
it should be called by any object that could have common auxiliary drawable properties (e.c., patterns) (Inherited from OdDgGraphicsElement) | |
Swaps the elementIDs, and handles between this object and another object. (Inherited from OdDgElement) | |
Applies the specified 3D transformation matrix to this entity. (Inherited from OdDgElement) | |
Notification function called whenever the Undo process processes the appending of the notifying element to the database. (Inherited from OdDgElement) | |
Returns the undo filer associated with this object. (Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
(Inherited from OdDgElement) | |
Upgrades this object from OdDg::kForRead to OdDg::kForWrite if there is only one reader, and returns isWriteEnabled(); (Inherited from OdDgElement) | |
Performs a shallow clone of this object. (Inherited from OdDgElement) | |
Allows a subelement of a complex element to notify its root element that it has been changed. (Inherited from OdDgElement) |
Copyright © 2002-2022. Open Design Alliance All rights reserved.
|