| SoAnnoText3 Class |
Annotation text node.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.Inventor.NodesSoShape
OIV.Inventor.NodesSoAnnoText3
Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.1.0.0 (2024.1.0)
SyntaxThe SoAnnoText3 type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoAnnoText3 | Constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Overrides default method on OIV.Inventor.Nodes.SoNode. |
| BeginShape(SoAction, SoShapeTriangleShapes) | Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr). (Inherited from SoShape.) |
| BeginShape(SoAction, SoShapeTriangleShapes, SoFaceDetail) | These methods can be used by subclasses to generate triangles more easily when those triangles are part of a larger structure, such as a triangle strip, triangle fan, or triangulated polygon, according to the TriangleShape enumerated type. |
| Callback | Implements primitive generation for all shapes. |
| ComputeBBox(SoAction, SbBox3f, SbVec3f) | Compute axis aligned bounding box (AABB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). |
| ComputeBBox(SoAction, SbXfBox3d, SbVec3d) | Compute object oriented bounding box (OOB) for subclass using information in the given action (which may not necessarily be an OIV.Inventor.Actions.SoGetBoundingBoxAction). |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| EndShape | end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method. |
| GetCharacterBounds | |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | Counts number of primitives produced by this shape. |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetShapeType | Gets the current shape Full Scene Antialiasing type. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GLRender | Implements rendering by rendering each primitive generated by subclass. |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | Used by BoundingBoxAction to know if bounding box computation should be ignored or not. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| Pick | (Inherited from SoNode.) |
| RayPick | Implements picking along a ray by intersecting the ray with each primitive generated by subclass. |
| Search | (Inherited from SoNode.) |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetShapeType | set the antialiasing type for this shape. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ShapeVertex | add a primitive vertex to the shape prevously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail). |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Overrides SoNodeWrite(SoWriteAction).) |
Properties| Name | Description | |
|---|---|---|
 | alternateRep | This field optionally holds an OIV.Inventor.Nodes.SoText3 node that will be written out in place of this OIV.Inventor.Nodes.SoAnnoText3 node when saved to a .iv file. |
| boundingBoxIgnoring | Whether to ignore this node during bounding box traversal. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| justification | Indicates placement and alignment of strings. |
| spacing | Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height. |
| stringField | The text string(s) to display. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
RemarksOIV.Inventor.Nodes.SoAnnoText3 has some features of OIV.Inventor.Nodes.SoText3 and also some of OIV.Inventor.Nodes.SoText2.
For example, in the RENDER2D_PRINT_RASTER mode the text is rendered using OIV.Inventor.Nodes.SoText2, but the font size (see OIV.Inventor.Nodes.SoFont) is interpreted in the current 3D units like OIV.Inventor.Nodes.SoText3. As a result, the text is always screen aligned, but the size changes depending on distance from the camera. Text in this mode cannot be rotated.
The current annotation property (OIV.Inventor.Nodes.SoAnnoText3Property) determines the mode. The default is RENDER3D_PRINT_VECTOR (render like OIV.Inventor.Nodes.SoText3).
If scaling is applied (e.g. OIV.Inventor.Nodes.SoTransform) and the mode is RENDER2D_PRINT_RASTER, then the scale factor actually applied to the text is the minimum scale factor of the three axes (x, y, z).
Limitations:
If a stroke font is used (see OIV.Inventor.Nodes.SoFont), the text is rendered with lines rather than faces. Line attributes apply instead of polygon attributes. Text is not extruded.
When using one of the xxx_PRINT_RASTER options (see OIV.Inventor.Nodes.SoAnnoText3Property), the export limitations of OIV.Inventor.Nodes.SoText2 apply. See that class for more information.
Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.TEXT.
FILE FORMAT/DEFAULT
AnnoText3 {
| string | "" |
| spacing | 1.0 |
| justification | LEFT |
| alternateRep | NULL |
ACTION BEHAVIOR
OIV.Inventor.Actions.SoGLRenderAction Draws text based on the current font, profiles, transformation, drawing style, material, texture, complexity, and so on.
OIV.Inventor.Actions.SoRayPickAction Performs a pick on the text. The string index and character position are available from the OIV.Inventor.Details.SoTextDetail.
OIV.Inventor.Actions.SoGetBoundingBoxAction Computes the bounding box that encloses the text.
OIV.Inventor.Actions.SoCallbackAction For non-stroke fonts,if any triangle callbacks are registered with the action, they will be invoked for each successive triangle used to approximate the text geometry.
For stroke fonts, if any line segment callbacks are registered with the action, they will be invoked for each successive line segment used to approximate the text geometry.
See Also