SoAnnoText3 Class Reference
[Shapes]

Annotation text node. More...

#include <Inventor/nodes/SoAnnoText3.h>

Inheritance diagram for SoAnnoText3:

List of all members.

Public Types
enum	Justification {   LEFT = 0x01,   CENTER = 0x03,   RIGHT = 0x02,   INHERITED = 0x04 }
Public Member Functions
virtual SoType	getTypeId () const
	SoAnnoText3 ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoMFString	string
SoSFFloat	spacing
SoSFEnum	justification
SoSFNode	alternateRep

---

Detailed Description

Annotation text node.

SoAnnoText3 has some features of SoText3 and also some of SoText2.

For example, in the RENDER2D_PRINT_RASTER mode the text is rendered using SoText2, but the font size (see SoFont) is interpreted in the current 3D units like 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 (SoAnnoText3Property) determines the mode. The default is RENDER3D_PRINT_VECTOR (render like SoText3).

If scaling is applied (e.g. 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 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 SoAnnoText3Property), the export limitations of SoText2 apply. See that class for more information.

Shape Antialiasing type is SoShape::TEXT.

FILE FORMAT/DEFAULT

AnnoText3 {

string	""
spacing	1.0
justification	LEFT
alternateRep	NULL

}

ACTION BEHAVIOR

SoGLRenderAction
Draws text based on the current font, profiles, 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
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

SoAnnoText3Property, SoText2, SoText3, SoFullSceneAntialiasing

See related examples:

TextProperties

---

Member Enumeration Documentation

enum SoAnnoText3::Justification

Justification types.

Enumerator:

LEFT	Left justification.
CENTER	Center justification.
RIGHT	Right justification.
INHERITED	The text justification is inherited from the current SoTextProperty::alignmentH value.

---

Constructor & Destructor Documentation

SoAnnoText3::SoAnnoText3

(

)

Constructor.

---

Member Function Documentation

static SoType SoAnnoText3::getClassTypeId

(

)

[static]

Returns the type identifier for this class.

Reimplemented from SoShape.

virtual SoType SoAnnoText3::getTypeId

(

)

const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoShape.

---

Member Data Documentation

SoSFNode SoAnnoText3::alternateRep

This field optionally holds an SoText3 node that will be written out in place of this SoAnnoText3 node when saved to a .iv file.

SoSFEnum SoAnnoText3::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.

SoSFFloat SoAnnoText3::spacing

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.

SoMFString SoAnnoText3::string

The text string(s) to display.

Each string will appear on its own line.

---

The documentation for this class was generated from the following file:

• Inventor/nodes/SoAnnoText3.h