SoText2(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

okay so bestie, this is the SoText2(3) page from the Coin manual, and SoText2 is a node type for visualizing 2D text aligned with the camera plane. that's the whole vibe. iconic. 💅

🦋 SYNOPSIS 🦋

#include <Inventor/nodes/SoText2.h>

Inherits SoShape.

✨ Public Types ✨

  • 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 🌸

the inherited NodeType enum, in all its glory:

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 💅

these are the ones SoText2 itself brings to the group chat:

  • virtual SoType getTypeId (void) const
  • SoText2 (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🫶 Public Member Functions inherited from SoShape 🫶

  • virtual SbBool affectsState (void) const
  • virtual void notify (SoNotList *nl)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *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

🧚 Protected Member Functions 🧚

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoText2 ()
  • virtual void generatePrimitives (SoAction *action)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)

Protected Member Functions inherited from SoShape

Okay bestie, these are the protected goodies you get from SoShape. They're not for public consumption, but they're iconic anyway. 💅

  • SoShape (void) — protected constructor, lowkey the blueprint.
  • virtual ~SoShape () — virtual destructor, it cleans up.
  • float getComplexityValue (SoAction *action) — grabs the complexity value.
  • virtual SbBool shouldGLRender (SoGLRenderAction *action) — virtual check for GL rendering.
  • void beginSolidShape (SoGLRenderAction *action) — starts a solid shape.
  • void endSolidShape (SoGLRenderAction *action) — ends a solid shape.
  • void GLRenderBoundingBox (SoGLRenderAction *action) — renders the bounding box.
  • SbBool shouldPrimitiveCount (SoGetPrimitiveCountAction *action) — should we count primitives?
  • SbBool shouldRayPick (SoRayPickAction *const action) — should we ray pick?
  • void computeObjectSpaceRay (SoRayPickAction *const action) — computes the object-space ray.
  • void computeObjectSpaceRay (SoRayPickAction *const action, const SbMatrix &matrix) — same but with a matrix.
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp) — virtual, makes triangle detail.
  • virtual SoDetail * createLineSegmentDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, SoPickedPoint *pp) — virtual, makes line segment detail.
  • virtual SoDetail * createPointDetail (SoRayPickAction *action, const SoPrimitiveVertex *v, SoPickedPoint *pp) — virtual, makes point detail.
  • void invokeTriangleCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2, const SoPrimitiveVertex *const v3) — invokes triangle callbacks.
  • void invokeLineSegmentCallbacks (SoAction *const action, const SoPrimitiveVertex *const v1, const SoPrimitiveVertex *const v2) — invokes line segment callbacks.
  • void invokePointCallbacks (SoAction *const action, const SoPrimitiveVertex *const v) — invokes point callbacks.
  • void beginShape (SoAction *const action, const TriangleShape shapetype, SoDetail *const detail=NULL) — begins a shape, note the detail=NULL default.
  • void shapeVertex (const SoPrimitiveVertex *const v) — adds a shape vertex.
  • void endShape (void) — ends the shape.
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoMultiTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal) — generates a vertex with texture coords s, t.
  • 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) — same but with an extra r coordinate.
  • SbBool startVertexArray (SoGLRenderAction *action, const SoCoordinateElement *coords, const SbVec3f *pervertexnormals, const SbBool texpervertex, const SbBool colorpervertex) — starts the vertex array.
  • void finishVertexArray (SoGLRenderAction *action, const SbBool vbo, const SbBool normpervertex, const SbBool texpervertex, const SbBool colorpervertex) — finishes the vertex array.

Protected Member Functions inherited from SoNode

From SoNode, more protected magic. ✨

  • SoNode (void) — protected constructor.
  • virtual ~SoNode () — virtual destructor.
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — virtual, reads an instance.

Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — protected constructor.
  • virtual ~SoFieldContainer () — virtual destructor.

Protected Member Functions inherited from SoBase

  • SoBase (void) — protected constructor.
  • virtual ~SoBase () — virtual destructor.
  • virtual void destroy (void) — virtual destroy.
  • SbBool hasMultipleWriteRefs (void) const — checks for multiple write refs.
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — writes the header.
  • void writeFooter (SoOutput *out) const — writes the footer.
  • virtual const char * getFileFormatName (void) const — virtual, gets the file format name.
  • virtual SoNotRec createNotRec (void) — virtual, creates a notification record.

Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — static, returns the field data pointer.

Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr (void) — same, inherited from SoShape.

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) — inherited from SoNode.
  • static void setNextActionMethodIndex (int index) — sets the next action method index.
  • static int getNextActionMethodIndex (void) — gets the next action method index.
  • static void incNextActionMethodIndex (void) — increments the next action method index.
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — sets compatibility types.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — gets the current write counter.
  • static void staticDataLock (void) — locks static data.
  • static void staticDataUnlock (void) — unlocks static data.

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 SoText2 class is a node type for visualizing 2D text aligned with the camera plane. It's giving "always facing you, bestie." 👑

