Click or drag to resize

AnnotationBase Class

Provides a common base class to all annotation geometry.

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

Inheritance Hierarchy

Namespace:  Rhino.Geometry
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
[SerializableAttribute]
public class AnnotationBase : GeometryBase

The AnnotationBase type exposes the following members.

Constructors
  NameDescription
Protected methodAnnotationBase
Protected constructor for internal use.
Protected methodAnnotationBase(SerializationInfo, StreamingContext)
Protected constructor used in serialization.
Top
Properties
  NameDescription
Public propertyAlternateDimensionLengthDisplay
Alternate length display units and format
Public propertyAnnotationType
Type of annotation
Public propertyDecimalSeparator
Set or get the decimal separator c
Public propertyDimensionLengthDisplay
Length display units and format
Public propertyDimensionScale
Gets or sets the dimension scale
Public propertyDimensionStyle
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
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)
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyDrawForward
Gets or sets whether the text is oriented towards the reader when viewed from behind
Public propertyDrawTextFrame Obsolete.
Gets or sets whether to draw a frame around a text mask
Public propertyFirstCharFont
Returns the font used by the first run of text in an annotation
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
Public propertyFormatWidth
Text format width (Wrapping rectangle)
Public propertyHasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
(Inherited from GeometryBase.)
Public propertyHasPropertyOverrides
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
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 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
Public propertyMaskColorSource
Gets or sets whether the mask background color is from the background or from a color
Public propertyMaskEnabled
Determines whether or not to draw a Text Mask
Public propertyMaskFrame
Gets or sets whether to draw a frame around a text mask
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.
Public propertyMaskUsesViewportColor
If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
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
Public propertyPlainText
Text stripped of RTF formatting information
Public propertyPlainTextWithFields
Text stripped of RTF formatting information and with field expressions intact
Public propertyPlane
Plane that this annotation lies on
Public propertyRichText
Text including additional RTF formatting information
Public propertyText Obsolete.
Text including additional RTF formatting information
Public propertyTextFormula Obsolete.
See RichText
Public propertyTextHasRtfFormatting
Public propertyTextHeight
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
Public propertyTextIsWrapped
Is text wrapping on
Public propertyTextModelWidth
Width of text in the model
Public propertyTextRotationDegrees
Rotation of text in degrees
Public propertyTextRotationRadians
Rotation of text in radians
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 shareable set of information.
(Inherited from CommonObject.)
Public propertyUserStringCount
Gets the amount of user strings.
(Inherited from GeometryBase.)
Top
Methods
  NameDescription
Public methodClearPropertyOverrides
Clears all overridden properties for this annotation
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 sub-object index to this.
(Inherited from CommonObject.)
Public methodDataCRC
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.
(Inherited from GeometryBase.)
Public methodDeleteAllUserStrings (Inherited from GeometryBase.)
Public methodDeleteUserString (Inherited from GeometryBase.)
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(Boolean)
Overridden in order to destroy local display cache information
(Inherited from GeometryBase.)
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
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodStatic memberFirstCharProperties
Public methodStatic memberFormatRtfString
Public methodCode exampleGetBoundingBox(Boolean)
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
(Inherited from GeometryBase.)
Public methodCode exampleGetBoundingBox(Plane)
Aligned Bounding box solver. Gets the plane aligned bounding box.
(Inherited from GeometryBase.)
Public methodGetBoundingBox(Transform)
Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
(Overrides GeometryBaseGetBoundingBox(Transform).)
Public methodGetBoundingBox(Plane, Box)
Aligned Bounding box solver. Gets the plane aligned bounding box.
(Inherited from GeometryBase.)
Public methodStatic memberGetDimensionScale
Get view dependent dimension scale
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
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetPlainTextWithRunMap
Return plain text string for this annotation with field expressions unevaluated.
Public methodGetType
Gets the Type of the current instance.
(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 methodIsAllBold
Returns true if all of the text in the annotation is Bold, otherwise returns false
Public methodIsAllItalic
Returns true if all of the text in the annotation is Italic, otherwise returns false
Public methodIsAllUnderlined
Returns true if all of the text in the annotation is Underlined, otherwise returns false
Public methodIsPropertyOverridden
Returns true if a property is overridden
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
Creates a shallow copy of the current Object.
(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
Destroy cache handle
(Inherited from GeometryBase.)
Protected methodOnSwitchToNonConst
Is called when a non-constant operation occurs.
(Inherited from GeometryBase.)
Public methodStatic memberPlainTextToRtf
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 methodRunReplace
Replace text within a formatted string
Public methodScale
Scales the object by the specified factor. The scale is centered at the origin.
(Inherited from GeometryBase.)
Public methodSetBold
Public methodSetFacename
Public methodSetItalic
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
Public methodSetRichText
Public methodSetUnderline
Public methodSetUserString
Attach a user string (key,value combination) to this geometry.
(Inherited from GeometryBase.)
Public methodToJSON
Create a JSON string representation of this object
(Inherited from CommonObject.)
Public methodToString
Returns a string that represents the current object.
(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
Top
See Also