Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

SoTextDetail Class Reference
[Detail classes]

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

#include <Inventor/details/SoTextDetail.h>

Inheritance diagram for SoTextDetail:

SoDetail List of all members.

Public Member Functions

 SoTextDetail (void)
virtual ~SoTextDetail ()
virtual SoDetailcopy (void) const
int getStringIndex (void) const
int getCharacterIndex (void) const
int getPart (void) const
void setStringIndex (const int idx)
void setCharacterIndex (const int idx)
void setPart (const int idx)

Static Public Member Functions

void initClass (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 void   ) 
 

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

SoTextDetail::~SoTextDetail  )  [virtual]
 

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


Member Function Documentation

void SoTextDetail::initClass void   )  [static]
 

Initialize relevant common data for all instances, like the type system.

Reimplemented from SoDetail.

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 is 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.

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

int SoTextDetail::getCharacterIndex void   )  const
 

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

See also:
getStringIndex()

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.

void SoTextDetail::setStringIndex const int  idx  ) 
 

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

void SoTextDetail::setCharacterIndex const int  idx  ) 
 

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

void SoTextDetail::setPart const int  part  ) 
 

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


The documentation for this class was generated from the following files:
Generated on Tue Jul 27 23:53:08 2004 for Coin by doxygen 1.3.7