Dimension

Dimension class

Base class for dimensions

Inheritence: Rhino.Runtime.CommonObjectRhino.Geometry.GeometryBaseRhino.Geometry.AnnotationBaseDimension
Derived Classes: AngularDimension, Centermark, LinearDimension, OrdinateDimensionRadialDimension

Namespace: Rhino.Geometry
Dimension: references

Constructors (7)

AnnotationBase()

Protected constructor for internal use.

AnnotationBase(SerializationInfo info, StreamingContext context)

Protected constructor used in serialization.

CommonObject()

Allows construction from inheriting classes.

CommonObject(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Dimension()

Dimension(SerializationInfo info, StreamingContext context)

GeometryBase(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

Properties (97)

AlternateBelowLine

AlternateDimensionLengthDisplay

Alternate length display units and format

AltLengthFactor

AltLengthResolution

AltLengthRoundoff

AltPrefix

AltSuffix

AltToleranceResolution

AltUnitsDisplay

AltZeroSuppression

AnnotationType

Type of annotation

ArrowBlockId1

ArrowBlockId2

ArrowFit

ArrowheadType1

ArrowheadType2

ArrowSize

BaselineSpacing

CentermarkSize

CentermarkStyle

DecimalSeparator

Set or get the decimal separator c

DetailMeasured

DimensionLengthDisplay

Length display units and format

DimensionLineExtension

DimensionScale

Gets or sets the dimension scale

DimensionStyle

If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.

DimensionStyleId

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)

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

DistanceScale

DrawForward

Gets or sets whether the text is oriented towards the reader when viewed from behind

DrawTextFrame

Gets or sets whether to draw a frame around a text mask

ExtensionLineExtension

ExtensionLineOffset

FirstCharFont

Returns the font used by the first run of text in an annotation

FixedExtensionLength

FixedLengthExtensionOn

Font

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

FontIndex

Obsolete; use Font property instead

ForceArrowPosition

ForceDimensionLineBetweenExtensionLines

ForceDimLine

ForceTextPosition

FormatWidth

Text format width (Wrapping rectangle)

HasBrepForm

Returns True if the Brep.TryConvertBrep function will be successful for this object

HasPropertyOverrides

HasUserData

Gets True if this class has any custom information attached to it through UserData.

IsDeformable

True if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.

IsDocumentControlled

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.

IsDocumentControlled

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.

IsValid

Tests an object to see if it is valid.

LengthFactor

LengthResolution

LengthRoundoff

MaskColor

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

MaskColorSource

Gets or sets whether the mask background color is from the background or from a color

MaskEnabled

Determines whether or not to draw a Text Mask

MaskFrame

Gets or sets whether to draw a frame around a text mask

MaskOffset

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.

MaskUsesViewportColor

If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used

NumericValue

Gets the numeric value (or measurement), depending on geometry type.
LinearDimension: distance between arrow tips
RadialDimension: radius or diameter depending on type
AngularDimension: angle in radians

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.

ParentDimensionStyle

The parent dimension style associated with this annotation

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

PlainText

Text stripped of RTF formatting information

PlainTextWithFields

Text stripped of RTF formatting information and with field expressions intact

PlainUserText

Plane

Plane that this annotation lies on

Prefix

RichText

Text including additional RTF formatting information

Suffix

SuppressExtension1

SuppressExtension2

Text

Text including additional RTF formatting information

TextAngleType

TextFit

TextFormula

See RichText

TextHasRtfFormatting

TextHeight

AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle

TextIsWrapped

Is text wrapping on

TextLocation

TextModelWidth

Width of text in the model

TextOrientation

TextPosition

Gets and sets the position of text on the plane.

TextRotation

TextRotationDegrees

Rotation of text in degrees

TextRotationRadians

Rotation of text in radians

ToleranceFormat

ToleranceHeightScale

ToleranceLowerValue

ToleranceResolution

ToleranceUpperValue

UseDefaultTextPoint

UserData

List of custom information that is attached to this class.

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

UserStringCount

Gets the amount of user strings.

ZeroSuppression

Methods (62)

ClearPropertyOverrides()

Clears all overridden properties for this annotation

ComponentIndex()

If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index.

ConstructConstObject(object parentObject, int subobjectIndex)

Assigns a parent object and a sub-object index to this.

DataCRC(uint currentRemainder)

Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical.

DeleteAllUserStrings()

DeleteUserString(string key)

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

Dispose(bool disposing)

Overridden in order to destroy local display cache information

Duplicate()

Constructs a deep (full) copy of this object.

DuplicateShallow()

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.

EnsurePrivateCopy()

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.

Explode()

Explodes this dimension into its geometric components.

FirstCharProperties(string rtf_str, ref bool bold, ref bool italic, ref bool underline, ref string facename)

FormatRtfString(string rtf_in, bool clear_bold, bool set_bold, bool clear_italic, bool set_italic, bool clear_underline, bool set_underline, bool clear_facename, bool set_facename, string facename)

FromBase64String(int archive3dm, int opennurbs, string base64Data)

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

FromJSON(Dictionary<string, string> jsonDictionary)

Create a CommonObject instance from a JSON dictionary

FromJSON(string json)

Create a CommonObject instance from a JSON string

GeometryEquals(GeometryBase first, GeometryBase second)

Determines if two geometries equal one another, in pure geometrical shape. This version only compares the geometry itself and does not include any user data comparisons. This is a comparison by value: for two identical items it will be true, no matter where in memory they may be stored.

GeometryReferenceEquals(GeometryBase one, GeometryBase other)

Determines if two objects are respectively shallow copies, new managed instantiations of the same geometry, or similar internal references to the exact same geometry, both in managed and in unmanaged code.

GetBoundingBox(bool accurate)

Bounding box solver. Gets the world axis aligned bounding box for the geometry.

GetBoundingBox(Plane plane, out Box worldBox)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Plane plane)

