SoText3(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

πŸ’– SoText3(3) πŸ’– β€” Library Functions Manual

okay so you found the manual page for SoText3, bestie, and she's a whole vibe. This is part 1 of 2 so buckle up πŸŽ€


✨ NAME ✨

SoText3 β€” the class that renders extruded 3D text. Yeah. Real text, real depth, real main character energy. πŸ¦‹


🌸 SYNOPSIS 🌸

#include <Inventor/nodes/SoText3.h>

Inherits SoShape.

So it's an SoShape at heart β€” everything below is basically her family tree, and she inherits a lot. Not me listing all of it... okay yes, me listing all of it. Every single one. Periodt. πŸ’…

πŸ’œ 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 }

πŸ”₯ Public Member Functions πŸ”₯

The ones she brings to the party herself, no inheritance needed:

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 🫢

like, this list is long long. we're doing it anyway. no skipping, that's the rule πŸ’€

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)
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=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
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)
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 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)
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 *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 πŸ“

the actual knobs you turn on this thing πŸ’–

SoMFString string
SoSFFloat spacing
SoSFEnum justification
SoSFBitMask parts

πŸ’€ Protected Member Functions πŸ’€

the backstage stuff. you can't touch these from outside, they're for her and her subclasses only. gatekeeping? maybe a little. πŸ™ˆ

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)

🧚 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

✨ Static Protected Member Functions ✨

  • static const SoFieldData ** getFieldDataPtr (void) β€” the static hook that hands back the class-wide field data pointer, so all the instances can share one copy instead of each hoarding their own. very "we share one fries" energy 🍟

Static Protected Member Functions inherited from SoShape

  • static const SoFieldData ** getFieldDataPtr (void) β€” same vibe, one level up the family tree πŸ’«

Static Protected Member Functions inherited from SoNode

  • static const SoFieldData ** getFieldDataPtr (void) β€” yeah, it's the field data pointer thing again, but from SoNode's side of the family 🫢
  • static void setNextActionMethodIndex (int index) β€” sets the index that the next action method will grab.
  • static int getNextActionMethodIndex (void) β€” reads back that index.
  • static void incNextActionMethodIndex (void) β€” bumps the index up by one. little incremental queen πŸ‘‘
  • static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask) β€” registers a node type together with a uint32_t bitmask of compatibility flags.

Static Protected Member Functions inherited from SoBase

  • static uint32_t getCurrentWriteCounter (void) β€” returns the current write counter as a uint32_t.
  • static void staticDataLock (void) β€” locks the static data. πŸ”’
  • static void staticDataUnlock (void) β€” unlocks it again. balanced, as all things should be πŸ”“

🌈 Additional Inherited Members 🌈

Protected Types inherited from SoBase

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 } β€” two little flags, IS_ENGINE at 0x01 and IS_GROUP at 0x02.

Protected Attributes inherited from SoNode

  • uint32_t uniqueId β€” every node's very own id, no duplicates allowed bestie πŸ’…

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn β€” whether this thing is a builtin or not.

Static Protected Attributes inherited from SoNode

  • static uint32_t nextUniqueId = 1 β€” the counter for handing out ids, starting at 1.
  • static int nextActionMethodIndex = 0 β€” the action method index counter, starting at 0.

πŸ’– Detailed Description πŸ’–

The SoText3 class renders extruded 3D text. like, actual letters with depth. sculptural. main character energy fr fr ✨

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 builtin 3D font will not be affected by the SoComplexity node. she does not take notes from anyone πŸ™ˆ

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. no profile? she'll make one herself, she's resourceful like that πŸŽ€

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. front = 0, sides = 1, back = 2. the lineup is set 🌸

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. like bestie, this is a caption not a novel πŸ’€

FILE FORMAT/DEFAULTS:

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

See also

  • SoText2, SoAsciiText, SoProfile

🌟 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 whole package, no notes πŸ‘‘

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 β€” 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.

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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.

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

Reimplemented from SoShape.

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. iconic behavior honestly πŸ’–

Reimplemented from SoShape.

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. ngl she's just sitting there unbuilt, manifesting 🧚

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.

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.

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. gossiping to everyone who's listening, respectfully πŸ’…

Reimplemented from SoShape.


πŸŽ€ Member Data Documentation πŸŽ€

  • SoMFString SoText3::string β€” The strings to render. Array defaults to contain a single empty string. so like, technically she's always saying something, even if it's nothing 🫠
  • SoSFFloat SoText3::spacing β€” Vertical spacing. 1.0 is the default spacing.
  • SoSFEnum SoText3::justification β€” Horizontal justification. Default is alignment at the left border.
  • SoSFBitMask SoText3::parts β€” Character parts. Default is to show only the front-facing part. front only, she's shy like that πŸ™ˆ

πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code.


aaaand that's the whole page bestie, you ate that πŸ“šβœ¨ this was the SoText3(3) manual page from Coin, Version 3.1.3 β€” generated automatically by Doxygen from the source code. go forth and extrude some letters, no cap πŸ’…πŸ”₯

πŸ“¦ where this page comes from