SoVRMLText(3)

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

✨ SoVRMLText(3) ✨

🌸 NAME 🌸

SoVRMLText β€” okay bestie, this class is literally the one used to represent text in a scene. That’s the whole vibe. Text. In a scene. Slay. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/VRMLnodes/SoVRMLText.h>

Inherits SoVRMLGeometry.

πŸ’– Public Types πŸ’–

  • enum Justification { BEGIN = 0x01, END = 0x02, MIDDLE = 0x03 }

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
}

πŸ‘‘ Public Member Functions πŸ‘‘

  • virtual SoType getTypeId (void) const
  • SoVRMLText (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void notify (SoNotList *list)
  • virtual SoChildList * getChildren (void) const

Public Member Functions inherited from SoVRMLGeometry

  • virtual void search (SoSearchAction *action)
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyConn)

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 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 void writeInstance (SoOutput *out)
  • virtual SoNode * addToCopyDict (void) const
  • 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 🌈

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

Static Public Member Functions inherited from SoVRMLGeometry

  • 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 πŸ“

  • SoMFString string
  • SoSFNode fontStyle
  • SoSFFloat maxExtent
  • SoMFFloat length

πŸ’œ Protected Member Functions πŸ’œ

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

Protected Member Functions inherited from SoVRMLGeometry

  • SoVRMLGeometry (void)
  • virtual ~SoVRMLGeometry ()
  • void setupShapeHints (SoState *state, const SbBool ccw, const SbBool solid)
  • virtual SbBool shouldGLRender (SoGLRenderAction *action)

Protected Member Functions inherited from SoShape

  • SoShape (void)
  • virtual ~SoShape ()
  • float getComplexityValue (SoAction *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 * createTriangleDetail (SoRayPickAction *action, const SoPrimitiveVertex *v1, const SoPrimitiveVertex *v2, const SoPrimitiveVertex *v3, SoPickedPoint *pp)
  • 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)
  • ~SoFieldContainer ()
bestie, this is only part 1 β€” more of this iconic manual page is coming, so don’t go anywhere πŸ’–βœ¨

πŸ’œ Protected Member Functions inherited from SoBase πŸ’œ

okay so these are the protected lil' helpers that SoBase hands down to everybody in the family tree β€” you don't call them from outside, but they're there:

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

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

🌈 Protected Attributes 🌈

  • SoChildList * children

πŸ’– Protected Attributes inherited from SoNode πŸ’–

  • uint32_t uniqueId

πŸ’– Protected Attributes inherited from SoFieldContainer πŸ’–

  • SbBool isBuiltIn

πŸ‘― Friends πŸ‘―

  • class SoVRMLTextP

🧚 Additional Inherited Members 🧚

πŸ’« Protected Types inherited from SoBase πŸ’«

  • enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

⭐ Static Protected Attributes inherited from SoNode ⭐

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

πŸ”₯ Detailed Description πŸ”₯

okay bestie, deep breath, because this is the big one: the SoVRMLText class is what you use to put text in a scene. literally just words, but in 3D. iconic.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

🚨 Important note: currently, the implementation of this node is not complete, and some of the features mentioned in the documentation below may not be working yet. 🚨

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

(yes, it says that twice, and yes, we're keeping both, no I don't make the rules πŸ’€)

Text {
  exposedField  MFString string    []
  exposedField  SFNode   fontStyle NULL
  exposedField  MFFloat  length    []      # [0,)
  exposedField  SFFloat  maxExtent 0.0     # [0,)
}