Aligned Bounding box solver. Gets the plane aligned bounding box.

GetBoundingBox(Transform xform)

Aligned Bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

GetBoundingBox(Transform xform)

Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.

GetDimensionScale(RhinoDoc doc, DimensionStyle dimstyle,RhinoViewport vport)

Get view dependent dimension scale

GetDimensionStyle(DimensionStyle parentDimStyle)

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

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

GetPlainTextWithRunMap(ref int map)

Return plain text string for this annotation with field expressions unevaluated.

GetTextTransform(ViewportInfo viewport, DimensionStyle style, double textScale, bool drawForward)

Get the transform for this text object's text geometry

GetUserString(string key)

Gets user string from this geometry.

GetUserStrings()

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

IsAllBold()

Returns True if all of the text in the annotation is Bold, otherwise returns false

IsAllItalic()

Returns True if all of the text in the annotation is Italic, otherwise returns false

IsAllUnderlined()

Returns True if all of the text in the annotation is Underlined, otherwise returns false

IsPropertyOverridden(Field field)

Returns True if a property is overridden

IsValidWithLog(out string log)

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

MakeDeformable()

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.

MemoryEstimate()

Computes an estimate of the number of bytes that this object is using in memory.

NonConstOperation()

For derived classes implementers.
Defines the necessary implementation to free the instance from being constant.

NonConstOperation()

Destroy cache handle

OnSwitchToNonConst()

Is called when a non-constant operation first occurs.

OnSwitchToNonConst()

Is called when a non-constant operation occurs.

PlainTextToRtf(string str)

Rotate(double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).

RunReplace(string replaceString, int startRunIndex, int startRunPosition, int endRunIndex, int endRunPosition)

Replace text within a formatted string

Scale(double scaleFactor)

Scales the object by the specified factor. The scale is centered at the origin.

SetAltDimensionLengthDisplayWithZeroSuppressionReset(LengthDisplay ld)

SetBold(bool set_on)

SetDimensionLengthDisplayWithZeroSuppressionReset(LengthDisplay ld)

SetFacename(bool set_on, string facename)

SetItalic(bool set_on)

SetOverrideDimStyle(DimensionStyle OverrideStyle)

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

SetRichText(string rtfText, DimensionStyle dimstyle)

SetUnderline(bool set_on)

SetUserString(string key, string value)

Attach a user string (key,value combination) to this geometry.

ToJSON(SerializationOptions options)

Create a JSON string representation of this object

Transform(Transform xform)

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.

Translate(double x, double y, double z)

Translates the object along the specified vector.

Translate(Vector3d translationVector)

Translates the object along the specified vector.

UpdateDimensionText(DimensionStyle style, UnitSystem units)

Remakes dimension text geometry object and sets it on the dimension.

WrapText()

Wrap text

Nothing found