SoTextDetail Class Reference

Stores detail information about a text node. More...

#include <Inventor/details/SoTextDetail.h>

Inheritance diagram for SoTextDetail:

Public Member Functions
virtual SoType	getTypeId () const
	Returns the type identifier for this specific instance.
	SoTextDetail ()
	Constructor.
virtual	~SoTextDetail ()
	Destructor.
int32_t	getStringIndex () const
	Returns the index of the relevant string within a multiple-value string field of a text node.
int32_t	getCharacterIndex () const
	Returns the index of the relevant character within the string.
SoText3::Part	getPart () const
	For SoText3, this returns which part was picked or generated.
virtual SoDetail *	copy () const
	Returns an instance that is a copy of this instance.
Public Member Functions inherited from SoTypedObject
SbBool	isOfType (const SoType &type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
template<typename TypedObjectClass >
SbBool	isOfType () const
	Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class.

Static Public Member Functions
static SoType	getClassTypeId ()
	Returns the type identifier for this class.
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId ()
	Returns type identifier for this class.
Static Public Member Functions inherited from SoTypedObject
static SoType	getClassTypeId ()
	Returns the type identifier for this class.

Detailed Description

Stores detail information about a text node.

This class contains detail information about a point on a text shape (SoText2 or SoText3). It contains the part of the text, string, and character that were hit or generated.

SEE ALSO

SoText2, SoText3, SoDetail, SoPickedPoint, SoPrimitiveVertex

Definition at line 86 of file SoTextDetail.h.

Constructor & Destructor Documentation

SoTextDetail()

SoTextDetail::SoTextDetail

(

)

Constructor.

~SoTextDetail()

virtual SoTextDetail::~SoTextDetail ( )

virtual

Destructor.

Member Function Documentation

copy()

virtual SoDetail * SoTextDetail::copy ( ) const

virtual

Returns an instance that is a copy of this instance.

The caller is responsible for deleting the copy when it is no longer needed.

Implements SoDetail.

getCharacterIndex()

int32_t SoTextDetail::getCharacterIndex ( ) const

inline

Returns the index of the relevant character within the string.

For example, if the character of detail was the "u" within "Splurmph", the character index would be 3.

Definition at line 111 of file SoTextDetail.h.

getClassTypeId()

static SoType SoTextDetail::getClassTypeId ( )

static

Returns the type identifier for this class.

getPart()

SoText3::Part SoTextDetail::getPart ( ) const

inline

For SoText3, this returns which part was picked or generated.

Definition at line 116 of file SoTextDetail.h.

getStringIndex()

int32_t SoTextDetail::getStringIndex ( ) const

inline

Returns the index of the relevant string within a multiple-value string field of a text node.

Definition at line 104 of file SoTextDetail.h.

getTypeId()

virtual SoType SoTextDetail::getTypeId ( ) const

virtual

Returns the type identifier for this specific instance.

Implements SoTypedObject.

---

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

• Inventor/details/SoTextDetail.h