Provides a common base class to all annotation geometry.

This class refers to the geometric element that is independent from the document.

Constructors

AnnotationBase

#
Protected constructor for internal use.
protected AnnotationBase()

AnnotationBase

#
Protected constructor used in serialization.
protected AnnotationBase(
info,
Serialization data.
context
Serialization stream.
)

Properties

AlternateDimensionLengthDisplay

#Since v6.0
Alternate length display units and format
public DimensionStyle.LengthDisplay AlternateDimensionLengthDisplay { get; set; }

AnnotationType

#Since v6.0
Type of annotation
public virtual AnnotationType AnnotationType { get; }

DecimalSeparator

#Since v7.0
Set or get the decimal separator c
public char DecimalSeparator { get; set; }

DimensionLengthDisplay

#Since v6.0
Length display units and format
public DimensionStyle.LengthDisplay DimensionLengthDisplay { get; set; }

DimensionScale

#Since v6.0
Gets or sets the dimension scale
public double DimensionScale { get; set; }

DimensionStyle

#Since v6.0
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
public DimensionStyle DimensionStyle { get; }

DimensionStyleId

#Since v6.0
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)
public Guid DimensionStyleId { get; set; }

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

DrawForward

#Since v6.0
Gets or sets whether the text is oriented towards the reader when viewed from behind
public bool DrawForward { get; set; }

DrawTextFrame

#Since v7.0
Gets or sets whether to draw a frame around a text mask
public bool DrawTextFrame { get; set; }
obsoleteDo not use setter as the MaskFrame is an enum. Use MaskFrame property instead

FirstCharFont

#Since v6.5
Returns the font used by the first run of text in an annotation
public Font FirstCharFont { get; }

Font

#Since v6.0
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
public Font Font { get; set; }

FontIndex

#Since v6.1
Obsolete; use Font property instead
[EditorBrowsable(EditorBrowsableState.Never)] public int FontIndex { get; set; }
obsoleteUse Font property instead. Ex: textEntity.Font = Rhino.DocObjects.Font.FromQuartetProperties("Arial", false, false);

FormatWidth

#Since v6.0
Text format width (Wrapping rectangle)
public double FormatWidth { get; set; }

HasBrepForm

Returns true if the Brep.TryConvertBrep function will be successful for this object
public bool HasBrepForm { get; }
inherited fromGeometryBase

HasPropertyOverrides

#Since v6.0
public bool HasPropertyOverrides { get; }

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

IsDeformable

true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling.
public bool IsDeformable { get; }
inherited fromGeometryBase

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.
public sealed override bool IsDocumentControlled { get; }
inherited fromGeometryBase

IsShallowDuplicate

Is this instance a 'shallow copy'. Shallow copies are no different than regular instances with the exception that they will convert to complete independent 'deep' copies if a non const operation is perform on the instance (something that mutates the internal data)
public bool IsShallowDuplicate { get; }
inherited fromGeometryBase

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

LineSpaceScale

#Since v9.0
Scale applied to line spacing
public double LineSpaceScale { get; set; }

MaskColor

#Since v6.0
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
public Color MaskColor { get; set; }

MaskColorSource

#Since v6.0
Gets or sets whether the mask background color is from the background or from a color
public DimensionStyle.MaskType MaskColorSource { get; set; }

MaskEnabled

#Since v6.0
Determines whether or not to draw a Text Mask
public bool MaskEnabled { get; set; }

MaskFrame

#Since v7.0
Gets or sets whether to draw a frame around a text mask
public DimensionStyle.MaskFrame MaskFrame { get; set; }

MaskOffset

#Since v6.0
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.
public double MaskOffset { get; set; }

MaskUsesViewportColor

#Since v6.0
If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
public bool MaskUsesViewportColor { get; set; }

ObjectType

Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
[CLSCompliant(false)] public ObjectType ObjectType { get; }
inherited fromGeometryBase

ParentDimensionStyle

#Since v6.0
The parent dimension style associated with this annotation
public DimensionStyle ParentDimensionStyle { get; set; }

PlainText

#Since v6.0
Text stripped of RTF formatting information
public string PlainText { get; set; }

PlainTextWithFields

#Since v6.19
Text stripped of RTF formatting information and with field expressions intact
public string PlainTextWithFields { get; }

Plane

#Since v5.0
Plane that this annotation lies on
public Plane Plane { get; set; }

RichText

#Since v6.0
Text including additional RTF formatting information
public string RichText { get; set; }

Text

#Since v5.0
Text including additional RTF formatting information
public string Text { get; set; }
obsoleteUse RichText or PlainText

TextFormula

#Since v5.0
See RichText
public string TextFormula { get; set; }
obsoleteUse RichText

