SoText3(3)

📦 version 2.5.0, in fedora 43, fedora 44

👑 SoText3(3) 👑 — Library Functions Manual energy, but make it cute

okay so bestie, listen. this is SoText3(3), straight out of the Library Functions Manual, and it's the page where text stops being flat and starts having DEPTH. no cap. let's get into it 💖

🌸 NAME 🌸

SoText3 — the class that renders extruded 3D text. that's it, that's the whole vibe. it makes letters that pop out at you like they have main character energy ✨

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoText3.h>

Inherits SoShape. (so like, yeah, it's a shape node, it renders geometry, obviously 💅)

🎀 Public Types 🎀

Part

enum Part { FRONT = 1, SIDES = 2, BACK = 4, ALL = FRONT|BACK|SIDES }

the way these are literally bitmask flags... FRONT is 1, SIDES is 2, BACK is 4, and ALL is the whole FRONT|BACK|SIDES combo meal. iconic.

Justification

enum Justification { LEFT = 1, RIGHT, CENTER }

only LEFT gets an explicit = 1, the other two just follow along behind it. periodt.

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
    }

look at all those hex constants bestie, it's giving alphabet soup and I'm obsessed 😭

💅 Public Member Functions 💅

the ones that live right here on SoText3:

  • 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=0) 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)
  • uint32_t 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=0)
  • 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 *in)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
  • SbBool getIsBuiltIn (void) 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
  • 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 🌟

the ones you can call without an instance, queen behavior:

  • static SoType getClassTypeId (void)
  • static void initClass (void)

Static Public Member Functions inherited from SoShape

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • 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)
  • static void initClasses (void)
  • static uint32_t 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)
  • static SoType getClassTypeId (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)
  • static SoType getClassTypeId (void)
  • 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 *in, SoBase *&base, SoType expectedtype)
  • static void setInstancePrefix (const SbString &c)
  • static void setTraceRefs (SbBool trace)
  • static SbBool getTraceRefs (void)
  • static SbBool connectRoute (SoInput *in, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname)
  • static SbBool readRoute (SoInput *in)

🦋 Public Attributes 🦋

these are the fields, bestie, the actual knobs you turn:

  • SoMFString string — the text itself, a multi-string field
  • SoSFFloat spacing — a single float for spacing
  • SoSFEnum justification — the justification enum field
  • SoSFBitMask parts — a bitmask field for the Part flags

💜 Protected Member Functions 💜

for the subclass girlies only, no touching 🙈

  • virtual const SoFieldData * getFieldData (void) const
  • virtual void generatePrimitives (SoAction *)
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • 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 SoTextureCoordinateElement *const tce, const float s, const float t, const SbVec3f &normal)
  • void generateVertex (SoPrimitiveVertex *const pv, const SbVec3f &point, const SbBool useTexFunc, const SoTextureCoordinateElement *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)
ok real talk, there are two generateVertex overloads up there and yes, one takes an extra const float r and one doesn't. they are NOT the same, don't mix them up bestie 💀

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)
  • ~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

🌈 Static Protected Member Functions 🌈

  • static const SoFieldData ** getFieldDataPtr (void)

Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr (void)

and that's the whole inheritance tree laid out, bestie 🫶 this page is long so it comes in 2 parts and this was only part 1 — there's more coming, so don't go anywhere 💅✨

Static Protected Member Functions inherited from SoNode

These cuties came with the SoNode package deal, no extra charge:

  • static const SoFieldData ** getFieldDataPtr (void) — inherited, not yours to worry about 💅
  • static void setNextActionMethodIndex (int index) — inherited
  • static int getNextActionMethodIndex (void) — inherited
  • static void incNextActionMethodIndex (void) — inherited
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) — inherited

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) — inherited
  • static void staticDataLock (void) — inherited
  • static void staticDataUnlock (void) — inherited

Friends

  • class SoText3P — bestie privileges fr 🫶

Additional Inherited Members

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } — the little flag enum that came along for the ride

Protected Attributes inherited from SoNode

  • uint32_t uniqueId — inherited

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn — inherited

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 0 — inherited
  • static int nextActionMethodIndex = 0 — inherited

Detailed Description

So the SoText3 class renders extruded 3D text. Like, actual chunky letters you can walk around. Render text as 3D geometry, periodt. ✨

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. That value sets the approximate vertical size of the letters. And if you don't use any SoFont-nodes at all? The default is 10. Noted. 🎀

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. But listen — the default builtin 3D font will not be affected by the SoComplexity node. It's giving main character who doesn't take notes. 💀

