.TH "SoText2" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoText2 \- The \fBSoText2\fP class is a node type for visualizing 2D text aligned with the camera plane\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <Inventor/nodes/SoText2\&.h>\fP
.PP
Inherits \fBSoShape\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBJustification\fP { \fBLEFT\fP = 1, \fBRIGHT\fP, \fBCENTER\fP }"
.br
.in -1c

Public Types inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "enum \fBTriangleShape\fP { \fBTRIANGLE_STRIP\fP, \fBTRIANGLE_FAN\fP, \fBTRIANGLES\fP, \fBPOLYGON\fP, \fBQUADS\fP, \fBQUAD_STRIP\fP, \fBPOINTS\fP, \fBLINES\fP, \fBLINE_STRIP\fP }"
.br
.in -1c

Public Types inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "enum \fBNodeType\fP { \fBINVENTOR\fP = 0x0000, \fBVRML1\fP = 0x0001, \fBVRML2\fP = 0x0002, \fBINVENTOR_1\fP = 0x0004, \fBINVENTOR_2_0\fP = 0x0008, \fBINVENTOR_2_1\fP = 0x0010, \fBINVENTOR_2_5\fP = 0x0020, \fBINVENTOR_2_6\fP = 0x0040, \fBCOIN_1_0\fP = 0x0080, \fBCOIN_2_0\fP = 0x0100, \fBEXTENSION\fP = 0x0200, \fBCOIN_2_2\fP = 0x0400, \fBCOIN_2_3\fP = 0x0800, \fBCOIN_2_4\fP = 0x1000, \fBINVENTOR_5_0\fP = 0x2000, \fBCOIN_2_5\fP = 0x4000, \fBCOIN_3_0\fP = 0x8000, \fBINVENTOR_6_0\fP = 0x10000, \fBCOIN_4_0\fP = 0x20000 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoText2\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBrayPick\fP (\fBSoRayPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.in -1c

