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 used in serialization.
Parameters:
| info (SerializationInfo) | Serialization data. |
| context (StreamingContext) | Serialization stream. |
Properties
Alternate length display units and format
Set or get the decimal separator c
Length display units and format
If there are no overrides then the parent style is returned otherwise the dimension style saved with the annotation is returned.
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.
Gets or sets whether the text is oriented towards the reader when viewed from behind
obsoleteDo not use setter as the MaskFrame is an enum. Use MaskFrame property instead
Gets or sets whether to draw a frame around a text mask
Returns the font used by the first run of text in an annotation
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
obsoleteUse Font property instead. Ex: textEntity.Font = Rhino.DocObjects.Font.FromQuartetProperties("Arial", false, false);
Obsolete; use Font property instead
HasBrepForm
Returns true if the Brep.TryConvertBrep function will be successful for this object
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.
Overrides: CommonObject.IsDocumentControlled
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)
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
Gets or sets whether the mask background color is from the background or from a color
Determines whether or not to draw a Text Mask
Gets or sets whether to draw a frame around a text mask
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.
If true, the viewport's color is used for the mask color. If false, the color defined by MaskColor is used
ObjectType
Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on.
The parent dimension style associated with this annotation
Text stripped of RTF formatting information
Text stripped of RTF formatting information and with field expressions intact
Text including additional RTF formatting information
obsoleteUse RichText or PlainText
Text including additional RTF formatting information
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.
AnnotationBase.TextHeight Gets the parent dimstyle for the annotation and gets or sets the text height in the dimstyle
Rotation of text in degrees
Rotation of text in radians
Use kerning data in font to set distances between glyphs
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.
Methods
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.
Returns: 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.
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.
Parameters:
| currentRemainder (uint) | The current remainder value. |
Returns: CRC of the information the defines the object.
DeleteAllUserStrings
public void DeleteAllUserStrings()
Parameters:
| key (string) |
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
Dispose
Overridden in order to destroy local display cache information
Parameters:
| disposing (bool) |
Overrides: CommonObject.Dispose
Returns: 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.
Returns: An object of the same type as this object.
This behavior is overridden by implementing classes.
EnsurePrivateCopy
public void 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 static bool FirstCharProperties(string rtf_str, ref bool bold, ref bool italic, ref bool underline, ref string facename)
Extracts the font properties (bold, italic, underline, and facename) from the first character run of an RTF string.
Remarks: Obsolete. Use FirstCharFont instead.
Parameters:
| rtf_str (string) | The RTF string to analyze. |
| bold (ref bool) | Set to true if the first run is bold; otherwise, false. |
| italic (ref bool) | Set to true if the first run is italic; otherwise, false. |
| underline (ref bool) | Set to true if the first run is underlined; otherwise, false. |
| facename (ref string) | Receives the font face name of the first run. |
Returns: True if the properties were successfully extracted; otherwise, false.
public static string 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)
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.
Parameters:
| rtf_in (string) | The input RTF string to modify. |
| clear_bold (bool) | If true, clears the bold formatting. |
| set_bold (bool) | If true, sets the bold formatting. |
| clear_italic (bool) | If true, clears the italic formatting. |
| set_italic (bool) | If true, sets the italic formatting. |
| clear_underline (bool) | If true, clears the underline formatting. |
| set_underline (bool) | If true, sets the underline formatting. |
| clear_facename (bool) | If true, clears the font face name. |
| set_facename (bool) | If true, sets the font face name. |
| facename (string) | The font face name to set if set_facename is true. |
Returns: The modified RTF string with the requested formatting changes applied.
GetBoundingBox
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
Parameters:
| accurate (bool) | 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. |
Returns: 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.
GetBoundingBox
Aligned Bounding box solver. Gets the plane aligned bounding box.
Parameters:
| plane (Plane) | Orientation plane for BoundingBox. |
Returns: A BoundingBox in plane coordinates.
Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
Parameters:
| xform (Transform) | Transformation to apply to bounding box after calculation. The geometry is not modified. |
Returns: The bounding box of the transformed geometry in world coordinates or BoundingBox.Empty if not bounding box could be found.
Overrides: GeometryBase.GetBoundingBox
Get view dependent dimension scale
Parameters:
| doc (RhinoDoc) | |
| dimstyle (DimensionStyle) | |
| vport (RhinoViewport) |
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
Parameters:
| parentDimStyle (DimensionStyle) |
GetObjectData
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Parameters:
| info (SerializationInfo) | The System.Runtime.Serialization.SerializationInfo to populate with data. |
| context (StreamingContext) | The destination (see System.Runtime.Serialization.StreamingContext) for this serialization. |
Return plain text string for this annotation with field expressions unevaluated.
Parameters:
| map (ref int[]) | an array of int values in groups of 3: run index, character start position, and length. |
Returns: A plain text string.
Parameters:
| key (string) | id used to retrieve the string. |
Returns: 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.
Returns: A new collection.
Returns true if all of the text in the annotation is Bold, otherwise returns false
Returns true if all of the text in the annotation is Italic, otherwise returns false
Returns true if all of the text in the annotation is Underlined, otherwise returns false
Returns true if a property is overridden
Parameters:
| field (DimensionStyle.Field) |
IsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Parameters:
| log (out string) | A textual log. This out parameter is assigned during this call. |
Returns: 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.
Returns: 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.
Returns: An estimated memory footprint.
NonConstOperation
protected override void NonConstOperation()
Destroy cache handle
Overrides: CommonObject.NonConstOperation
OnSwitchToNonConst
protected override void OnSwitchToNonConst()
Is called when a non-constant operation occurs.
Overrides: CommonObject.OnSwitchToNonConst
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 RunReplace(string replaceString, int startRunIndex, int startRunPosition, int endRunIndex, int endRunPosition)
Replace text within a formatted string
Scale
Scales the object by the specified factor. The scale is centered at the origin.
Parameters:
| scaleFactor (double) | The uniform scaling factor. |
Returns: true if geometry successfully scaled.
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
Parameters:
| OverrideStyle (DimensionStyle) |
Sets the annotation's text as rich text (RTF), optionally using a specified dimension style for formatting overrides.
Parameters:
| rtfText (string) | The RTF (Rich Text Format) string to assign to the annotation. |
| dimstyle (DimensionStyle) | The dimension style to use for formatting overrides, or null to use the current style. |
SetUserString
Attach a user string (key,value combination) to this geometry.
ToJSON
Create a JSON string representation of this object
Parameters:
| options (SerializationOptions) |
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.
Parameters:
| xform (Transform) | Transformation to apply to geometry. |
Returns: true if geometry successfully transformed.
Translate
Translates the object along the specified vector.
Translate
Translates the object along the specified vector.
Parameters:
| translationVector (Vector3d) | A moving vector. |
Returns: true if geometry successfully translated.