PoMiscTextAttr Class Reference
[Misc]

Node to define miscellaneous text attributes (font name, line length,. More...

#include <MeshViz/nodes/PoMiscTextAttr.h>

Inheritance diagram for PoMiscTextAttr:

Public Types
enum	LineLength { LINE_LENGTH_MAX, LINE_LENGTH_MIN }
Public Member Functions
virtual SoType	getTypeId () const
	PoMiscTextAttr ()
Static Public Member Functions
static SoType	getClassTypeId ()
Public Attributes
SoSFString	fontName
SoSFShort	lineLength
SoSFShort	endLineChar
SoSFBool	profileEnabled
SoSFBool	predefinedProfileEnabled
SoSFBool	outliningEnabled

Detailed Description

Node to define miscellaneous text attributes (font name, line length,.

..).

This node defines the current miscellaneous text attributes for all subsequent MeshViz representations which contain text. These attributes are the font name, the line length, the end line character.

FILE FORMAT/DEFAULT

PoMiscTextAttr

fontName	"defaultFont"
lineLength	LINE_LENGTH_MAX
endLineChar	' '
profileEnabled	FALSE
predefinedProfileEnabled	TRUE
outliningEnabled	TRUE

Member Enumeration Documentation

enum PoMiscTextAttr::LineLength

Line length.

Enumerator:

LINE_LENGTH_MAX	The lines are not limited.
LINE_LENGTH_MIN	The lines are limited to one word.

Constructor & Destructor Documentation

PoMiscTextAttr::PoMiscTextAttr ( )

Constructor.

Member Function Documentation

static SoType PoMiscTextAttr::getClassTypeId ( ) [static]

Returns the type identifier for this class.

Reimplemented from PoNode.

virtual SoType PoMiscTextAttr::getTypeId ( ) const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from PoNode.

Member Data Documentation

SoSFShort PoMiscTextAttr::endLineChar

Defines the end line character.

SoSFString PoMiscTextAttr::fontName

Font name for text.

SoSFShort PoMiscTextAttr::lineLength

Defines the max number of characters per line.

If several endLineChar appear before the lineLength character, only the last endLineChar is taken into account. if lineLength = LINE_LENGTH_MAX, the lines length is not limited, and if lineLength = LINE_LENGTH_MIN, the lines are limited to one word.

Example of use with the string "United States of America" (24 characters) :

with endLineChar = ' ' and lineLength = 15, the string is cut into two lines: "United States" and "of America".

with endLineChar = ' ' and lineLength = 18, the string is cut into two lines: "United States of" and "America".

Be careful, words (consecutive characters delimited by endLineChar characters) are never truncated, so lines could exceed lineLength characters if the first word of the line contains more than lineLength characters.

SoSFBool PoMiscTextAttr::outliningEnabled

Enables/Disables drawing of the outline of polygonal text (SoText3 and SoAnnoText3).

For filled text that is small relative to the viewer size, drawing the outline improves the appearance of the text. For larger text, the outline can be deactivated to improve performance and prevent the text having a bold appearance.

NOTE: field available since Open Inventor 4.0

SoSFBool PoMiscTextAttr::predefinedProfileEnabled

Enables/Disables the use of a predefined profile for 3D text if they are activated (cf profileEnabled field).

If this field is set to FALSE, the current profile in the state is used (cf SoLinearProfile,...)

SoSFBool PoMiscTextAttr::profileEnabled

Enables/Disables the appearance of a profile for 3D Text.

Only SoText3 text takes into account of this option (cf PoBase::setTextType()) to to select the type of text used).