SoAsciiText(3)

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

✨ NAME ✨

SoAsciiText(3) — Coin manual, bestie. The SoAsciiText class renders flat 3D text. No cap. 💅

✨ SYNOPSIS ✨

#include <Inventor/nodes/SoAsciiText.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 💅

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 — the type ID getter, iconic. ✨
  • SoAsciiText (void) — the constructor, she's here to serve. 💅
  • virtual void GLRender (SoGLRenderAction *action) — renders with OpenGL, periodt. 🔥
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — counts primitives, bestie. 🧚

👑 Public Member Functions inherited from SoShape 👑

  • virtual SbBool affectsState (void) const — does it affect state? 💭
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box, slay. 📦
  • virtual void rayPick (SoRayPickAction *action) — ray pick, no cap. 🎯
  • virtual void callback (SoCallbackAction *action) — callback vibes. 📞
  • const SoBoundingBoxCache * getBoundingBoxCache (void) const — get that cache. 💾

👑 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 this object's type is either the same as type or inherited from it. 💖
  • 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) — gets the class type ID. 💅
  • static void initClass (void) — bestie, this sets up the initialization for all the data that every instance of this class shares, like sending the necessary info to the Coin type system. ✨

🌟 Static Public Member Functions inherited from SoShape 🌟

  • static SoType getClassTypeId (void)
  • static void initClass (void) — same vibe: 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 — the string field, bestie. 📝
  • SoSFFloat spacing — spacing, no cap. 📏
  • SoSFEnum justification — justification, slay. ⚖️
  • SoMFFloat width — width, periodt. 📐

🎀 Protected Member Functions 🎀

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoAsciiText ()
  • virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f &center)
  • virtual void generatePrimitives (SoAction *)
  • virtual SoDetail * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
  • virtual void notify (SoNotList *list)

That's part 1, bestie! Part 2 is coming, don't you worry. 💖

🛡️ Protected Member Functions inherited from SoShape 🛡️

okay bestie, SoShape left us these protected member functions like a little inheritance gift. we're listing every single one, no skips, because we don't gatekeep. 💅✨

  • 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 said "here, take these too." iconic behavior. 🌈

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

SoAsciiText is the class that renders flat 3D text, bestie. like, it's giving text but in 3D space, but not extruded. 💅

The text is rendered using 3D polygon geometry. no cap.

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.

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 node is different from the SoText2 node in that it rotates, scales, translates etc just like other geometry in the scene. It is different from the SoText3 node in that it renders the text "flat", i.e. does not extrude the fonts to have depth.

To get an intuitive feeling for how SoAsciiText works, take a look at this sample Inventor file in examiner viewer:

#Inventor V2.1 ascii

Separator {
  Font {
    size 10
    name "Arial:Bold Italic"
  }

  BaseColor {
    rgb 1 0 0 #red
  }
  AsciiText {
    width [ 0, 1, 50 ]
    justification LEFT #Standard alignment
    string [ "LEFT", "LEFT", "LEFT", "LEFT", "LEFT LEFT" ]
  }
  BaseColor {
    rgb 1 1 0
  }
  Sphere { radius 1.5 }

  Translation {
    translation 0 -50 0
  }
  BaseColor {
    rgb 0 1 0 #green
  }
  AsciiText {
    width [ 0, 1, 50 ]
    justification RIGHT
    string [ "RIGHT", "RIGHT", "RIGHT", "RIGHT", "RIGHT RIGHT" ]
  }
  BaseColor {
    rgb 0 1 1
  }
  Sphere { radius 1.5 }

  Translation {
    translation 0 -50 0
  }
  BaseColor {
    rgb 0 0 1 #blue
  }
  AsciiText {
    width [ 0, 1, 50 ]
    justification CENTER
    string [ "CENTER", "CENTER", "CENTER", "CENTER", "CENTER CENTER" ]
  }
  BaseColor {
    rgb 1 0 1
  }
  Sphere { radius 1.5 }
}

