SoAsciiText Class Reference
[Shapes, VRML 1.0 nodes]
Simple 3D text shape node.
More...
#include <Inventor/nodes/SoAsciiText.h>
Public Types | |
| enum | Justification { LEFT = 0x01, CENTER = 0x03, RIGHT = 0x02, INHERITED = 0x04 } |
Public Member Functions | |
| virtual SoType | getTypeId () const |
| SoAsciiText () | |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Public Attributes | |
| SoMFString | string |
| SoSFFloat | spacing |
| SoSFEnum | justification |
| SoMFFloat | width |
Detailed Description
Simple 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, just like all other 3D shapes. In contrast with SoText3, this 3D Ascii text cannot be extruded.
The text origin is at (0,0,0) after applying the current transformation. The scale of the text is affected by the size field of the current SoFont as well as the current transformation.
SoAsciiText uses the current material when rendering. Textures are applied to ascii text as follows. On the front face 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 face.
Shape Antialiasing type is SoShape::TEXT.
FILE FORMAT/DEFAULT
- AsciiText {
| string | "" |
| spacing | 1 |
| justification | LEFT |
| width | 0 |
ACTION BEHAVIOR
- SoGLRenderAction
Draws text based on the current font, transformation, drawing style, material, texture, complexity, and so on.
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
If any triangle callbacks are registered with the action, they will be invoked for each successive triangle used to approximate the text geometry.
SEE ALSO
SoFont, SoFontStyle, SoText2, SoText3, SoTextDetail, SoFullSceneAntialiasing
Member Enumeration Documentation
- 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.
Constructor & Destructor Documentation
| SoAsciiText::SoAsciiText | ( | ) |
Creates an ascii text node with default settings.
Member Function Documentation
| static SoType SoAsciiText::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoShape.
| virtual SoType SoAsciiText::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoShape.
Member Data Documentation
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.
Defines the distance (in the negative y direction) between the base points of successive strings, measured with respect to the current font height.
A value of 1 indicates single spacing, a value of 2 indicates double spacing, and so on. Default is 1.
The text string(s) to display.
Each string will appear on its own line.
Defines the width of each text string.
Each string will be scaled so that it spans this many units. Default is 0.
The documentation for this class was generated from the following file:
- Inventor/nodes/SoAsciiText.h