Click or drag to resize
SoText3 Class

3D text shape node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 10.12.3.0 (10.12.3.0)
Syntax
public class SoText3 : SoShape

The SoText3 type exposes the following members.

Constructors
  NameDescription
Public methodSoText3

Creates a 3D text node with default settings.

Top
Methods
  NameDescription
Public methodAffectsState

Overrides default method on OIV.Inventor.Nodes.SoNode.

(Inherited from SoShape.)
Public methodBeginShape(SoAction, SoShapeTriangleShapes)
Calls BeginShape(action, shapeType, (OIV.Inventor.Details.SoFaceDetail ^)nullptr).
(Inherited from SoShape.)
Public methodBeginShape(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.

(Inherited from SoShape.)
Public methodCallback

Implements primitive generation for all shapes.

(Inherited from SoShape.)
Public methodComputeBBox(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).

(Inherited from SoShape.)
Public methodComputeBBox(SoAction, SbBox3f, SbVec3f)

Computes bounding box of text.

(Overrides SoShapeComputeBBox(SoAction, SbBox3f, SbVec3f).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Inherited from SoNode.)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEndShape

end shape previously started with OIV.Inventor.Nodes.SoShape.BeginShape(OIV.Inventor.Actions.SoAction, OIV.Inventor.Nodes.SoShape.TriangleShapes, OIV.Inventor.Details.SoFaceDetail).

(Inherited from SoShape.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox

Implements bounding box method using virtual OIV.Inventor.Nodes.SoShape.ComputeBBox(OIV.Inventor.Actions.SoAction, OIV.Inventor.SbBox3f@, OIV.Inventor.SbVec3f@) method.

(Inherited from SoShape.)
Public methodGetCharacterBounds

Method to get the bounds of the given character in the given string.

Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetPrimitiveCount

Counts number of primitives produced by this shape.

(Overrides SoShapeGetPrimitiveCount(SoGetPrimitiveCountAction).)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetShapeType

Gets the current shape Full Scene Antialiasing type.

(Inherited from SoShape.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender

Implements rendering by rendering each primitive generated by subclass.

(Overrides SoShapeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodIsBoundingBoxIgnoring

Used by BoundingBoxAction to know if bounding box computation should be ignored or not.

(Inherited from SoShape.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick

Implements picking along a ray by intersecting the ray with each primitive generated by subclass.

(Overrides SoShapeRayPick(SoRayPickAction).)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

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.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetShapeType

set the antialiasing type for this shape.

(Inherited from SoShape.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodShapeVertex

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).

(Inherited from SoShape.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertyboundingBoxIgnoring

Whether to ignore this node during bounding box traversal.

(Inherited from SoShape.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyjustification

Indicates placement and alignment of strings.

Public propertyparts

Which parts of text are visible.

Public propertyspacing

Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height.

Public propertystringField

The text string(s) to display.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This node defines one or more strings of 3D text. In contrast with OIV.Inventor.Nodes.SoText2, 3D text can be rotated, scaled, lighted, and textured like all other 3D shapes.

Optionally (setting the OIV.Inventor.Nodes.SoText3.parts field) each character in a 3D text string may be a true three dimensional object. This shape is created by extruding an outlined version of the character (in the current typeface) along the current profile, as defined by nodes derived from OIV.Inventor.Nodes.SoProfile. The default text profile, if none is specified, is a straight line segment one unit long.

The text position is always at the local origin (0,0,0). A transform node, e.g. OIV.Inventor.Nodes.SoTranslation, must be used to position the text in 3D space.

The text is always rendered in its local XY plane. A transform node, e.g. OIV.Inventor.Nodes.SoRotation, may be used to rotate the text plane in 3D space.

Text supports both single byte Latin1 (ISO8859-1) characters and multi-byte UNICODE characters. ISO8859-1 is an 8-bit character set which is a superset of the older 7-bit ASCII character set. See the String class for more information.

Rendering:

The typeface and size (default = 10) are specified using an OIV.Inventor.Nodes.SoFont node. The scale factor, if any, in the current transform is applied to this size.

3D text characters may be rendered using lines, polygons or textured rectangles depending on settings in the OIV.Inventor.Nodes.SoFont node. Textured rendering is recommended. It generally has the best performance (minimum geometry) and the best image quality (because antialiasing is applied).

  • Line rendering is selected by specifying a "stroke font" name in the OIV.Inventor.Nodes.SoFont name field. In this case line attributes apply instead of polygon attributes and text is not extruded.

  • Polygon rendering is selected by setting the OIV.Inventor.Nodes.SoFont renderStyle field to POLYGON (the default) or POLYGON_AND_OUTLINE.

  • Textured quad rendering is selected by setting the OIV.Inventor.Nodes.SoFont renderStyle field is set to TEXTURE or TEXTURE_DELAYED.

Rendering styles: Additional styles can be applied using an OIV.Inventor.Nodes.SoTextProperty node, including underline, strikethrough, background and background outline.

Complexity: The quality (degree of tesselation) of OIV.Inventor.Nodes.SoText3 line and polygon rendering depends on the OIV.Inventor.Nodes.SoComplexity node's value field. The quality of OIV.Inventor.Nodes.SoText3 textured rendering depends on the OIV.Inventor.Nodes.SoComplexity node's value and textureQuality fields, plus the OIV.Inventor.Nodes.SoTextProperty node's textureQualityRange field. If there is no OIV.Inventor.Nodes.SoComplexity the textureQuality is 1. See OIV.Inventor.Nodes.SoFont for more discussion.

Material: OIV.Inventor.Nodes.SoText3 uses the current set of materials when rendering. If the material binding is OVERALL, then the whole text is drawn with the first material. If it is PER_PART or PER_PART_INDEXED, the front part of the text is drawn with the first material, the sides with the second, and the back with the third.

Lighting: By default lighting is only computed for the "front" face of geometry, including OIV.Inventor.Nodes.SoText3, meaning that the back face of the text will be black when lighting is enabled. To illuminate both sides, enable "two sided" lighting using the OIV.Inventor.Nodes.SoShapeHints node's vertexOrdering field. But note that, unlike most geometry, you should set the vertexOrdering field to CLOCKWISE, not COUNTERCLOCKWISE.

Texture: Textures are applied to 3D text as follows. On the front and back faces of the text, the texture origin is at the base point of the first string; the base point is at the lower left for justification LEFT, at the lower right for RIGHT, and at the lower center for CENTER. The texture is scaled equally in both S and T dimensions, with the font height representing 1 unit. S increases to the right on the front faces and to the left on the back faces. On the sides, the texture is scaled the same as on the front and back. S is equal to 0 at the rear edge of the side faces. The T origin can occur anywhere along each character, depending on how that character's outline is defined.

Performance: A scene graph containing a large number of OIV.Inventor.Nodes.SoText3 nodes will generally have much better rendering performance using a text specific caching mechanism called accumulation rendering mode. However some features are not available and significant time may be required to build (or rebuild) this cache. See the OIV.Inventor.Nodes.SoTextProperty node enableTextAccumulation field for more information.

Justification:

Horizontal alignment of the text can be specified using the OIV.Inventor.Nodes.SoText3.justification field. Both horizontal and vertical alignment can be controlled using an OIV.Inventor.Nodes.SoTextProperty node, however the justification setting in this node overrides the horizontal setting unless the justification field is set to INHERITED.

Picking:

Text can be picked (OIV.Inventor.Actions.SoRayPickAction) like any other geometry. If a text node has been picked then OIV.Inventor.SoPickedPoint can return an OIV.Inventor.Details.SoTextDetail object. This object contains information about which string (in a multi-string text node) was picked and which character within the string was picked.

Antialiasing: Shape Antialiasing type is OIV.Inventor.Nodes.SoShape.ShapeTypes.TEXT.

FILE FORMAT/DEFAULT

Text3 {
string ""
spacing 1
justification LEFT
parts FRONT
}

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