TextHasRtfFormatting

#Since v6.0
Gets a value indicating whether the annotation's text is formatted as RTF (Rich Text Format). Returns true if the text begins with an RTF header; otherwise, false.
public bool TextHasRtfFormatting { get; }

TextHeight

#Since v5.0
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
public double TextHeight { get; set; }

TextIsWrapped

#Since v6.0
Is text wrapping on
public bool TextIsWrapped { get; set; }

TextModelWidth

#Since v6.0
Width of text in the model
public double TextModelWidth { get; }

TextRotationDegrees

#Since v6.0
Rotation of text in degrees
public double TextRotationDegrees { get; set; }

TextRotationRadians

#Since v6.0
Rotation of text in radians
public double TextRotationRadians { get; set; }

UseKerning

#Since v9.0
Use kerning data in font to set distances between glyphs
public bool UseKerning { get; set; }

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

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.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UserStringCount

Gets the amount of user strings.
public int UserStringCount { get; }
inherited fromGeometryBase

Methods

ClearPropertyOverrides

#Since v6.0
Clears all overridden properties for this annotation
public bool ClearPropertyOverrides()

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.
[ConstOperation] public ComponentIndex ComponentIndex()
inherited fromGeometryBase
This object's component index. If this object is not a sub-piece of a larger geometric entity, then the returned index has m_type = ComponentIndex.InvalidType and m_index = -1.

ConstructConstObject

Assigns a parent object and a sub-object index to this.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

DataCRC

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.
[CLSCompliant(false)] public uint DataCRC(
currentRemainder
The current remainder value.
)
inherited fromGeometryBase
CRC of the information the defines the object.

DeleteAllUserStrings

public void DeleteAllUserStrings()
inherited fromGeometryBase

DeleteUserString

public bool DeleteUserString(
key
)
inherited fromGeometryBase

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

Overridden in order to destroy local display cache information
protected override void Dispose(
disposing
)
inherited fromGeometryBase

Duplicate

Constructs a deep (full) copy of this object.
public virtual GeometryBase Duplicate()
inherited fromGeometryBase
An object of the same type as this, with the same properties and behavior.

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.
public GeometryBase DuplicateShallow()
inherited fromGeometryBase
An object of the same type as this object.

This behavior is overridden by implementing classes.

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.
public void EnsurePrivateCopy()
inherited fromCommonObject

FirstCharProperties

#Since v6.0
Extracts the font properties (bold, italic, underline, and facename) from the first character run of an RTF string.
public static bool FirstCharProperties(
rtf_str,
The RTF string to analyze.
ref bool
bold,
Set to true if the first run is bold; otherwise, false.
ref bool
italic,
Set to true if the first run is italic; otherwise, false.
ref bool
underline,
Set to true if the first run is underlined; otherwise, false.
ref string
facename
Receives the font face name of the first run.
)
Remarks: Obsolete. Use FirstCharFont instead.
True if the properties were successfully extracted; otherwise, false.

FormatRtfString

#Since v6.0
Modifies the formatting of an RTF (Rich Text Format) string by setting or clearing bold, italic, underline, and font face properties on the first character run.
public static string FormatRtfString(
rtf_in,
The input RTF string to modify.
clear_bold,
If true, clears the bold formatting.
set_bold,
If true, sets the bold formatting.
clear_italic,
If true, clears the italic formatting.
set_italic,
If true, sets the italic formatting.
clear_underline,
If true, clears the underline formatting.
set_underline,
If true, sets the underline formatting.
clear_facename,
If true, clears the font face name.
set_facename,
If true, sets the font face name.
facename
The font face name to set if set_facename is true.
)
The modified RTF string with the requested formatting changes applied.

GetBoundingBox

Bounding box solver. Gets the world axis aligned bounding box for the geometry.
[ConstOperation] public BoundingBox GetBoundingBox(
accurate
If true, a physically accurate bounding box will be computed. If not, a bounding box estimate will be computed. For some geometry types there is no difference between the estimate and the accurate bounding box. Estimated bounding boxes can be computed much (much) faster than accurate (or "tight") bounding boxes. Estimated bounding boxes are always similar to or larger than accurate bounding boxes.
)
inherited fromGeometryBase
The bounding box of the geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.

GetBoundingBox