In examinerviewer the Inventor file looks something like this:

FILE FORMAT/DEFAULTS:

AsciiText {
    string ""
    spacing 1
    justification LEFT
    width 0
}

See also: SoFont, SoFontStyle, SoText2, SoText3

Since: SGI Inventor 2.1

📚 Member Enumeration Documentation 📚

enum SoAsciiText::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.

🏗️ Constructor & Destructor Documentation 🏗️

SoAsciiText::SoAsciiText (void )

Constructor.

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

Destructor.

🧰 Member Function Documentation 🧰

SoType SoAsciiText::getClassTypeId (void ) [static]

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

SoType SoAsciiText::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 ** SoAsciiText::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 * SoAsciiText::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 SoAsciiText::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 SoAsciiText::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 SoAsciiText::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.

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

SoDetail * SoAsciiText::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 SoAsciiText::notify (SoNotList * l) [protected], [virtual]

Notifies all auditors for this instance when changes are made.

Reimplemented from SoShape.

💾 Member Data Documentation 💾

okay bestie, this is the part where we meet the actual data — the fields you're gonna be poking at. four of them. all iconic, all doing their own little job. let's get into it 🫶

🌸 SoMFString SoAsciiText::string 🌸

the set of strings to render. every single string in the multiple-value field gets rendered on its own separate line — no merging, no smushing, one string = one line, periodt. 💅

the default value of the field is a single empty string. so yeah, out of the box it's rendering vibes. nothing. the void. a little ghost string. 👻

📏 SoSFFloat SoAsciiText::spacing 📏

this one is the vertical spacing between the baselines of two consecutive horizontal lines. like, how much breathing room your lines get. personal space for text. we respect it. ✨

default value is 1.0, which means it's equal to the vertical size of the highest character in the bitmap alphabet. so 1.0 = perfectly snug, zero drama, everyone's baseline stacked exactly one tall-boi apart. 🔥

🎯 SoSFEnum SoAsciiText::justification 🎯

this field determines the horizontal alignment of text strings. it's the "where do I stand" field. very main character energy.

  • if justification is set to SoAsciiText::LEFT, the left edge of the first string is at the origin and all strings are aligned with their left edges.
  • if set to SoAsciiText::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 SoAsciiText::CENTER, the center of the first string is at the origin and all strings are aligned with their centers.
🎀 important little detail: the origin is always located at the baseline of the first line of text. always. no matter which justification you pick. baseline is the anchor, it's not moving, it's built different.

default value is SoAsciiText::LEFT. so left-aligned unless you say otherwise. 💖

📐 SoMFFloat SoAsciiText::width 📐

defines the width of each line. the text is scaled to be within the specified units.

here's the crucial bit bestie, don't skip it: the size of the characters will remain the same; only the X-positions are scaled. we are not stretching your letters, we are just sliding them around horizontally. squishing, not warping. 🦋

  • when width <= 0, the width value is ignored and the text is rendered as normal. off. canceled. 🙈
  • the exact width of the rendered text depends not only on the width field, but also on the maximum character width in the rendered string.
  • the string will be attempted to fit within the specified width, but if it is unable to do so, it uses the largest character in the string as the width. (yes, it gives up gracefully and lets the biggest letter call the shots. 💀)
  • if fewer widths are specified than the number of strings, the strings without matching widths are rendered with default width. no orphan gets left behind without a width. 🫶

✍️ Author ✍️

generated automatically by Doxygen for Coin from the source code. not a human, just a little robot doing its thing. 🤖💜

aaaand that's a wrap on SoAsciiText(3), bestie!! 🎉 go forth and render some text, you absolute icon. this page came to you courtesy of Coin version 4.0.10, stamped Thu Jun 25 2026 00:00:00 — so like, from the future?? clock it. ⏰✨ slay, bye!! 💅🌈

📦 where this page comes from