|
Open Inventor Release 2024.1.3
|
|
| |
|
Open Inventor Release 2024.1.3
|
|
|
| |
3D text shape node. More...
#include <Inventor/nodes/SoText3.h>
Inheritance diagram for SoText3:Public Types | |
| enum | Justification { LEFT = 0x01 , CENTER = 0x03 , RIGHT = 0x02 , INHERITED = 0x04 } |
| Justification types. More... | |
| enum | Part { FRONT = 0x01 , SIDES = 0x02 , BACK = 0x04 , ALL = 0x07 } |
| Text3 part values. More... | |
| Public Types inherited from SoShape | |
| enum | ShapeType { POINTS , LINES , POLYGONS , TEXT } |
| Basic type for antialiased rendering for this shape (Do not consider the SoDrawStyle property currently in the state). More... | |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoText3 () | |
| Creates a 3D text node with default settings. | |
| Public Member Functions inherited from SoShape | |
| virtual SbBool | affectsState () const |
| Overrides default method on SoNode. | |
| ShapeType | getShapeType () |
| Gets the current shape Full Scene Antialiasing type. | |
| Public Member Functions inherited from SoNode | |
| virtual void | setOverride (const SbBool state) |
| Turns the override flag on or off. | |
| virtual SbBool | isOverride () const |
| Returns the state of the override flag. | |
| virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
| Creates and returns an exact copy of the node. | |
| virtual void | touch () |
| Marks an instance as modified, simulating a change to it. | |
| Public Member Functions inherited from SoFieldContainer | |
| void | setToDefaults () |
| Sets all fields in this object to their default values. | |
| SbBool | hasDefaultValues () const |
| Returns TRUE if all of the object's fields have their default values. | |
| SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
| Returns TRUE if this object's fields are exactly equal to fc's fields. | |
| void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
| Copies the contents of fc's fields into this object's fields. | |
| SoNONUNICODE SbBool | set (const char *fieldDataString) |
| 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. | |
| SbBool | set (const SbString &fieldDataString) |
| 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. | |
| void | get (SbString &fieldDataString) |
| Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
| virtual int | getFields (SoFieldList &list) const |
| Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
| virtual int | getAllFields (SoFieldList &list) const |
| Returns a list of fields, including the eventIn's and eventOut's. | |
| virtual SoField * | getField (const SbName &fieldName) const |
| Returns a the field of this object whose name is fieldName. | |
| virtual SoField * | getEventIn (const SbName &fieldName) const |
| Returns a the eventIn with the given name. | |
| virtual SoField * | getEventOut (const SbName &fieldName) const |
| Returns the eventOut with the given name. | |
| SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
| Returns the name of the given field in the fieldName argument. | |
| SbBool | enableNotify (SbBool flag) |
| Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
| SbBool | isNotifyEnabled () const |
| Notification is the process of telling interested objects that this object has changed. | |
| virtual void | setUserData (void *data) |
| Sets application data. | |
| void * | getUserData (void) const |
| Gets user application data. | |
| Public Member Functions inherited from SoBase | |
| virtual SbName | getName () const |
| Returns the name of an instance. | |
| virtual void | setName (const SbName &name) |
| Sets the name of an instance. | |
| void | setSynchronizable (const bool b) |
| Sets this to be a ScaleViz synchronizable object. | |
| bool | isSynchronizable () const |
| Gets the ScaleViz synchronizable state of this object. | |
| Public Member Functions inherited from SoRefCounter | |
| void | ref () const |
| Adds a reference to an instance. | |
| void | unref () const |
| Removes a reference from an instance. | |
| void | unrefNoDelete () const |
| unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
| int | getRefCount () const |
| Returns current reference count. | |
| void | lock () const |
| lock this instance. | |
| void | unlock () const |
| unlock this instance. | |
| Public Member Functions inherited from SoTypedObject | |
| SbBool | isOfType (const SoType &type) const |
| Returns TRUE if this object is of the type specified in type or is derived from that type. | |
| template<typename TypedObjectClass > | |
| SbBool | isOfType () const |
| Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| Static Public Member Functions inherited from SoShape | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static SbBool | isPrimitiveRestartAvailable (SoState *state=NULL) |
| Returns TRUE if the primitive restart feature is available. | |
| Static Public Member Functions inherited from SoNode | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
| static SoNode * | getByName (const SbName &name) |
| A node's name can be set using SoBase::setName(). | |
| static int | getByName (const SbName &name, SoNodeList &list) |
| A node's name can be set using SoBase::setName(). | |
| Static Public Member Functions inherited from SoFieldContainer | |
| static SoType | getClassTypeId () |
| Returns the type of this class. | |
| Static Public Member Functions inherited from SoBase | |
| static SoType | getClassTypeId () |
| Returns type identifier for this class. | |
| Static Public Member Functions inherited from SoTypedObject | |
| static SoType | getClassTypeId () |
| Returns the type identifier for this class. | |
Public Attributes | |
| SoMFString | string |
| The text string(s) to display. | |
| SoSFFloat | spacing |
| Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height. | |
| SoSFBitMask | parts |
| Which parts of text are visible. | |
| SoSFEnum | justification |
| Indicates placement and alignment of strings. | |
| Public Attributes inherited from SoShape | |
| SoSFBool | boundingBoxIgnoring |
| Whether to ignore this node during bounding box traversal. | |
Friends | |
| class | SoAnnoText3 |
| class | SoAsciiText |
3D text shape node.
This node defines one or more strings of 3D text. In contrast with SoText2, 3D text can be rotated, scaled, lighted, and textured like all other 3D shapes.
Optionally (setting the 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 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. 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. 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 SbString class for more information.
Rendering:
The typeface and size (default = 10) are specified using an 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 SoFont node. Textured rendering is recommended. It generally has the best performance (minimum geometry) and the best image quality (because antialiasing is applied).
Rendering styles: Additional styles can be applied using an SoTextProperty node, including underline, strikethrough, background and background outline.
Complexity: The quality (degree of tesselation) of SoText3 line and polygon rendering depends on the SoComplexity node's value field. The quality of SoText3 textured rendering depends on the SoComplexity node's value and textureQuality fields, plus the SoTextProperty node's textureQualityRange field. If there is no SoComplexity the textureQuality is 1. See SoFont for more discussion.
Material: SoText3 uses the current set of materials when rendering but only OVERALL, PER_PART and PER_PART_INDEXED. Any other binding will behave like OVERALL. 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 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 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 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 SoTextProperty node enableTextAccumulation field for more information.
Justification:
Horizontal alignment of the text can be specified using the justification field. Both horizontal and vertical alignment can be controlled using an 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 (SoRayPickAction) like any other geometry. If a text node has been picked then SoPickedPoint can return an 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 SoShape::TEXT.
| string | "" |
| spacing | 1 |
| justification | LEFT |
| parts | FRONT |
SoRayPickAction
Performs a pick on the text. The string index and character position are available from the SoTextDetail.
SoGetBoundingBoxAction
Computes the bounding box that encloses the text.
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.
SoComplexity, SoFont, SoFullSceneAntialiasing, SoProfile, SoText2, SoTextDetail, SoTextProperty
Justification types.
| Enumerator | |
|---|---|
| LEFT | Left edges of all strings are aligned. |
| CENTER | Centers of all strings are aligned. |
| RIGHT | Right edges of all strings are aligned. |
| INHERITED | The text justification is inherited from the current SoTextProperty::alignmentH value. |
| enum SoText3::Part |
| SoText3::SoText3 | ( | ) |
Creates a 3D text node with default settings.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoShape.
|
friend |
|
friend |
| SoSFEnum SoText3::justification |
Indicates placement and alignment of strings.
With LEFT justification, the left edge of the first line is at the (transformed) origin, and all left edges are aligned. RIGHT justification is similar. CENTER justification places the center of the first string at the (transformed) origin, with the centers of all remaining strings aligned under it. Use enum Justification. Default is LEFT.
| SoSFBitMask SoText3::parts |
| SoSFFloat SoText3::spacing |
| SoMFString SoText3::string |
1.9.8 