SoAsciiText Class Reference
[Node Classes]

The SoAsciiText class renders flat 3D text.The text is rendered using 3D polygon geometry. More...

#include <Inventor/nodes/SoAsciiText.h>

Inheritance diagram for SoAsciiText:

Public Types
enum	Justification { LEFT = 1, RIGHT, CENTER }
Public Member Functions
	SoAsciiText (void)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
Static Public Member Functions
static void	initClass (void)
	Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
Public Attributes
SoMFString	string
SoSFFloat	spacing
SoSFEnum	justification
SoMFFloat	width
Protected Member Functions
virtual	~SoAsciiText ()
virtual void	computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
virtual void	generatePrimitives (SoAction *)
virtual SoDetail *	createTriangleDetail (SoRayPickAction action, const SoPrimitiveVertex v1, const SoPrimitiveVertex v2, const SoPrimitiveVertex v3, SoPickedPoint *pp)
virtual void	notify (SoNotList *list)

Detailed Description

The SoAsciiText class renders flat 3D text.

The text is rendered using 3D polygon geometry.

The size of the textual geometry representation is decided from the SoFont::size field of a preceding SoFont-node in the scene graph, which specifies the size in unit coordinates. This value sets the approximate vertical size of the letters. The default value if no SoFont-nodes are used, is 10.

The complexity of the glyphs is controlled by a preceding SoComplexity node with Type set to OBJECT_SPACE. Please note that the default builtin 3D font will not be affected by the SoComplexity node.

This node is different from the SoText2 node in that it rotates, scales, translates etc just like other geometry in the scene. It is different from the SoText3 node in that it renders the text "flat", i.e. does not extrude the fonts to have depth.

To get an intuitive feeling for how SoAsciiText works, take a look at this sample Inventor file in examinerviewer:

  #Inventor V2.1 ascii

  Separator {
    Font {
      size 10
      name "Arial:Bold Italic"
    }

    BaseColor {
      rgb 1 0 0 #red
    }
    AsciiText {
      width [ 0, 1, 50 ]
      justification LEFT #Standard alignment
      string [ "LEFT", "LEFT", "LEFT", "LEFT", "LEFT LEFT" ]
    }
    BaseColor { 
      rgb 1 1 0
    }
    Sphere { radius 1.5 }

    Translation {
      translation 0 -50 0
    }
    BaseColor {
      rgb 0 1 0 #green
    }
    AsciiText {
      width [ 0, 1, 50 ]
      justification RIGHT
      string [ "RIGHT", "RIGHT", "RIGHT", "RIGHT", "RIGHT RIGHT" ]
    }
    BaseColor { 
      rgb 0 1 1
    }
    Sphere { radius 1.5 }

    Translation {
      translation 0 -50 0
    }
    BaseColor {
      rgb 0 0 1 #blue
    }
    AsciiText {
      width [ 0, 1, 50 ]
      justification CENTER
      string [ "CENTER", "CENTER", "CENTER", "CENTER", "CENTER CENTER" ]
    }
    BaseColor { 
      rgb 1 0 1
    }
    Sphere { radius 1.5 }
  }

In examinerviewer the Inventor file looks something like this:

FILE FORMAT/DEFAULTS:

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

Since:: Inventor 2.1

Member Enumeration Documentation

enum SoAsciiText::Justification

The font justification values control the text alignment. Justification can have three distinct values. The default value is SoAsciiText::LEFT, and the strings are rendered with a common left border. The second value is SoAsciiText::RIGHT, and renders the strings with a common right border. The last value is SoAsciiText::CENTER, in which the strings are rendered with their centers aligned. The origo of the three alignments are respectively left, right and center, located at the baseline of the first line of text.

Enumerator:

LEFT	The strings are left-aligned; rendered with a common left border. This is the default alignment.
RIGHT	The strings are right-aligned; rendered with a common right border.
CENTER	The text is center-aligned; all strings are centered.

Constructor & Destructor Documentation

SoAsciiText::SoAsciiText ( void )

Constructor.

SoAsciiText::~SoAsciiText ( ) [protected, virtual]

Destructor.

Member Function Documentation

void SoAsciiText::computeBBox	(	SoAction *	action,
		SbBox3f &	box,
		SbVec3f &	center
	)			`[protected, virtual]`

Implemented by SoShape subclasses to let the SoShape superclass know the exact size and weighted center point of the shape's bounding box.

The bounding box and center point should be calculated and returned in the local coordinate system.

The method implements action behavior for shape nodes for SoGetBoundingBoxAction. It is invoked from SoShape::getBoundingBox(). (Subclasses should not override SoNode::getBoundingBox().)

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry.

Implements SoShape.

void SoAsciiText::generatePrimitives ( SoAction * action ) [protected, virtual]

The method implements action behavior for shape nodes for SoCallbackAction. It is invoked from SoShape::callback(). (Subclasses should not override SoNode::callback().)

The subclass implementations uses the convenience methods SoShape::beginShape(), SoShape::shapeVertex(), and SoShape::endShape(), with SoDetail instances, to pass the primitives making up the shape back to the caller.

Implements SoShape.

void SoAsciiText::notify ( SoNotList * l ) [protected, virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoShape.

Member Data Documentation

SoMFString SoAsciiText::string

Lines of text to render. Several strings can be specified for this multifield, where each string represents a line.

Default value is a single empty string.

SoSFFloat SoAsciiText::spacing

Spacing between each line. Defaults to 1.0.

SoSFEnum SoAsciiText::justification

Horizontal alignment. Default SoAsciiText::LEFT.

SoMFFloat SoAsciiText::width

Defines the width of each line. The text is scaled to be within the specified units. The size of the characters will remain the same; only the the x-positions are scaled. When width <= 0, the width value is ignored and the text rendered as normal. The exact width of the rendered text depends not only on the width field, but also on the maximum character width in the rendered string. The string will be attempted to fit within the specified width, but if it is unable to do so, it uses the largest character in the string as the width. If fewer widths are specified than the number of strings, the strings without matching widths are rendered with default width.

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

SoAsciiText.h
SoAsciiText.cpp

SoAsciiText Class Reference [Node Classes]

Public Types

Public Member Functions

Static Public Member Functions