SoTextDetail Class Reference

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

#include <Inventor/details/SoTextDetail.h>

Inheritance diagram for SoTextDetail:

Public Member Functions
	SoTextDetail ()
	Constructor and destructor.
virtual	~SoTextDetail ()
	Constructor and 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 Text3, this returns which part was picked:
virtual SoDetail *	copy () const
	Returns an instance that is a copy of this instance.
void	setPart (SoText3::Part p)
	For Text3, this sets which part is picked:
void	setStringIndex (int32_t i)
	These set the string and character indices:
void	setCharacterIndex (int32_t i)
void	setStringIndex (long i)
void	setCharacterIndex (long i)
Public Member Functions inherited from SoDetail
virtual	~SoDetail ()
	Destructor.
virtual SoType	getTypeId () const =0
	Returns the type identifier for a specific instance.
bool	isOfType (SoType type) const
	Returns TRUE if this object is of the type specified in type or is derived from that type.
virtual SoDetail *	copy () const =0
	Returns an instance that is a copy of this instance.

Static Public Member Functions
static void	initClass ()
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId ()
	Returns type identifier for this class.
static void	initClass ()
static void	initClasses ()
	Initialize ALL Inventor detail classes.

Additional Inherited Members
Protected Member Functions inherited from SoDetail
	SoDetail ()
	Constructor is protected since this is an abstract class.

Detailed Description

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 78 of file SoTextDetail.h.

Constructor & Destructor Documentation

SoTextDetail()

SoTextDetail::SoTextDetail

(

)

~SoTextDetail()

virtual SoTextDetail::~SoTextDetail ( )

virtual

Member Function Documentation

copy()

virtual SoDetail * SoTextDetail::copy ( ) const

virtual

The caller is responsible for deleting the copy when done.

Implements SoDetail.

getCharacterIndex()

int32_t SoTextDetail::getCharacterIndex ( ) const

inline

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

Definition at line 96 of file SoTextDetail.h.

getPart()

SoText3::Part SoTextDetail::getPart ( ) const

inline

Definition at line 99 of file SoTextDetail.h.

getStringIndex()

int32_t SoTextDetail::getStringIndex ( ) const

inline

Definition at line 91 of file SoTextDetail.h.

initClass()

static void SoTextDetail::initClass ( )

static

setCharacterIndex() [1/2]

void SoTextDetail::setCharacterIndex ( int32_t  i )

inline

Definition at line 111 of file SoTextDetail.h.

setCharacterIndex() [2/2]

void SoTextDetail::setCharacterIndex ( long  i )

inline

Parameters

i	System long

Definition at line 116 of file SoTextDetail.h.

setPart()

void SoTextDetail::setPart ( SoText3::Part  p )

inline

Definition at line 107 of file SoTextDetail.h.

setStringIndex() [1/2]

void SoTextDetail::setStringIndex ( int32_t  i )

inline

Definition at line 110 of file SoTextDetail.h.

setStringIndex() [2/2]

void SoTextDetail::setStringIndex ( long  i )

inline

Parameters

i	System long

Definition at line 114 of file SoTextDetail.h.

---

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

• C:/jh/mevislab/4.0.2_1/build/MeVis/ThirdParty/Sources/Inventor/include/Inventor/details/SoTextDetail.h