SoText2 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 SoText3 or SoAsciiText node.

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 will be obscured by graphics laying in front of it. So it can still get hidden, no cap. 😭

The text will be positioned 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).

The size of the fonts on screen is decided from the SoFont::size 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.

One important issue about rendering performance: since the positioning and rendering of an SoText2 node depends on the current viewport and camera, having SoText2 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 SoText2's nearest parent SoSeparator, the SoSeparator will not be able to cache the geometry under it.

(Even worse rendering performance will be forced if the SoSeparator::renderCaching flag is explicitly set to ON, as the SoSeparator node will then continuously generate and destruct the same cache as the camera moves.)

SoText2 nodes are therefore best positioned under their own SoSeparator node, outside areas in the scene graph that otherwise contains static geometry.

Also note that SoText2 nodes cache the ids and positions of each glyph bitmap used to render string. This means that USE of a DEF'ed SoText2 node, with a different font, will be noticeably slower than using two separate SoText2 nodes, one for each font, since it will have to recalculate glyph bitmap ids and positions for each call to GLrender().

SoScale nodes cannot be used to influence the dimensions of the rendering output of SoText2 nodes.

FILE FORMAT/DEFAULTS:

Text2 {
    string ""
    spacing 1
    justification LEFT
}

See also

SoFont, SoFontStyle, SoText3, SoAsciiText

Member Enumeration Documentation

enum SoText2::Justification

Used to specify horizontal string alignment. Slay. 💅

Enumerator

  • LEFT — Left edges of strings are aligned.
  • RIGHT — Right edges of strings are aligned.
  • CENTER — Centers of strings are aligned.

Constructor & Destructor Documentation

SoText2::SoText2 (void )

Constructor. It's giving new object energy. ✨

SoText2::~SoText2 () [protected], [virtual]

Destructor. Protected and virtual, so it's lowkey exclusive.

Member Function Documentation

SoType SoText2::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

SoType SoText2::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 ** SoText2::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 * SoText2::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 SoText2::initClass (void ) [static]

void SoText2::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 SoText2::rayPick (SoRayPickAction * action) [virtual]

Calculates picked point based on primitives generated by subclasses.

Reimplemented from SoShape.

void SoText2::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 SoText2::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 SoText2::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.

💖 Member Data Documentation 💖

okay bestie, this is the good part — the actual data of SoText2, the fields you poke to make your text look right. three of them. all iconic. let's go 🫶

🌸 SoMFString SoText2::string 🌸

the whole set of strings you wanna render, babes. and here's the cute part: since it's a multiple value field, every single string inside it gets rendered on its own separate line. so you don't have to babysit newlines, it just stacks them. 📚

default value? a single empty string. so out of the box it's giving absolutely nothing, which is honestly a mood, but you'll wanna fill it. 💅

✨ SoSFFloat SoText2::spacing ✨

this one controls the vertical spacing between the baselines of two consecutive horizontal lines. baseline-to-baseline, no cap. 📏

default is 1.0, and what that means is the spacing equals the vertical size of the highest character in the bitmap alphabet. so like, tall-letter energy defines your line height. 👑

🦋 SoSFEnum SoText2::justification 🦋

this is the horizontal alignment of your text strings. the main character of layout options. 💫

  • if you set it to SoText2::LEFT, the left edge of the first string sits at the origin, and all the strings line up by their left edges.
  • if you set it to SoText2::RIGHT, the right edge of the first string sits at the origin, and everything aligns by its right edges.
  • otherwise, if you set it to SoText2::CENTER, the center of the first string is at the origin, and all strings align by their centers.

and the important little detail, bestie: the origin is always located at the baseline of the first line of text. no matter what. 🎯

default value is SoText2::LEFT. left-aligned, always valid, never misses. periodt. 🌈

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. (yeah, the docs wrote themselves, we love an automated queen ✨)

aaaand that's the whole page, bestie!! this was Coin version 4.0.10, stamped Thu Jun 25 2026 00:00:00, and yes SoText2(3) is the manual page we just devoured together. mwah 💖🎀🦋 go render some text and slay 🌸💅

📦 where this page comes from