The Text node specifies a two-sided, flat text string object positioned in the Z=0 plane of the local coordinate system, based on values defined in the fontStyle field (see SoVRMLFontStyle). Text nodes may contain multiple text strings, specified using the UTF-8 encoding as specified by ISO 10646-1:1993 (see <http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/references.html#[UTF8]>). The text strings are stored in the order in which the text mode characters are to be produced, as defined by the parameters in the FontStyle node.

The text strings live in the string field. The fontStyle field contains one FontStyle node that specifies the font size, font family and style, the direction of the text strings, and any specific language rendering techniques used for the text. it's giving typography control freak, and we respect it πŸ’…

The maxExtent field limits and compresses all of the text strings if the length of the maximum string is longer than the maximum extent, as measured in the local coordinate system. If the text string with the maximum length is shorter than the maxExtent, then there is no compressing. The maximum extent is measured horizontally for horizontal text (FontStyle node: horizontal=TRUE) and vertically for vertical text (FontStyle node: horizontal=FALSE). The maxExtent field shall be greater than or equal to zero.

The length field contains an MFFloat value that specifies the length of each text string in the local coordinate system. If the string is too short, it is stretched (either by scaling the text or by adding space between the characters). If the string is too long, it is compressed (either by scaling the text or by subtracting space between the characters). If a length value is missing (for example, if there are four strings but only three length values), the missing values are considered to be 0. The length field shall be greater than or equal to zero.

Specifying a value of 0 for both the maxExtent and length fields indicates that the string may be any length. no cap, it's free ✨

πŸ‘€ See also πŸ‘€

  • SoVRMLFontStyle

πŸŽ€ Constructor & Destructor Documentation πŸŽ€

πŸ’– SoVRMLText::SoVRMLText (void ) πŸ’–

Constructor. the moment of birth, the origin story 🫢

References fontStyle, SoAsciiText::LEFT, length, maxExtent, and SoVRMLText().

Referenced by getFieldData(), and SoVRMLText().

πŸ’€ SoVRMLText::~SoVRMLText () πŸ’€ [protected], [virtual]

Destructor. she's leaving the group chat 😭


πŸ‘‘ Member Function Documentation πŸ‘‘

🌟 SoType SoVRMLText::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. it's the "who ARE you really" check πŸ”

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.

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

Reimplemented from SoVRMLGeometry.

🌟 const SoFieldData * SoVRMLText::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 SoVRMLGeometry.

References SoVRMLText().

🌟 void SoVRMLText::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 just wanna throw geometry primitives at OpenGL, override this method. throw those primitives bestie, we love a confident node πŸ’…

Reimplemented from SoShape.

References SoAsciiText::CENTER, SoAction::getState(), SoAsciiText::LEFT, length, maxExtent, SoDebugError::postWarning(), SoAsciiText::RIGHT, and SoVRMLGeometry::shouldGLRender().

🌟 void SoVRMLText::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. math girlies rise up πŸ”’

Nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoShape.

References SoGetPrimitiveCountAction::addNumText(), SoGetPrimitiveCountAction::addNumTriangles(), SoAction::getState(), and SoGetPrimitiveCountAction::is3DTextCountedAsTriangles().

🌟 void SoVRMLText::notify (SoNotList * l) 🌟 [virtual]

Notifies all auditors for this instance when changes are made. she's telling everyone, fr fr πŸ“£

Reimplemented from SoVRMLGeometry.

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

🌟 SoChildList * SoVRMLText::getChildren (void ) const 🌟 [virtual]

Returns list of children for this node.

Reimplemented from SoVRMLGeometry.

🌟 void SoVRMLText::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.

References SoAsciiText::CENTER, SbBox3f::extendBy(), SbBox3f::getCenter(), SbBox3f::getMin(), SoAction::getState(), SoAsciiText::LEFT, length, SoAsciiText::RIGHT, and SbBox3f::setBounds().

🌟 void SoVRMLText::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 use 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 SoShape::beginShape(), SoAsciiText::CENTER, SoShape::endShape(), SoAction::getState(), SoAsciiText::LEFT, length, maxExtent, SoDebugError::postWarning(), SoAsciiText::RIGHT, SoTextDetail::setCharacterIndex(), SoPrimitiveVertex::setDetail(), SoPrimitiveVertex::setMaterialIndex(), SoPrimitiveVertex::setNormal(), SoTextDetail::setPart(), SoPrimitiveVertex::setPoint(), SoTextDetail::setStringIndex(), SoPrimitiveVertex::setTextureCoords(), and SoShape::shapeVertex().


πŸ“ Member Data Documentation πŸ“

🌸 SoMFString SoVRMLText::string 🌸

The strings. Empty by default.

🌸 SoSFNode SoVRMLText::fontStyle 🌸

Can contain an SoVRMLFontStyle node.

Referenced by SoVRMLText().

🌸 SoSFFloat SoVRMLText::maxExtent 🌸

Maximum object space extent of longest string.

Referenced by generatePrimitives(), GLRender(), and SoVRMLText().

🌸 SoMFFloat SoVRMLText::length 🌸

Length of each string in the local coordinate system.

Referenced by computeBBox(), generatePrimitives(), GLRender(), and SoVRMLText().


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code. not me getting emotionally attached to an auto-generated doc 😭


and that's a wrap bestie!! this page came from the Coin docs β€” Coin, Version 2.5.0, and the page is SoVRMLText(3). slay, go render some text, ily πŸ«Άβœ¨πŸŽ€

πŸ“¦ where this page comes from