Here's a simple lil example of an extruded SoText3 string, iconic behaviour:

#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. Coin said "I got you" and made one. 🫶

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). Then the front, side and back of the glyphs get colored according to diffuse color 0, 1 and 2 found on the stack. Slay. 💅

Beware, bestie — using a lot of SoText3 text characters in a scene will usually have severe impact on the rendering performance, because every single 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 placed in your scene, rather than to visualize complete sentences. Like, a word or two? Gorgeous. A whole novel? Your GPU is gonna cry. 😭

FILE FORMAT/DEFAULTS:

Text3 {
    string ""
    spacing 1
    justification LEFT
    parts FRONT
}

See also

  • SoText2, SoAsciiText, SoProfile — the rest of the text squad 🌸

Member Enumeration Documentation

enum SoText3::Part

Used to specify which parts should be rendered/generated. Pick your fighter. 👑

Enumerator

  • FRONT — Front of characters.
  • SIDES — Sides of characters.
  • BACK — Back of characters.
  • ALL — All parts. The full package. ✨

enum SoText3::Justification

Used to specify horizontal string alignment. Where does the text sit, horizontally? That's the vibe check.

Enumerator

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

Member Function Documentation

SoType SoText3::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting. iykyk.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
  else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
    SoGroup * group = (SoGroup *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on. The macro lore goes deep. 🧚

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Reimplemented from SoShape.

Referenced by computeBBox().

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. (Not here though, we got fields bestie.)

Reimplemented from SoShape.

References ALL, BACK, CENTER, FRONT, justification, LEFT, parts, RIGHT, SIDES, and spacing.

SbBox3f SoText3::getCharacterBounds (SoState * state, int stringindex, int charindex)

Not implemented. Should probably have been private in OIV. Let us know if you need this method for anything, and we'll implement it. Yeah, that's the whole thing — it's giving "we'll see" energy. 🙈

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 who wants to throw geometry primitives at OpenGL overrides this method.

Reimplemented from SoShape.

References BACK, FRONT, SoAction::getState(), SoState::isElementEnabled(), parts, SoDebugError::postWarning(), SoShape::shouldGLRender(), and SIDES.

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 calculates their primitive count also overrides this method to change the relevant state variables.

Reimplemented from SoShape.

References SoGetPrimitiveCountAction::addNumText(), SoShape::getPrimitiveCount(), and SoGetPrimitiveCountAction::is3DTextCountedAsTriangles().

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().) Don't do it. ✋

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.

References BACK, FRONT, SoAction::getState(), parts, and SIDES.

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().) Again — hands off. 🚫

The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry. So don't be surprised when it's giving nothing at first.

Implements SoShape.

References BACK, CENTER, SbBox3f::extendBy(), FRONT, SbBox3f::getCenter(), SbPList::getLength(), SbBox3f::getMax(), SbBox3f::getMin(), SoAction::getState(), SoNurbsProfile::getTrimCurve(), getTypeId(), SoProfile::getVertices(), SoBase::isOfType(), justification, LEFT, parts, RIGHT, SbBox3f::setBounds(), and spacing.

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. Coin really said "we did it so you don't have to" 💅

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.

References SoDetail::copy(), and SoPrimitiveVertex::getDetail().

void SoText3::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made. Gossip protocol but make it scene graph. 📣

Reimplemented from SoShape.

References SoNotList::getLastField(), and SoShape::notify().

Member Data Documentation

SoMFString SoText3::string

The strings to render.

Array defaults to contain a single empty string. Humble beginnings. 🎀

SoSFFloat SoText3::spacing

Vertical spacing. 1.0 is the default spacing. Referenced by computeBBox(), and getFieldData().

SoSFEnum SoText3::justification

Horizontal justification. Default is alignment at the LEFT border. Referenced by computeBBox(), and getFieldData().

SoSFBitMask SoText3::parts

Character parts. Default is to show only the front-facing part. Referenced by computeBBox(), generatePrimitives(), getFieldData(), and GLRender().

Author

Generated automatically by Doxygen for Coin from the source code. Yeah, a robot wrote it. And yet here we are, thriving. ✨

That's the whole page bestie, you made it to the end 🎉 this lil doc shipped with Coin Version 2.5.0 and it's filed under SoText3(3) — go extrude some letters and eat, you deserve it 💖🦋🌸

📦 where this page comes from