Open Inventor Reference
SoTextDetail Class Reference

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

#include <Inventor/details/SoTextDetail.h>

Inheritance diagram for SoTextDetail:
SoDetail

List of all members.

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 SoDetailcopy () 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)

Static Public Member Functions

static void initClass ()

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 ( )
virtual SoTextDetail::~SoTextDetail ( ) [virtual]

Member Function Documentation

virtual SoDetail* SoTextDetail::copy ( ) const [virtual]

The caller is responsible for deleting the copy when done.

Implements SoDetail.

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.

SoText3::Part SoTextDetail::getPart ( ) const [inline]

Definition at line 99 of file SoTextDetail.h.

int32_t SoTextDetail::getStringIndex ( ) const [inline]

Definition at line 91 of file SoTextDetail.h.

static void SoTextDetail::initClass ( ) [static]

Reimplemented from SoDetail.

void SoTextDetail::setCharacterIndex ( long  i) [inline]
Parameters:
iSystem long

Definition at line 116 of file SoTextDetail.h.

References setCharacterIndex().

Referenced by setCharacterIndex().

void SoTextDetail::setCharacterIndex ( int32_t  i) [inline]

Definition at line 111 of file SoTextDetail.h.

void SoTextDetail::setPart ( SoText3::Part  p) [inline]

Definition at line 107 of file SoTextDetail.h.

void SoTextDetail::setStringIndex ( long  i) [inline]
Parameters:
iSystem long

Definition at line 114 of file SoTextDetail.h.

References setStringIndex().

Referenced by setStringIndex().

void SoTextDetail::setStringIndex ( int32_t  i) [inline]

Definition at line 110 of file SoTextDetail.h.


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