--- name: "SoText3" section: "3" platform: "linux" package: "coin" version: "1:4.0.10-1" release: "Arch Linux 2026-11-01" platforms: ["linux"] url: "https://new.carta.tech/SoText3" --- # SoText3(3) The SoText3 class renders extruded 3D text. ## NAME SoText3 - The **SoText3** class renders extruded 3D text. ## SYNOPSIS \#include \ Inherits **SoShape**. ### Public Types enum **Part** { **FRONT** = 1, **SIDES** = 2, **BACK** = 4, **ALL** = FRONT\|BACK\|SIDES }\ enum **Justification** { **LEFT** = 1, **RIGHT**, **CENTER** }\ Public Types inherited from **SoShape** enum **TriangleShape** { **TRIANGLE\_STRIP**, **TRIANGLE\_FAN**, **TRIANGLES**, **POLYGON**, **QUADS**, **QUAD\_STRIP**, **POINTS**, **LINES**, **LINE\_STRIP** }\ Public Types inherited from **SoNode** enum **NodeType** { **INVENTOR** = 0x0000, **VRML1** = 0x0001, **VRML2** = 0x0002, **INVENTOR\_1** = 0x0004, **INVENTOR\_2\_0** = 0x0008, **INVENTOR\_2\_1** = 0x0010, **INVENTOR\_2\_5** = 0x0020, **INVENTOR\_2\_6** = 0x0040, **COIN\_1\_0** = 0x0080, **COIN\_2\_0** = 0x0100, **EXTENSION** = 0x0200, **COIN\_2\_2** = 0x0400, **COIN\_2\_3** = 0x0800, **COIN\_2\_4** = 0x1000, **INVENTOR\_5\_0** = 0x2000, **COIN\_2\_5** = 0x4000, **COIN\_3\_0** = 0x8000, **INVENTOR\_6\_0** = 0x10000, **COIN\_4\_0** = 0x20000 }\ ### Public Member Functions virtual **SoType** **getTypeId** (void) const\ **SbBox3f** **getCharacterBounds** (**SoState** \*state, int stringindex, int charindex)\ virtual void **GLRender** (**SoGLRenderAction** \*action)\ virtual void **getPrimitiveCount** (**SoGetPrimitiveCountAction** \*action)\ Public Member Functions inherited from **SoShape** virtual SbBool **affectsState** (void) const\ virtual void **getBoundingBox** (**SoGetBoundingBoxAction** \*action)\ virtual void **rayPick** (**SoRayPickAction** \*action)\ virtual void **callback** (**SoCallbackAction** \*action)\ const **SoBoundingBoxCache** \* **getBoundingBoxCache** (void) const\ Public Member Functions inherited from **SoNode** void **setOverride** (const SbBool state)\ SbBool **isOverride** (void) const\ void **setNodeType** (const **NodeType** type)\ **NodeType** **getNodeType** (void) const\ virtual **SoNode** \* **copy** (SbBool copyconnections=FALSE) const\ virtual void **doAction** (**SoAction** \*action)\ virtual void **GLRenderBelowPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderInPath** (**SoGLRenderAction** \*action)\ virtual void **GLRenderOffPath** (**SoGLRenderAction** \*action)\ virtual void **getMatrix** (**SoGetMatrixAction** \*action)\ virtual void **handleEvent** (**SoHandleEventAction** \*action)\ virtual void **pick** (**SoPickAction** \*action)\ virtual void **search** (**SoSearchAction** \*action)\ virtual void **write** (**SoWriteAction** \*action)\ virtual void **audioRender** (**SoAudioRenderAction** \*action)\ virtual void **grabEventsSetup** (void)\ virtual void **grabEventsCleanup** (void)\ virtual void **startNotify** (void)\ SbUniqueId **getNodeId** (void) const\ virtual **SoChildList** \* **getChildren** (void) const\ virtual void **writeInstance** (**SoOutput** \*out)\ virtual **SoNode** \* **addToCopyDict** (void) const\ virtual void **copyContents** (const **SoFieldContainer** \*from, SbBool copyconnections)\ virtual **SoFieldContainer** \* **copyThroughConnection** (void) const\ Public Member Functions inherited from **SoFieldContainer** void **setToDefaults** (void)\ SbBool **hasDefaultValues** (void) const\ SbBool **fieldsAreEqual** (const **SoFieldContainer** \*container) const\ void **copyFieldValues** (const **SoFieldContainer** \*container, SbBool copyconnections=FALSE)\ SbBool **set** (const char \*const fielddata)\ void **get** (**SbString** &fielddata)\ virtual int **getFields** (**SoFieldList** &l) const\ virtual int **getAllFields** (**SoFieldList** &l) const\ virtual **SoField** \* **getField** (const **SbName** &name) const\ virtual **SoField** \* **getEventIn** (const **SbName** &name) const\ virtual **SoField** \* **getEventOut** (const **SbName** &name) const\ SbBool **getFieldName** (const **SoField** \*const field, **SbName** &name) const\ SbBool **enableNotify** (const SbBool flag)\ SbBool **isNotifyEnabled** (void) const\ SbBool **set** (const char \*fielddata, **SoInput** \*input)\ void **get** (**SbString** &fielddata, **SoOutput** \*out)\ virtual SbBool **validateNewFieldValue** (**SoField** \*field, void \*newval)\ virtual void **addWriteReference** (**SoOutput** \*out, SbBool isfromfield=FALSE)\ SbBool **getIsBuiltIn** (void) const\ virtual void **getFieldsMemorySize** (size\_t &managed, size\_t &unmanaged) const\ void **setUserData** (void \*userdata) const\ void \* **getUserData** (void) const\ Public Member Functions inherited from **SoBase** void **ref** (void) const\ void **unref** (void) const\ void **unrefNoDelete** (void) const\ int32\_t **getRefCount** (void) const\ void **touch** (void)\ SbBool **isOfType** (**SoType** type) const\ Returns TRUE if the type of this object is either of the same type or inherited from *type*. virtual **SbName** **getName** (void) const\ virtual void **setName** (const **SbName** &newname)\ void **addAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ void **removeAuditor** (void \*const auditor, const **SoNotRec::Type** type)\ const **SoAuditorList** & **getAuditors** (void) const\ SbBool **shouldWrite** (void)\ void **assertAlive** (void) const\ ### Static Public Member Functions static **SoType** **getClassTypeId** (void)\ static void **initClass** (void)\ Static Public Member Functions inherited from **SoShape** static **SoType** **getClassTypeId** (void)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void **getScreenSize** (**SoState** \*const state, const **SbBox3f** &boundingbox, **SbVec2s** &rectsize)\ static float **getDecimatedComplexity** (**SoState** \*state, float complexity)\ Static Public Member Functions inherited from **SoNode** static uint32\_t **getCompatibilityTypes** (const **SoType** &nodetype)\ static **SoType** **getClassTypeId** (void)\ static **SoNode** \* **getByName** (const **SbName** &name)\ static int **getByName** (const **SbName** &name, **SoNodeList** &l)\ static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static void **initClasses** (void)\ static SbUniqueId **getNextNodeId** (void)\ static int **getActionMethodIndex** (const **SoType** type)\ static void **getBoundingBoxS** (**SoAction** \*action, **SoNode** \*node)\ static void **GLRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **callbackS** (**SoAction** \*action, **SoNode** \*node)\ static void **getMatrixS** (**SoAction** \*action, **SoNode** \*node)\ static void **handleEventS** (**SoAction** \*action, **SoNode** \*node)\ static void **pickS** (**SoAction** \*action, **SoNode** \*node)\ static void **rayPickS** (**SoAction** \*action, **SoNode** \*node)\ static void **searchS** (**SoAction** \*action, **SoNode** \*node)\ static void **writeS** (**SoAction** \*action, **SoNode** \*node)\ static void **audioRenderS** (**SoAction** \*action, **SoNode** \*node)\ static void **getPrimitiveCountS** (**SoAction** \*action, **SoNode** \*node)\ Static Public Member Functions inherited from **SoFieldContainer** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **cleanupClass** (void)\ static void **initCopyDict** (void)\ static void **addCopy** (const **SoFieldContainer** \*orig, const **SoFieldContainer** \*copy)\ static **SoFieldContainer** \* **checkCopy** (const **SoFieldContainer** \*orig)\ static **SoFieldContainer** \* **findCopy** (const **SoFieldContainer** \*orig, const SbBool copyconnections)\ static void **copyDone** (void)\ Static Public Member Functions inherited from **SoBase** static void **initClass** (void)\ Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. static **SoType** **getClassTypeId** (void)\ This static method returns the **SoType** object associated with objects of this class. static void **addName** (**SoBase** \*const base, const char \*const name)\ static void **removeName** (**SoBase** \*const base, const char \*const name)\ static void **incrementCurrentWriteCounter** (void)\ static void **decrementCurrentWriteCounter** (void)\ static **SoBase** \* **getNamedBase** (const **SbName** &name, **SoType** type)\ static int **getNamedBases** (const **SbName** &name, **SoBaseList** &baselist, **SoType** type)\ static SbBool **read** (**SoInput** \*input, **SoBase** \*&base, **SoType** expectedtype)\ static void **setInstancePrefix** (const **SbString** &c)\ static void **setTraceRefs** (SbBool trace)\ static SbBool **getTraceRefs** (void)\ static SbBool **connectRoute** (**SoInput** \*input, const **SbName** &fromnodename, const **SbName** &fromfieldname, const **SbName** &tonodename, const **SbName** &tofieldname)\ static SbBool **readRoute** (**SoInput** \*input)\ ### Public Attributes **SoMFString** **string**\ **SoSFFloat** **spacing**\ **SoSFEnum** **justification**\ **SoSFBitMask** **parts**\ ### Protected Member Functions virtual const **SoFieldData** \* **getFieldData** (void) const\ virtual void **generatePrimitives** (**SoAction** \*)\ virtual void **computeBBox** (**SoAction** \*action, **SbBox3f** &box, **SbVec3f** ¢er)\ virtual **SoDetail** \* **createTriangleDetail** (**SoRayPickAction** \*action, const **SoPrimitiveVertex** \*v1, const **SoPrimitiveVertex** \*v2, const **SoPrimitiveVertex** \*v3, **SoPickedPoint** \*pp)\ virtual void **notify** (**SoNotList** \*list)\ Protected Member Functions inherited from **SoShape** **SoShape** (void)\ virtual **~SoShape** ()\ float **getComplexityValue** (**SoAction** \*action)\ virtual SbBool **shouldGLRender** (**SoGLRenderAction** \*action)\ void **beginSolidShape** (**SoGLRenderAction** \*action)\ void **endSolidShape** (**SoGLRenderAction** \*action)\ void **GLRenderBoundingBox** (**SoGLRenderAction** \*action)\ SbBool **shouldPrimitiveCount** (**SoGetPrimitiveCountAction** \*action)\ SbBool **shouldRayPick** (**SoRayPickAction** \*const action)\ void **computeObjectSpaceRay** (**SoRayPickAction** \*const action)\ void **computeObjectSpaceRay** (**SoRayPickAction** \*const action, const **SbMatrix** &matrix)\ virtual **SoDetail** \* **createLineSegmentDetail** (**SoRayPickAction** \*action, const **SoPrimitiveVertex** \*v1, const **SoPrimitiveVertex** \*v2, **SoPickedPoint** \*pp)\ virtual **SoDetail** \* **createPointDetail** (**SoRayPickAction** \*action, const **SoPrimitiveVertex** \*v, **SoPickedPoint** \*pp)\ void **invokeTriangleCallbacks** (**SoAction** \*const action, const **SoPrimitiveVertex** \*const v1, const **SoPrimitiveVertex** \*const v2, const **SoPrimitiveVertex** \*const v3)\ void **invokeLineSegmentCallbacks** (**SoAction** \*const action, const **SoPrimitiveVertex** \*const v1, const **SoPrimitiveVertex** \*const v2)\ void **invokePointCallbacks** (**SoAction** \*const action, const **SoPrimitiveVertex** \*const v)\ void **beginShape** (**SoAction** \*const action, const **TriangleShape** shapetype, **SoDetail** \*const detail=NULL)\ void **shapeVertex** (const **SoPrimitiveVertex** \*const v)\ void **endShape** (void)\ void **generateVertex** (**SoPrimitiveVertex** \*const pv, const **SbVec3f** &point, const SbBool useTexFunc, const **SoMultiTextureCoordinateElement** \*const tce, const float s, const float t, const **SbVec3f** &normal)\ void **generateVertex** (**SoPrimitiveVertex** \*const pv, const **SbVec3f** &point, const SbBool useTexFunc, const **SoMultiTextureCoordinateElement** \*const tce, const float s, const float t, const float r, const **SbVec3f** &normal)\ SbBool **startVertexArray** (**SoGLRenderAction** \*action, const **SoCoordinateElement** \*coords, const **SbVec3f** \*pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex)\ void **finishVertexArray** (**SoGLRenderAction** \*action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex)\ Protected Member Functions inherited from **SoNode** **SoNode** (void)\ virtual **~SoNode** ()\ virtual SbBool **readInstance** (**SoInput** \*in, unsigned short flags)\ Protected Member Functions inherited from **SoFieldContainer** **SoFieldContainer** (void)\ virtual **~SoFieldContainer** ()\ Protected Member Functions inherited from **SoBase** **SoBase** (void)\ virtual **~SoBase** ()\ virtual void **destroy** (void)\ SbBool **hasMultipleWriteRefs** (void) const\ SbBool **writeHeader** (**SoOutput** \*out, SbBool isgroup, SbBool isengine) const\ void **writeFooter** (**SoOutput** \*out) const\ virtual const char \* **getFileFormatName** (void) const\ virtual **SoNotRec** **createNotRec** (void)\ ### Static Protected Member Functions static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ Static Protected Member Functions inherited from **SoShape** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ Static Protected Member Functions inherited from **SoNode** static const **SoFieldData** \*\* **getFieldDataPtr** (void)\ static void **setNextActionMethodIndex** (int index)\ static int **getNextActionMethodIndex** (void)\ static void **incNextActionMethodIndex** (void)\ static void **setCompatibilityTypes** (const **SoType** &nodetype, const uint32\_t bitmask)\ Static Protected Member Functions inherited from **SoBase** static uint32\_t **getCurrentWriteCounter** (void)\ static void **staticDataLock** (void)\ static void **staticDataUnlock** (void)\ ### Additional Inherited Members Protected Types inherited from **SoBase** enum **BaseFlags** { **IS\_ENGINE** = 0x01, **IS\_GROUP** = 0x02 }\ Protected Attributes inherited from **SoNode** SbUniqueId **uniqueId**\ Protected Attributes inherited from **SoFieldContainer** SbBool **isBuiltIn**\ Static Protected Attributes inherited from **SoNode** static SbUniqueId **nextUniqueId** = 1\ static int **nextActionMethodIndex** = 0\ ## Detailed Description The **SoText3** class renders extruded 3D text. Render text as 3D geometry. The size of the textual geometry representation is decided from the **SoFont::size** field of a preceding SoFont-node in the scene graph, which specifies the size in unit coordinates. This value sets the approximate vertical size of the letters. The default value if no SoFont-nodes are used, is 10. This node will create 3D geometry from a specified font defined by a preceding **SoFont** node. The complexity of the glyphs is controlled by a preceding **SoComplexity** node with *Type* set to OBJECT\_SPACE. Please note that the default built-in 3D font will not be affected by the **SoComplexity** node. This is a simple example of an extruded **SoText3** string: ``` #Inventor V2.1 ascii Separator { renderCaching ON Font { name "Arial" size 2 } ProfileCoordinate2 { point [ 0 0, 0.05 0.05, 0.25 0.05, 0.3 0 ] } LinearProfile { index [ 0, 1, 2, 3 ] } Complexity { type OBJECT_SPACE value 1 } ShapeHints { creaseAngle 1.5 shapeType SOLID vertexOrdering COUNTERCLOCKWISE } Material { diffuseColor 0.6 0.6 0.8 specularColor 1 1 1 } Text3 { string ["Coin3D"] parts ALL } } ``` if **SoText3::Part** is set to SIDES or ALL and no profile is provided, a flat, one unit long profile will be created. Separate colors can be assigned to the front, sides and back of the glyphs by adding a preceding **SoMaterialBinding** node. Set the *value* field to PER\_PART (default is OVERALL). The front, side and back of the glyphs will then be colored according to diffuse color 0, 1 and 2 found on the stack. Beware that using a lot of **SoText3** text characters in a scene will usually have severe impact on the rendering performance, as each and every character of the text increases the polygon count a lot. This makes **SoText3** nodes most suitable in situations where you just need a few characters to be placed in your scene, rather than to visualize complete sentences. **FILE FORMAT/DEFAULTS:** ``` Text3 { string "" spacing 1 justification LEFT parts FRONT } ``` **See also** **SoFont**, **SoFontStyle**, **SoText2**, **SoAsciiText**, **SoProfile** ## Member Enumeration Documentation ### enum SoText3::Part Used to specify which parts should be rendered/generated. **Enumerator** - ***FRONT*** Front of characters. - ***SIDES*** Sides of characters. - ***BACK*** Back of characters. - ***ALL*** All parts. ### enum SoText3::Justification Used to specify horizontal string alignment. **Enumerator** - ***LEFT*** Left edges of strings are aligned. - ***RIGHT*** Right edges of strings are aligned. - ***CENTER*** Centers of strings are aligned. ## Member Function Documentation ### SoType SoText3::getClassTypeId (void ) \[static\] This static method returns the **SoType** object associated with objects of this class. ### SoType SoText3::getTypeId (void ) const \[virtual\] Returns the type identification of an object derived from a class inheriting **SoBase**. This is used for runtime type checking and "downward" casting. Reimplemented from **SoShape**. ### const SoFieldData \*\* SoText3::getFieldDataPtr (void ) \[static\], \[protected\] *This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\ Returns the **SoFieldData** class which holds information about fields in this node. ### const SoFieldData \* SoText3::getFieldData (void ) const \[protected\], \[virtual\] Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL. Reimplemented from **SoShape**. ### void SoText3::initClass (void ) \[static\] ### SbBox3f SoText3::getCharacterBounds (SoState \* state, int stringindex, int charindex) Not implemented. Should probably have been private in Open Inventor API. Let us know if you need this method for anything, and we'll implement it. ### void SoText3::GLRender (SoGLRenderAction \* action) \[virtual\] Action method for the **SoGLRenderAction**. 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. Reimplemented from **SoShape**. ### void SoText3::getPrimitiveCount (SoGetPrimitiveCountAction \* action) \[virtual\] Action method for the **SoGetPrimitiveCountAction**. Calculates the number of triangle, line segment and point primitives for the node and adds these to the counters of the *action*. Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables. Reimplemented from **SoShape**. ### void SoText3::generatePrimitives (SoAction \* action) \[protected\], \[virtual\] The method implements action behavior for shape nodes for **SoCallbackAction**. It is invoked from **SoShape::callback()**. (Subclasses should *not* override **SoNode::callback()**.) The subclass implementations uses the convenience methods **SoShape::beginShape()**, **SoShape::shapeVertex()**, and **SoShape::endShape()**, with **SoDetail** instances, to pass the primitives making up the shape back to the caller. Implements **SoShape**. ### void SoText3::computeBBox (SoAction \* action, SbBox3f & box, SbVec3f & center) \[protected\], \[virtual\] Implemented by **SoShape** subclasses to let the **SoShape** superclass know the exact size and weighted center point of the shape's bounding box. The bounding box and center point should be calculated and returned in the local coordinate system. The method implements action behavior for shape nodes for **SoGetBoundingBoxAction**. It is invoked from **SoShape::getBoundingBox()**. (Subclasses should *not* override **SoNode::getBoundingBox()**.) The *box* parameter sent in is guaranteed to be an empty box, while *center* is undefined upon function entry. Implements **SoShape**. ### SoDetail \* SoText3::createTriangleDetail (SoRayPickAction \* action, const SoPrimitiveVertex \* v1, const SoPrimitiveVertex \* v2, const SoPrimitiveVertex \* v3, SoPickedPoint \* pp) \[protected\], \[virtual\] Will create triangle detail for a **SoPickedPoint**. This method will only be called internally, when **generatePrimitives()** is used for picking (**SoShape::rayPick()** is not overridden). This method returns NULL in Open Inventor, and subclasses will need to override this method to create details for a **SoPickedPoint**. This is not necessary with Coin. Of course, if you choose to override it, it will work in the same way as Open Inventor. For this to work, you must supply a face or line detail when generating primitives. If you supply NULL for the detail argument in **SoShape::beginShape()**, you'll have to override this method. Reimplemented from **SoShape**. ### void SoText3::notify (SoNotList \* l) \[protected\], \[virtual\] Notifies all auditors for this instance when changes are made. Reimplemented from **SoShape**. ## Member Data Documentation ### SoMFString SoText3::string The set of strings to render. Each string in the multiple value field will be rendered on a separate line. The default value of the field is a single empty string. ### SoSFFloat SoText3::spacing Vertical spacing between the baselines of two consecutive horizontal lines. Default value is 1.0, which means that it is equal to the vertical size of the highest character in the bitmap alphabet. ### SoSFEnum SoText3::justification Determines horizontal alignment of text strings. If justification is set to **SoText3::LEFT**, the left edge of the first string is at the origin and all strings are aligned with their left edges. If set to **SoText3::RIGHT**, the right edge of the first string is at the origin and all strings are aligned with their right edges. Otherwise, if set to **SoText3::CENTER**, 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. Default value is **SoText3::LEFT**. ### SoSFBitMask SoText3::parts Character parts. Default is to show only the front facing part. ## Author Generated automatically by Doxygen for Coin from the source code.