SoTextDetail Class Reference

The SoTextDetail stores information about a character in a string. More...

#include <Inventor/details/SoTextDetail.h>

Inheritance diagram for SoTextDetail:

Public Member Functions
	SoTextDetail (void)
virtual	~SoTextDetail ()
virtual SoDetail *	copy (void) const
int	getCharacterIndex (void) const
int	getPart (void) const
int	getStringIndex (void) const
virtual SoType	getTypeId (void) const
void	setCharacterIndex (const int idx)
void	setPart (const int idx)
void	setStringIndex (const int idx)
Public Member Functions inherited from SoDetail
virtual	~SoDetail ()
SbBool	isOfType (const SoType type) const

Static Public Member Functions
static void	cleanupClass (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoDetail
static SoType	getClassTypeId (void)
static void	initClass (void)
static void	initClasses (void)

Additional Inherited Members
Protected Member Functions inherited from SoDetail
	SoDetail (void)

Detailed Description

The SoTextDetail stores information about a character in a string.

Instances of this class are used for storing information about hit points on textual 2D or 3D geometry after pick operations, and for storing information returned to tessellation callbacks.

See also

SoRayPickAction, SoCallbackAction

SoText3, SoText2, SoAsciiText

Constructor & Destructor Documentation

SoTextDetail()

SoTextDetail::SoTextDetail

(

void

)

Constructor sets up an "empty" detail; all indices are set to -1 to indicate this.

~SoTextDetail()

SoTextDetail::~SoTextDetail ( )

virtual

Destructor. This class does not allocate any extra resources, so no actions are taken.

Member Function Documentation

cleanupClass()

static void SoTextDetail::cleanupClass ( void )

inlinestatic

This static method cleans up static data of the class.

copy()

SoDetail * SoTextDetail::copy ( void ) const

virtual

Return a deep copy of ourself.

Note that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you must make sure that both the Coin DLL and the application executable are using the same instance of a C Run-Time (CRT) library. Otherwise, you will get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes.

Implements SoDetail.

getCharacterIndex()

int SoTextDetail::getCharacterIndex

(

void

)

const

Returns the index of the character in the string which was hit.

See also

getStringIndex()

getClassTypeId()

SoType SoTextDetail::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getPart()

int SoTextDetail::getPart

(

void

)

const

For SoText3, returns the part id of the text geometry. The id numbers matches those specified in the SoText3::Part enumeration.

getStringIndex()

int SoTextDetail::getStringIndex

(

void

)

const

Returns the index of the string where a character was hit / generated, from a set of multiple strings.

See also

SoMFString

getTypeId()

SoType SoTextDetail::getTypeId ( void ) const

virtual

Returns the type identification of an object derived from a class inheriting SoDetail. This is used for runtime type checking and "downward" casting.

Implements SoDetail.

setCharacterIndex()

void SoTextDetail::setCharacterIndex

(

const int

idx

)

Internal method for "client" shape nodes to initialize this SoTextDetail instance.

setPart()

void SoTextDetail::setPart

(

const int

partarg

)

Internal method for "client" shape nodes to initialize this SoTextDetail instance.

setStringIndex()

void SoTextDetail::setStringIndex

(

const int

idx

)

Internal method for "client" shape nodes to initialize this SoTextDetail instance.

---

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

• SoTextDetail.h
• SoTextDetail.cpp