Public Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBvirtual\fP SbBool \fBaffectsState\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBnotify\fP (\fBSoNotList\fP *\fBnl\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetBoundingBox\fP (\fBSoGetBoundingBoxAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcallback\fP (\fBSoCallbackAction\fP *action)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoBoundingBoxCache\fP * \fBgetBoundingBoxCache\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetOverride\fP (\fBconst\fP SbBool state)"
.br
.ti -1c
.RI "SbBool \fBisOverride\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetNodeType\fP (\fBconst\fP \fBNodeType\fP type)"
.br
.ti -1c
.RI "\fBNodeType\fP \fBgetNodeType\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBcopy\fP (SbBool \fBcopyconnections\fP=FALSE) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdoAction\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderBelowPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderInPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBGLRenderOffPath\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetMatrix\fP (\fBSoGetMatrixAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBhandleEvent\fP (\fBSoHandleEventAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBpick\fP (\fBSoPickAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsearch\fP (\fBSoSearchAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwrite\fP (\fBSoWriteAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaudioRender\fP (\fBSoAudioRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsSetup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgrabEventsCleanup\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBstartNotify\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbUniqueId \fBgetNodeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoChildList\fP * \fBgetChildren\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBwriteInstance\fP (\fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNode\fP * \fBaddToCopyDict\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcopyContents\fP (\fBconst\fP \fBSoFieldContainer\fP *from, SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoFieldContainer\fP * \fBcopyThroughConnection\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBsetToDefaults\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasDefaultValues\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBfieldsAreEqual\fP (\fBconst\fP \fBSoFieldContainer\fP *container) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBcopyFieldValues\fP (\fBconst\fP \fBSoFieldContainer\fP *container, SbBool \fBcopyconnections\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *\fBconst\fP fielddata)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata)"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP int \fBgetAllFields\fP (\fBSoFieldList\fP &\fBl\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetField\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventIn\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoField\fP * \fBgetEventOut\fP (\fBconst\fP \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBgetFieldName\fP (\fBconst\fP \fBSoField\fP *\fBconst\fP \fBfield\fP, \fBSbName\fP &name) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBenableNotify\fP (\fBconst\fP SbBool \fBflag\fP)"
.br
.ti -1c
.RI "SbBool \fBisNotifyEnabled\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBset\fP (\fBconst\fP char *fielddata, \fBSoInput\fP *input)"
.br
.ti -1c
.RI "\fBvoid\fP \fBget\fP (\fBSbString\fP &fielddata, \fBSoOutput\fP *\fBout\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBvalidateNewFieldValue\fP (\fBSoField\fP *\fBfield\fP, \fBvoid\fP *\fBnewval\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBaddWriteReference\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisfromfield\fP=FALSE)"
.br
.ti -1c
.RI "SbBool \fBgetIsBuiltIn\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgetFieldsMemorySize\fP (size_t &\fBmanaged\fP, size_t &\fBunmanaged\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetUserData\fP (\fBvoid\fP *userdata) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP * \fBgetUserData\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBvoid\fP \fBref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunref\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBunrefNoDelete\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int32_t \fBgetRefCount\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBtouch\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBisOfType\fP (\fBSoType\fP type) \fBconst\fP"
.br
.RI "Returns \fCTRUE\fP if the type of this object is either of the same type or inherited from \fItype\fP\&. "
.ti -1c
.RI "\fBvirtual\fP \fBSbName\fP \fBgetName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBsetName\fP (\fBconst\fP \fBSbName\fP &\fBnewname\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBaddAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBvoid\fP \fBremoveAuditor\fP (\fBvoid\fP *\fBconst\fP \fBauditor\fP, \fBconst\fP \fBSoNotRec::Type\fP type)"
.br
.ti -1c
.RI "\fBconst\fP \fBSoAuditorList\fP & \fBgetAuditors\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBshouldWrite\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBassertAlive\fP (\fBvoid\fP) \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 \fBinitClass\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetScreenSize\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP \fBSbBox3f\fP &boundingbox, \fBSbVec2s\fP &\fBrectsize\fP)"
.br
.ti -1c
.RI "\fBstatic\fP float \fBgetDecimatedComplexity\fP (\fBSoState\fP *state, float complexity)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoNode\fP * \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetByName\fP (\fBconst\fP \fBSbName\fP &name, \fBSoNodeList\fP &\fBl\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClasses\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBgetNextNodeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetActionMethodIndex\fP (\fBconst\fP \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetBoundingBoxS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBGLRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcallbackS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetMatrixS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBhandleEventS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBpickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBrayPickS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsearchS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBwriteS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaudioRenderS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBgetPrimitiveCountS\fP (\fBSoAction\fP *action, \fBSoNode\fP *node)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.   "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&.   "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcleanupClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitCopyDict\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP \fBSoFieldContainer\fP *copy)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBcheckCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoFieldContainer\fP * \fBfindCopy\fP (\fBconst\fP \fBSoFieldContainer\fP *\fBorig\fP, \fBconst\fP SbBool \fBcopyconnections\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBcopyDone\fP (\fBvoid\fP)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&. "
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.RI "This static method returns the \fBSoType\fP object associated with objects of this class\&. "
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBaddName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBremoveName\fP (\fBSoBase\fP *\fBconst\fP base, \fBconst\fP char *\fBconst\fP name)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBdecrementCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoBase\fP * \fBgetNamedBase\fP (\fBconst\fP \fBSbName\fP &name, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNamedBases\fP (\fBconst\fP \fBSbName\fP &name, \fBSoBaseList\fP &\fBbaselist\fP, \fBSoType\fP type)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBread\fP (\fBSoInput\fP *input, \fBSoBase\fP *&base, \fBSoType\fP \fBexpectedtype\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetInstancePrefix\fP (\fBconst\fP \fBSbString\fP &c)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetTraceRefs\fP (SbBool \fBtrace\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBgetTraceRefs\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBconnectRoute\fP (\fBSoInput\fP *input, \fBconst\fP \fBSbName\fP &\fBfromnodename\fP, \fBconst\fP \fBSbName\fP &\fBfromfieldname\fP, \fBconst\fP \fBSbName\fP &\fBtonodename\fP, \fBconst\fP \fBSbName\fP &\fBtofieldname\fP)"
.br
.ti -1c
.RI "\fBstatic\fP SbBool \fBreadRoute\fP (\fBSoInput\fP *input)"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBSoMFString\fP \fBstring\fP"
.br
.ti -1c
.RI "\fBSoSFFloat\fP \fBspacing\fP"
.br
.ti -1c
.RI "\fBSoSFEnum\fP \fBjustification\fP"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP \fBSoFieldData\fP * \fBgetFieldData\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoText2\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBgeneratePrimitives\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcomputeBBox\fP (\fBSoAction\fP *action, \fBSbBox3f\fP &\fBbox\fP, \fBSbVec3f\fP &center)"
.br
.in -1c

Protected Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBSoShape\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoShape\fP ()"
.br
.ti -1c
.RI "float \fBgetComplexityValue\fP (\fBSoAction\fP *action)"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBshouldGLRender\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBbeginSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBendSolidShape\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBGLRenderBoundingBox\fP (\fBSoGLRenderAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldPrimitiveCount\fP (\fBSoGetPrimitiveCountAction\fP *action)"
.br
.ti -1c
.RI "SbBool \fBshouldRayPick\fP (\fBSoRayPickAction\fP *\fBconst\fP action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *\fBconst\fP action)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcomputeObjectSpaceRay\fP (\fBSoRayPickAction\fP *\fBconst\fP action, \fBconst\fP \fBSbMatrix\fP &matrix)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreateTriangleDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv2\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv3\fP, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreateLineSegmentDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBv2\fP, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoDetail\fP * \fBcreatePointDetail\fP (\fBSoRayPickAction\fP *action, \fBconst\fP \fBSoPrimitiveVertex\fP *v, \fBSoPickedPoint\fP *\fBpp\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokeTriangleCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv2\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv3\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokeLineSegmentCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv1\fP, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP \fBv2\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBinvokePointCallbacks\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP v)"
.br
.ti -1c
.RI "\fBvoid\fP \fBbeginShape\fP (\fBSoAction\fP *\fBconst\fP action, \fBconst\fP \fBTriangleShape\fP \fBshapetype\fP, \fBSoDetail\fP *\fBconst\fP detail=\fBNULL\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBshapeVertex\fP (\fBconst\fP \fBSoPrimitiveVertex\fP *\fBconst\fP v)"
.br
.ti -1c
.RI "\fBvoid\fP \fBendShape\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *\fBconst\fP \fBpv\fP, \fBconst\fP \fBSbVec3f\fP &point, \fBconst\fP SbBool \fBuseTexFunc\fP, \fBconst\fP \fBSoMultiTextureCoordinateElement\fP *\fBconst\fP \fBtce\fP, \fBconst\fP float s, \fBconst\fP float t, \fBconst\fP \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "\fBvoid\fP \fBgenerateVertex\fP (\fBSoPrimitiveVertex\fP *\fBconst\fP \fBpv\fP, \fBconst\fP \fBSbVec3f\fP &point, \fBconst\fP SbBool \fBuseTexFunc\fP, \fBconst\fP \fBSoMultiTextureCoordinateElement\fP *\fBconst\fP \fBtce\fP, \fBconst\fP float s, \fBconst\fP float t, \fBconst\fP float r, \fBconst\fP \fBSbVec3f\fP &normal)"
.br
.ti -1c
.RI "SbBool \fBstartVertexArray\fP (\fBSoGLRenderAction\fP *action, \fBconst\fP \fBSoCoordinateElement\fP *coords, \fBconst\fP \fBSbVec3f\fP *\fBpervertexnormals\fP, \fBconst\fP SbBool \fBtexpervertex\fP, \fBconst\fP SbBool colorpervertex)"
.br
.ti -1c
.RI "\fBvoid\fP \fBfinishVertexArray\fP (\fBSoGLRenderAction\fP *action, \fBconst\fP SbBool vbo, \fBconst\fP SbBool \fBnormpervertex\fP, \fBconst\fP SbBool \fBtexpervertex\fP, \fBconst\fP SbBool colorpervertex)"
.br
.in -1c

Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBSoNode\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoNode\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP SbBool \fBreadInstance\fP (\fBSoInput\fP *\fBin\fP, \fBunsigned\fP short flags)"
.br
.in -1c

Protected Member Functions inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "\fBSoFieldContainer\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoFieldContainer\fP ()"
.br
.in -1c

Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBSoBase\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoBase\fP ()"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBdestroy\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "SbBool \fBhasMultipleWriteRefs\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "SbBool \fBwriteHeader\fP (\fBSoOutput\fP *\fBout\fP, SbBool \fBisgroup\fP, SbBool \fBisengine\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwriteFooter\fP (\fBSoOutput\fP *\fBout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBconst\fP char * \fBgetFileFormatName\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoNotRec\fP \fBcreateNotRec\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoShape\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBconst\fP \fBSoFieldData\fP ** \fBgetFieldDataPtr\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetNextActionMethodIndex\fP (int index)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBincNextActionMethodIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBsetCompatibilityTypes\fP (\fBconst\fP \fBSoType\fP &nodetype, \fBconst\fP uint32_t \fBbitmask\fP)"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP uint32_t \fBgetCurrentWriteCounter\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataLock\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBstaticDataUnlock\fP (\fBvoid\fP)"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Types inherited from \fBSoBase\fP
.in +1c
.ti -1c
.RI "enum \fBBaseFlags\fP { \fBIS_ENGINE\fP = 0x01, \fBIS_GROUP\fP = 0x02 }"
.br
.in -1c

Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "SbUniqueId \fBuniqueId\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoFieldContainer\fP
.in +1c
.ti -1c
.RI "SbBool \fBisBuiltIn\fP"
.br
.in -1c

Static Protected Attributes inherited from \fBSoNode\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP SbUniqueId \fBnextUniqueId\fP = 1"
.br
.ti -1c
.RI "\fBstatic\fP int \fBnextActionMethodIndex\fP = 0"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoText2\fP class is a node type for visualizing 2D text aligned with the camera plane\&. 

\fBSoText2\fP text is not scaled according to the distance from the camera, and is not influenced by rotation or scaling as 3D primitives are\&. If these are properties that you want the text to have, you should instead use an \fBSoText3\fP or \fBSoAsciiText\fP node\&.
.PP
Note that even though the size of the 2D text is not influenced by the distance from the camera, the text is still subject to the usual rules with regard to the depth buffer, so it \fIwill\fP be obscured by graphics laying in front of it\&.
.PP
The text will be \fIpositioned\fP according to the current transformation\&. The x origin of the text is the first pixel of the leftmost character of the text\&. The y origin of the text is the baseline of the first line of text (the baseline being the imaginary line on which all upper case characters are standing)\&.
.PP
The size of the fonts on screen is decided from the \fBSoFont::size\fP field of a preceding SoFont-node in the scene graph, which specifies the size in pixel dimensions\&. This value sets the approximate vertical dimension of the letters\&. The default value if no SoFont-nodes are used, is 10\&.
.PP
One important issue about rendering performance: since the positioning and rendering of an \fBSoText2\fP node depends on the current viewport and camera, having \fBSoText2\fP nodes in the scene graph will lead to a cache dependency on the previously encountered SoCamera-node\&. This can have severe influence on the rendering performance, since if the camera is above the \fBSoText2\fP's nearest parent \fBSoSeparator\fP, the \fBSoSeparator\fP will not be able to cache the geometry under it\&.
.PP
(Even worse rendering performance will be forced if the \fBSoSeparator::renderCaching\fP flag is explicitly set to \fCON\fP, as the \fBSoSeparator\fP node will then continuously generate and destruct the same cache as the camera moves\&.)
.PP
\fBSoText2\fP nodes are therefore best positioned under their own \fBSoSeparator\fP node, outside areas in the scene graph that otherwise contains static geometry\&.
.PP
Also note that \fBSoText2\fP nodes cache the ids and positions of each glyph bitmap used to render \fCstring\fP\&. This means that \fCUSE\fP of a \fCDEF'ed\fP \fBSoText2\fP node, with a different font, will be noticeably slower than using two separate \fBSoText2\fP nodes, one for each font, since it will have to recalculate glyph bitmap ids and positions for each call to \fCGLrender()\fP\&.
.PP
\fBSoScale\fP nodes cannot be used to influence the dimensions of the rendering output of \fBSoText2\fP nodes\&.
.PP
\fBFILE FORMAT/DEFAULTS:\fP 
.PP
.nf
Text2 {
    string ""
    spacing 1
    justification LEFT
}

.fi
.PP
.PP
\fBSee also\fP
.RS 4
\fBSoFont\fP, \fBSoFontStyle\fP, \fBSoText3\fP, \fBSoAsciiText\fP 
.RE
.PP

.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBSoText2::Justification\fP"
Used to specify horizontal string alignment\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fILEFT \fP\fP
Left edges of strings are aligned\&. 
.TP
\fB\fIRIGHT \fP\fP
Right edges of strings are aligned\&. 
.TP
\fB\fICENTER \fP\fP
Centers of strings are aligned\&. 
.SH "Constructor & Destructor Documentation"
.PP 
.SS "SoText2::SoText2 (\fBvoid\fP)"
Constructor\&. 
.SS "SoText2::~SoText2 ()\fC [protected]\fP, \fC [virtual]\fP"
Destructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoText2::getClassTypeId (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "\fBSoType\fP SoText2::getTypeId (\fBvoid\fP) const\fC [virtual]\fP"
Returns the type identification of an object derived from a class inheriting \fBSoBase\fP\&. This is used for runtime type checking and 'downward' casting\&. 
.br
 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBconst\fP \fBSoFieldData\fP ** SoText2::getFieldDataPtr (\fBvoid\fP)\fC [static]\fP, \fC [protected]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Returns the \fBSoFieldData\fP class which holds information about fields in this node\&. 
.br
 
.SS "\fBconst\fP \fBSoFieldData\fP * SoText2::getFieldData (\fBvoid\fP) const\fC [protected]\fP, \fC [virtual]\fP"
Returns a pointer to the class-wide field data storage object for this instance\&. If no fields are present, returns \fCNULL\fP\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoText2::initClass (\fBvoid\fP)\fC [static]\fP"

.SS "\fBvoid\fP SoText2::GLRender (\fBSoGLRenderAction\fP * action)\fC [virtual]\fP"
Action method for the \fBSoGLRenderAction\fP\&.
.PP
This is called during rendering traversals\&. Nodes influencing the rendering state in any way or want to throw geometry primitives at OpenGL override this method\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoText2::rayPick (\fBSoRayPickAction\fP * action)\fC [virtual]\fP"
Calculates picked point based on primitives generated by subclasses\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoText2::getPrimitiveCount (\fBSoGetPrimitiveCountAction\fP * action)\fC [virtual]\fP"
Action method for the \fBSoGetPrimitiveCountAction\fP\&.
.PP
Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the \fIaction\fP\&.
.PP
Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables\&. 
.PP
Reimplemented from \fBSoShape\fP\&.
.SS "\fBvoid\fP SoText2::generatePrimitives (\fBSoAction\fP * action)\fC [protected]\fP, \fC [virtual]\fP"
The method implements action behavior for shape nodes for \fBSoCallbackAction\fP\&. It is invoked from \fBSoShape::callback()\fP\&. (Subclasses should \fInot\fP override \fBSoNode::callback()\fP\&.)
.PP
The subclass implementations uses the convenience methods \fBSoShape::beginShape()\fP, \fBSoShape::shapeVertex()\fP, and \fBSoShape::endShape()\fP, with \fBSoDetail\fP instances, to pass the primitives making up the shape back to the caller\&. 
.PP
Implements \fBSoShape\fP\&.
.SS "\fBvoid\fP SoText2::computeBBox (\fBSoAction\fP * action, \fBSbBox3f\fP & box, \fBSbVec3f\fP & center)\fC [protected]\fP, \fC [virtual]\fP"
Implemented by \fBSoShape\fP subclasses to let the \fBSoShape\fP superclass know the exact size and weighted center point of the shape's bounding box\&.
.PP
The bounding box and center point should be calculated and returned in the local coordinate system\&.
.PP
The method implements action behavior for shape nodes for \fBSoGetBoundingBoxAction\fP\&. It is invoked from \fBSoShape::getBoundingBox()\fP\&. (Subclasses should \fInot\fP override \fBSoNode::getBoundingBox()\fP\&.)
.PP
The \fIbox\fP parameter sent in is guaranteed to be an empty box, while \fIcenter\fP is undefined upon function entry\&. 
.PP
Implements \fBSoShape\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBSoMFString\fP SoText2::string"
The set of strings to render\&. Each string in the multiple value field will be rendered on a separate line\&.
.PP
The default value of the field is a single empty string\&. 
.SS "\fBSoSFFloat\fP SoText2::spacing"
Vertical spacing between the baselines of two consecutive horizontal lines\&. Default value is \fB1\&.0\fP, which means that it is equal to the vertical size of the highest character in the bitmap alphabet\&. 
.SS "\fBSoSFEnum\fP SoText2::justification"
Determines horizontal alignment of text strings\&.
.PP
If justification is set to \fBSoText2::LEFT\fP, the left edge of the first string is at the origin and all strings are aligned with their left edges\&. If set to \fBSoText2::RIGHT\fP, the right edge of the first string is at the origin and all strings are aligned with their right edges\&. Otherwise, if set to \fBSoText2::CENTER\fP, the center of the first string is at the origin and all strings are aligned with their centers\&. The origin is always located at the baseline of the first line of text\&.
.PP
Default value is \fBSoText2::LEFT\fP\&. 

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