Aligned Bounding box solver. Gets the plane aligned bounding box.
[ConstOperation] public BoundingBox GetBoundingBox(
plane,
Orientation plane for BoundingBox.
out Box
worldBox
Aligned box in World coordinates.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

Aligned Bounding box solver. Gets the plane aligned bounding box.
[ConstOperation] public BoundingBox GetBoundingBox(
plane
Orientation plane for BoundingBox.
)
inherited fromGeometryBase
A BoundingBox in plane coordinates.

GetBoundingBox

#Since v6.10
Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
public override BoundingBox GetBoundingBox(
xform
Transformation to apply to bounding box after calculation. The geometry is not modified.
)
The bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.

GetDimensionScale

#Since v6.0
Get view dependent dimension scale
public static double GetDimensionScale()

GetDimensionStyle

#Since v6.0
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
[ConstOperation] public DimensionStyle GetDimensionStyle(
parentDimStyle
)

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

GetPlainTextWithRunMap

#Since v7.0
Return plain text string for this annotation with field expressions unevaluated.
public string GetPlainTextWithRunMap(
ref int[]
map
an array of int values in groups of 3: run index, character start position, and length.
)
A plain text string.

GetUserString

Gets user string from this geometry.
public string GetUserString(
key
id used to retrieve the string.
)
inherited fromGeometryBase
string associated with the key if successful. null if no key was found.

GetUserStrings

Gets a copy of all (user key string, user value string) pairs attached to this geometry.
public NameValueCollection GetUserStrings()
inherited fromGeometryBase
A new collection.

IsAllBold

#Since v6.22
Returns true if all of the text in the annotation is Bold, otherwise returns false
public bool IsAllBold()

IsAllItalic

#Since v6.22
Returns true if all of the text in the annotation is Italic, otherwise returns false
public bool IsAllItalic()

IsAllUnderlined

#Since v6.22
Returns true if all of the text in the annotation is Underlined, otherwise returns false
public bool IsAllUnderlined()

IsPropertyOverridden

#Since v6.0
Returns true if a property is overridden
[ConstOperation] public bool IsPropertyOverridden(
Field
field
)

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
true if this object is valid; false otherwise.

MakeDeformable

If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling.
public bool MakeDeformable()
inherited fromGeometryBase
false if object cannot be converted to a deformable object. true if object was already deformable or was converted into a deformable object.

MemoryEstimate

Computes an estimate of the number of bytes that this object is using in memory.
[CLSCompliant(false)] [ConstOperation] public uint MemoryEstimate()
inherited fromGeometryBase
An estimated memory footprint.

NonConstOperation

Destroy cache handle
protected override void NonConstOperation()
inherited fromGeometryBase

OnSwitchToNonConst

Is called when a non-constant operation occurs.
protected override void OnSwitchToNonConst()
inherited fromGeometryBase

PlainTextToRtf

#Since v6.0
public static string PlainTextToRtf(
str
)

Rotate

Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).
public bool Rotate(
angleRadians,
Angle of rotation in radians.
rotationAxis,
Direction of the axis of rotation.
rotationCenter
Point on the axis of rotation.
)
inherited fromGeometryBase
true if geometry successfully rotated.

RunReplace

#Since v7.0
Replace text within a formatted string
public bool RunReplace(
replaceString,
startRunIndex,
startRunPosition,
endRunIndex,
endRunPosition
)

Scale

Scales the object by the specified factor. The scale is centered at the origin.
public bool Scale(
scaleFactor
The uniform scaling factor.
)
inherited fromGeometryBase
true if geometry successfully scaled.

SetBold

#Since v6.0
public virtual bool SetBold(
set_on
)

SetFacename

#Since v6.0
public virtual bool SetFacename(
set_on,
facename
)

SetItalic

#Since v6.0
public virtual bool SetItalic(
set_on
)

SetOverrideDimStyle

#Since v6.0
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 DimensionStyle.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
public bool SetOverrideDimStyle(
OverrideStyle
)

SetRichText

#Since v6.0
Sets the annotation's text as rich text (RTF), optionally using a specified dimension style for formatting overrides.
public void SetRichText(
rtfText,
The RTF (Rich Text Format) string to assign to the annotation.
dimstyle
The dimension style to use for formatting overrides, or null to use the current style.
)

SetUnderline

#Since v6.0
public virtual bool SetUnderline(
set_on
)

SetUserString

Attach a user string (key,value combination) to this geometry.
public bool SetUserString(
key,
id used to retrieve this string.
value
string associated with key.
)
inherited fromGeometryBase
true on success.

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject

Transform

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.
public bool Transform(
Transform
xform
Transformation to apply to geometry.
)
inherited fromGeometryBase
true if geometry successfully transformed.

Translate

Translates the object along the specified vector.
public bool Translate(
x,
The X component.
y,
The Y component.
z
The Z component.
)
inherited fromGeometryBase
true if geometry successfully translated.

Translate

Translates the object along the specified vector.
public bool Translate(
translationVector
A moving vector.
)
inherited fromGeometryBase
true if geometry successfully translated.

WrapText

#Since v6.0
Wrap text
public void WrapText()