.TH "SoTextDetail" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoTextDetail \- The \fBSoTextDetail\fP stores information about a character in a string\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/details/SoTextDetail\&.h>\fP
.PP
Inherits \fBSoDetail\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoTextDetail\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoTextDetail\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcopy\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetStringIndex\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetCharacterIndex\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetPart\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetStringIndex\fP (\fBconst\fP int idx)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetCharacterIndex\fP (\fBconst\fP int idx)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetPart\fP (\fBconst\fP int idx)"
.br
.in -1c

Public Member Functions inherited from \fBSoDetail\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP \fB~SoDetail\fP ()"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBconst\fP \fBSoType\fP type) \fBconst\fP"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoDetail\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Member Functions inherited from \fBSoDetail\fP
.in +1c
.ti -1c
.RI "\fBSoDetail\fP (\fBvoid\fP)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoTextDetail\fP 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\&.
.PP
\fBSee also\fP
.RS 4
\fBSoRayPickAction\fP, \fBSoCallbackAction\fP 
.PP
\fBSoText3\fP, \fBSoText2\fP, \fBSoAsciiText\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoTextDetail::SoTextDetail (\fBvoid\fP)"
Constructor sets up an 'empty' detail; all indices are set to -1 to indicate this\&. 
.SS "SoTextDetail::~SoTextDetail ()\fC [virtual]\fP"
Destructor\&. This class does not allocate any extra resources, so no actions are taken\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoTextDetail::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoDetail\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Implements \fBSoDetail\fP\&.
.SS "\fBSoType\fP SoTextDetail::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBstatic\fP \fBvoid\fP SoTextDetail::cleanupClass (\fBvoid\fP)\fC [inline]\fP, \fC [static]\fP"
This static method cleans up static data of the class\&. 
.br
 
.SS "\fBSoDetail\fP * SoTextDetail::copy (\fBvoid\fP) const\fC [virtual]\fP"
Return a deep copy of ourself\&.
.PP
\fBNote that if the Coin library has been built as a DLL under Microsoft Windows and you use this method from application code, you \fImust\fP 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 \fIwill\fP get memory heap corruption upon deallocating the returned instances, eventually leading to mysterious crashes\&.\fP
.br

.br

.PP
Implements \fBSoDetail\fP\&.
.SS "int SoTextDetail::getStringIndex (\fBvoid\fP) const"
Returns the index of the string where a character was hit / generated, from a set of multiple strings\&.
.PP
\fBSee also\fP
.RS 4
\fBSoMFString\fP 
.RE
.PP

.SS "int SoTextDetail::getCharacterIndex (\fBvoid\fP) const"
Returns the index of the character in the string which was hit\&.
.PP
\fBSee also\fP
.RS 4
\fBgetStringIndex()\fP 
.RE
.PP

.SS "int SoTextDetail::getPart (\fBvoid\fP) const"
For \fBSoText3\fP, returns the part id of the text geometry\&. The id numbers matches those specified in the \fBSoText3::Part\fP enumeration\&. 
.SS "\fBvoid\fP SoTextDetail::setStringIndex (\fBconst\fP int idx)"
Internal method for 'client' shape nodes to initialize this \fBSoTextDetail\fP instance\&. 
.SS "\fBvoid\fP SoTextDetail::setCharacterIndex (\fBconst\fP int idx)"
Internal method for 'client' shape nodes to initialize this \fBSoTextDetail\fP instance\&. 
.SS "\fBvoid\fP SoTextDetail::setPart (\fBconst\fP int partarg)"
Internal method for 'client' shape nodes to initialize this \fBSoTextDetail\fP instance\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.