man SoAsciiText () - simple 3D text shape node

NAME

SoAsciiText - simple 3D text shape node

INHERITS FROM

SoBase > SoFieldContainer > SoNode > SoShape > SoAsciiText

SYNOPSIS

#include <Inventor/nodes/SoAsciiText.h> enum Justification { c } c } Left edges of all strings are aligned

c } c } Right edges of all strings are aligned

c } c } Centers of all strings are aligned

} Fields from class SoAsciiText: c } c } string

c } c } spacing

c } c } justification

c } c } width Methods from class SoAsciiText: c } c } SoAsciiText()

c } c } getClassTypeId() Methods from class SoNode: c } c } setOverride(SbBool state)

c } c } isOverride() const

c } c } copy(SbBool copyConnections = FALSE) const

c } c } affectsState() const

c } c } getByName(const SbName &name)

c } c } getByName(const SbName &name, SoNodeList &list) Methods from class SoFieldContainer: c } c } setToDefaults()

c } c } hasDefaultValues() const

c } c } fieldsAreEqual(const SoFieldContainer *fc) const

c } c } copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)

c } c } set(const char *fieldDataString)

c } c } get(SbString &fieldDataString)

c } c } getFields(SoFieldList &resultList) const

c } c } getField(const SbName &fieldName) const

c } c } getFieldName(const SoField *field, SbName &fieldName) const

c } c } isNotifyEnabled() const

c } c } enableNotify(SbBool flag) Methods from class SoBase: c } c } ref()

c } c } unref() const

c } c } unrefNoDelete() const

c } c } touch()

c } c } getTypeId() const

c } c } isOfType(SoType type) const

c } c } setName(const SbName &name)

c } c } getName() const

DESCRIPTION

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

FIELDS

c } c } string

The text string(s) to display. Each string will appear on its own line. c } c } 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. c } c } 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. c } c } width

Defines the width of each text string. Each string will be scaled so that it spans this many units.

METHODS

c } c } SoAsciiText()

Creates an ascii text node with default settings. c } c } getClassTypeId()

Returns type identifier for this class.

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.

FILE FORMAT/DEFAULTS

AsciiText {
string	""
spacing	1
justification	LEFT
width	0
}

SEE ALSO

SoFont, SoFontStyle, SoText2, SoText3, SoTextDetail