Click or drag to resize

LinearDimension Class

Represents a linear dimension
Inheritance Hierarchy

Namespace:  Rhino.Geometry
Assembly:  RhinoCommon (in RhinoCommon.dll)
public class LinearDimension : AnnotationBase

The LinearDimension type exposes the following members.

Public methodLinearDimension
Initializes a new instance of the LinearDimension class.
Protected methodLinearDimension(SerializationInfo, StreamingContext)
Protected constructor used in serialization.
Public methodCode exampleLinearDimension(Plane, Point2d, Point2d, Point2d)
Initializes a new instance of the LinearDimension class
Public propertyAligned
Gets or sets a value indicating whether this annotation is aligned.
Public propertyAlternateBelowLine (Inherited from Dimension.)
Public propertyAlternateDimensionLengthDisplay
Alternate length display units and format
(Inherited from AnnotationBase.)
Public propertyAltLengthFactor (Inherited from Dimension.)
Public propertyAltLengthResolution (Inherited from Dimension.)
Public propertyAltLengthRoundoff (Inherited from Dimension.)
Public propertyAltPrefix (Inherited from Dimension.)
Public propertyAltSuffix (Inherited from Dimension.)
Public propertyAltToleranceResolution (Inherited from Dimension.)
Public propertyAltUnitsDisplay (Inherited from Dimension.)
Public propertyAltZeroSuppression (Inherited from Dimension.)
Public propertyAnnotationType
Public propertyArrowBlockId1 (Inherited from Dimension.)
Public propertyArrowBlockId2 (Inherited from Dimension.)
Public propertyArrowhead1End
Gets the arrow head end of the first extension line.
Public propertyArrowhead2End
Gets the arrow head end of the second extension line.
Public propertyArrowheadType1 (Inherited from Dimension.)
Public propertyArrowheadType2 (Inherited from Dimension.)
Public propertyArrowSize (Inherited from Dimension.)
Public propertyBaselineSpacing (Inherited from Dimension.)
Public propertyCentermarkSize (Inherited from Dimension.)
Public propertyCentermarkStyle (Inherited from Dimension.)
Public propertyDetailMeasured (Inherited from Dimension.)
Public propertyDimensionLengthDisplay
Length display units and format
(Inherited from AnnotationBase.)
Public propertyDimensionLineExtension (Inherited from Dimension.)
Public propertyDimensionLinePoint
Point on annotation plane where dimension line starts
Public propertyDimensionScale
Gets or sets the dimension scale
(Inherited from AnnotationBase.)
Public propertyDimensionStyle
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
(Inherited from AnnotationBase.)
Public propertyDimensionStyleId
Id of this annotation's parent dimstyle If this annotation has overrides to dimstyle properties, those overrides will be represented in the DimensionStyle returned by DimensionStyle(ParentStyle)
(Inherited from AnnotationBase.)
Public propertyDimensionStyleIndex
Index of DimensionStyle in document DimStyle table used by the dimension.
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyDistanceBetweenArrowTips
Gets the distance between arrow tips.
Public propertyDistanceScale (Inherited from Dimension.)
Public propertyDrawForward
Gets or sets whether the text is oriented towards the reader when viewed from behind
(Inherited from AnnotationBase.)
Public propertyExtensionLine1End
End of the first extension line.
Public propertyExtensionLine2End
End of the second extension line.
Public propertyExtensionLineExtension (Inherited from Dimension.)
Public propertyExtensionLineOffset (Inherited from Dimension.)
Public propertyFixedExtensionLength (Inherited from Dimension.)
Public propertyFixedLengthExtensionOn (Inherited from Dimension.)
Public propertyFont
The base Font for the text of the annotation. The text string is rich text and therefore a different font that the base font can be associated with sub strings of the text
(Inherited from AnnotationBase.)
Public propertyFontIndex Obsolete.
Obsolete; use Font property instead
(Inherited from AnnotationBase.)
Public propertyForceArrowPosition (Inherited from Dimension.)
Public propertyForceTextPosition (Inherited from Dimension.)
Public propertyFormatWidth
Text format width (Wrapping rectangle)
(Inherited from AnnotationBase.)
Public propertyHasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
(Inherited from GeometryBase.)
Public propertyHasPropertyOverrides
(Inherited from AnnotationBase.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyIndex
Index of DimensionStyle in document DimStyle table used by the dimension.
(Inherited from AnnotationBase.)
Public propertyIsDeformable
true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
(Inherited from GeometryBase.)
Public propertyIsDocumentControlled
If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
(Inherited from GeometryBase.)
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLengthFactor (Inherited from Dimension.)
Public propertyLengthResolution (Inherited from Dimension.)
Public propertyLengthRoundoff (Inherited from Dimension.)
Public propertyMaskColor
Color to use for drawing a text mask when it is enabled. If the mask is enabled and MaskColor is System.Drawing.Color.Transparent, then the viewport's color will be used for the MaskColor
(Inherited from AnnotationBase.)
Public propertyMaskColorSource
Gets or sets whether the mask background color is from the background or from a color
(Inherited from AnnotationBase.)
Public propertyMaskEnabled
Determines whether or not to draw a Text Mask
(Inherited from AnnotationBase.)
Public propertyMaskOffset
Offset for the border around text of the rectangle used to draw the mask. This value multiplied by TextHeight is the offset on each side of the tight rectangle around the text characters to the mask rectangle. The default value is 0.1.
(Inherited from AnnotationBase.)
Public propertyMaskUsesViewportColor
If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
(Inherited from AnnotationBase.)
Public propertyNumericValue
Gets the numeric value, depending on geometry type.

LinearDimension: distance between arrow tips

RadialDimension: radius or diamater depending on type

AngularDimension: angle in degrees

Leader or Text: UnsetValue

(Inherited from AnnotationBase.)

In Rhino for Windows 6.2, this member is inherited from DimensionNumericValue.
Public propertyObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
(Inherited from GeometryBase.)
Public propertyParentDimensionStyle
The parent dimension style associated with this annotation
(Inherited from AnnotationBase.)
Public propertyPlainText
Text stripped of RTF formatting information
(Inherited from AnnotationBase.)
Public propertyPlainUserText (Inherited from Dimension.)
Public propertyPlane
Plane that this annotation lies on
(Inherited from AnnotationBase.)
Public propertyPrefix (Inherited from Dimension.)
Public propertyRichText
Text including additional RTF formatting information
(Inherited from AnnotationBase.)
Public propertySuffix (Inherited from Dimension.)
Public propertySuppressExtension1 (Inherited from Dimension.)
Public propertySuppressExtension2 (Inherited from Dimension.)
Public propertyText
Text including additional RTF formatting information
(Inherited from AnnotationBase.)
Public propertyTextAngleType (Inherited from Dimension.)
Public propertyTextFormula
See RichText
(Inherited from AnnotationBase.)

In Rhino for Windows 6.2, this member is inherited from DimensionTextFormula.
Public propertyTextHasRtfFormatting
(Inherited from AnnotationBase.)
Public propertyTextHeight
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
(Inherited from AnnotationBase.)
Public propertyTextIsWrapped
Is text wrapping on
(Inherited from AnnotationBase.)
Public propertyTextLocation (Inherited from Dimension.)
Public propertyTextModelWidth
Width of text in the model
(Inherited from AnnotationBase.)
Public propertyTextOrientation (Inherited from Dimension.)
Public propertyTextPosition
Gets and sets the position of text on the plane.

In Rhino for Windows 6.2, this member is inherited from DimensionTextPosition.
Public propertyTextRotation (Inherited from Dimension.)
Public propertyTextRotationDegrees
Rotation of text in degrees
(Inherited from AnnotationBase.)
Public propertyTextRotationRadians
Rotation of text in radians
(Inherited from AnnotationBase.)
Public propertyToleranceFormat (Inherited from Dimension.)
Public propertyToleranceHeightScale (Inherited from Dimension.)
Public propertyToleranceLowerValue (Inherited from Dimension.)
Public propertyToleranceResolution (Inherited from Dimension.)
Public propertyToleranceUpperValue (Inherited from Dimension.)
Public propertyUseDefaultTextPoint (Inherited from Dimension.)
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
(Inherited from CommonObject.)
Public propertyUserStringCount
Gets the amount of user strings.
(Inherited from GeometryBase.)
Public propertyZeroSuppression (Inherited from Dimension.)
Public methodClearPropertyOverrides
Clears all overriden properties for this annotation
(Inherited from AnnotationBase.)
Public methodComponentIndex
If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.
(Inherited from GeometryBase.)
Protected methodConstructConstObject
Assigns a parent object and a subobject index to this.
(Inherited from CommonObject.)
Public methodStatic memberCreate
Initialize Dimension parameters
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(Boolean)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

(Inherited from CommonObject.)

In Rhino for Windows, this member is overridden by Dispose(Boolean).
Public methodDuplicate
Constructs a deep (full) copy of this object.
(Inherited from GeometryBase.)
Public methodDuplicateShallow
Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy.
(Inherited from GeometryBase.)
Public methodEnsurePrivateCopy
If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
(Inherited from CommonObject.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodStatic memberFromPoints
Initializes a new instance of the LinearDimension class, based on three points.
Public methodGet3dPoints
Get locations of dimension's 3d points
Public methodCode exampleGetBoundingBox(Boolean)
Boundingbox solver. Gets the world axis aligned boundingbox for the geometry.
(Inherited from GeometryBase.)
Public methodCode exampleGetBoundingBox(Plane)
Aligned Boundingbox solver. Gets the plane aligned boundingbox.
(Inherited from GeometryBase.)
Public methodGetBoundingBox(Transform)
Aligned Boundingbox solver. Gets the world axis aligned boundingbox for the transformed geometry.
(Inherited from GeometryBase.)
Public methodGetBoundingBox(Plane, Box)
Aligned Boundingbox solver. Gets the plane aligned boundingbox.
(Inherited from GeometryBase.)
Public methodGetDimensionStyle
Return the proper dimension style from which to get properties for this annotation object If this object has style overrides, those will be included in the returned dimension style and the style will be updated to include the current state of the parent style for non-overridden fields
(Inherited from AnnotationBase.)
Public methodGetDisplayLines
Public methodGetDistanceDisplayText
Public methodGetHashCode (Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetTextRectangle
Public methodGetTextTransform
Get the transform for this text object's text geometry
(Inherited from Dimension.)
Public methodGetType (Inherited from Object.)
Public methodGetUserString
Gets user string from this geometry.
(Inherited from GeometryBase.)
Public methodGetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
(Inherited from GeometryBase.)
Public methodIsPropertyOverridden
Returns true if a property is overridden
(Inherited from AnnotationBase.)
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodMakeDeformable
If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
(Inherited from GeometryBase.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodMemoryEstimate
Computes an estimate of the number of bytes that this object is using in memory.
(Inherited from GeometryBase.)
Protected methodNonConstOperation
For derived classes implementers.

Defines the necessary implementation to free the instance from being const.

(Inherited from CommonObject.)

In Rhino for Windows, this member is overridden by NonConstOperation.
Protected methodOnSwitchToNonConst
Is called when a non-const operation occurs.
(Inherited from GeometryBase.)
Public methodRotate
Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
(Inherited from GeometryBase.)
Public methodScale
Scales the object by the specified factor. The scale is centered at the origin.
(Inherited from GeometryBase.)
Public methodSetAltDimensionLengthDisplayWithZeroSuppressionReset (Inherited from Dimension.)
Public methodSetBold
(Inherited from AnnotationBase.)
Public methodSetDimensionLengthDisplayWithZeroSuppressionReset (Inherited from Dimension.)
Public methodSetFacename
(Inherited from AnnotationBase.)
Public methodSetItalic
(Inherited from AnnotationBase.)
Public methodSetLocations
Sets the three locations of the point, using two-dimensional points that refer to the plane of the annotation.
Public methodSetOverrideDimStyle
Set a style including overrides for this annotation object. The DimensionStyle OverrideStyle must have the override fields marked as overridden and must have it's Id set to nil. Use DimensinoStyle.SetFieldOverride(Field field) and related functions to manage override settings. To override a field, the field value must be set and the field must be marked as an override. The DimensionStyle passed in here must not be in the dimstyle table
(Inherited from AnnotationBase.)
Public methodSetRichText
(Inherited from AnnotationBase.)
Public methodSetUnderline
(Inherited from AnnotationBase.)
Public methodSetUserString
Attach a user string (key,value combination) to this geometry.
(Inherited from GeometryBase.)
Public methodToString (Inherited from Object.)
Public methodTransform
Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it.
(Inherited from GeometryBase.)
Public methodTranslate(Vector3d)
Translates the object along the specified vector.
(Inherited from GeometryBase.)
Public methodTranslate(Double, Double, Double)
Translates the object along the specified vector.
(Inherited from GeometryBase.)
Public methodWrapText
Wrap text
(Inherited from AnnotationBase.)
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.2
See Also