AnnotationBase Class |
This class refers to the geometric element that is independent from the document.
Namespace: Rhino.Geometry
The AnnotationBase type exposes the following members.
Name | Description | |
---|---|---|
AnnotationBase |
Protected constructor for internal use.
| |
AnnotationBase(SerializationInfo, StreamingContext) |
Protected constructor used in serialization.
|
Name | Description | |
---|---|---|
AlternateDimensionLengthDisplay |
Alternate length display units and format
| |
AnnotationType |
Type of annotation
| |
DecimalSeparator |
Set or get the decimal separator c
| |
DimensionLengthDisplay |
Length display units and format
| |
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.
(Inherited from CommonObject.) | |
DrawForward |
Gets or sets whether the text is oriented towards the reader when viewed from behind
| |
DrawTextFrame | Obsolete.
Gets or sets whether to draw a frame around a text mask
| |
FirstCharFont |
Returns the font used by the first run of text in an annotation
| |
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
| |
FormatWidth | Text format width (Wrapping rectangle) | |
HasBrepForm |
Returns true if the Brep.TryConvertBrep function will be successful for this object
(Inherited from GeometryBase.) | |
HasPropertyOverrides | ||
HasUserData |
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.) | |
IsDeformable |
true if object can be accurately modified with "squishy" transformations like
projections, shears, and non-uniform scaling.
(Inherited from GeometryBase.) | |
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.
(Inherited from GeometryBase.) | |
IsValid | Tests an object to see if it is valid. (Inherited from CommonObject.) | |
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
| |
ObjectType |
Useful for switch statements that need to differentiate between
basic object types like points, curves, surfaces, and so on.
(Inherited from GeometryBase.) | |
ParentDimensionStyle |
The parent dimension style associated with this annotation
| |
PlainText |
Text stripped of RTF formatting information
| |
PlainTextWithFields |
Text stripped of RTF formatting information and with field expressions intact
| |
Plane | Plane that this annotation lies on | |
RichText |
Text including additional RTF formatting information
| |
Text | Obsolete.
Text including additional RTF formatting information
| |
TextFormula | Obsolete.
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
| |
TextModelWidth |
Width of text in the model
| |
TextRotationDegrees |
Rotation of text in degrees
| |
TextRotationRadians |
Rotation of text in radians
| |
UserData |
List of custom information that is attached to this class.
(Inherited from CommonObject.) | |
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.
(Inherited from CommonObject.) | |
UserStringCount |
Gets the amount of user strings.
(Inherited from GeometryBase.) |
Name | Description | |
---|---|---|
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.
(Inherited from GeometryBase.) | |
ConstructConstObject |
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.) | |
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.
(Inherited from GeometryBase.) | |
DeleteAllUserStrings | (Inherited from GeometryBase.) | |
DeleteUserString | (Inherited from GeometryBase.) | |
Dispose |
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.) | |
Dispose(Boolean) |
Overridden in order to destroy local display cache information
(Inherited from GeometryBase.) | |
Duplicate |
Constructs a deep (full) copy of this object.
(Inherited from GeometryBase.) | |
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.
(Inherited from GeometryBase.) | |
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.
(Inherited from CommonObject.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
Finalize |
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.) | |
FirstCharProperties | ||
FormatRtfString | ||
GetBoundingBox(Boolean) |
Bounding box solver. Gets the world axis aligned bounding box for the geometry.
(Inherited from GeometryBase.) | |
GetBoundingBox(Plane) |
Aligned Bounding box solver. Gets the plane aligned bounding box.
(Inherited from GeometryBase.) | |
GetBoundingBox(Transform) |
Aligned bounding box solver. Gets the world axis aligned bounding box for the transformed geometry.
(Overrides GeometryBaseGetBoundingBox(Transform).) | |
GetBoundingBox(Plane, Box) |
Aligned Bounding box solver. Gets the plane aligned bounding box.
(Inherited from GeometryBase.) | |
GetDimensionScale |
Get view dependent dimension scale
| |
GetDimensionStyle |
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
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetObjectData |
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.) | |
GetPlainTextWithRunMap |
Return plain text string for this annotation with field expressions unevaluated.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUserString |
Gets user string from this geometry.
(Inherited from GeometryBase.) | |
GetUserStrings |
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
(Inherited from GeometryBase.) | |
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 |
Returns true if a property is overridden
| |
IsValidWithLog |
Determines if an object is valid. Also provides a report on errors if this
object happens not to be valid.
(Inherited from CommonObject.) | |
MakeDeformable |
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.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
MemoryEstimate |
Computes an estimate of the number of bytes that this object is using in memory.
(Inherited from GeometryBase.) | |
NonConstOperation |
Destroy cache handle
(Inherited from GeometryBase.) | |
OnSwitchToNonConst |
Is called when a non-constant operation occurs.
(Inherited from GeometryBase.) | |
PlainTextToRtf | ||
Rotate |
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.) | |
RunReplace |
Replace text within a formatted string
| |
Scale |
Scales the object by the specified factor. The scale is centered at the origin.
(Inherited from GeometryBase.) | |
SetBold | ||
SetFacename | ||
SetItalic | ||
SetOverrideDimStyle |
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 | ||
SetUnderline | ||
SetUserString |
Attach a user string (key,value combination) to this geometry.
(Inherited from GeometryBase.) | |
ToJSON |
Create a JSON string representation of this object
(Inherited from CommonObject.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
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.
(Inherited from GeometryBase.) | |
Translate(Vector3d) | Translates the object along the specified vector. (Inherited from GeometryBase.) | |
Translate(Double, Double, Double) | Translates the object along the specified vector. (Inherited from GeometryBase.) | |
WrapText |
Wrap text
|