SoAsciiText(3)
π SoAsciiText π
okay so bestie, this is the manual page for SoAsciiText β it lives in the Library Functions Manual section of the Coin docs, and likeβ¦ it's giving class. Sit down, grab a strawberry, we're doing this together πβ¨
β¨ NAME β¨
SoAsciiText β the SoAsciiText class renders flat 3D text. yes, flat. 3D. text. all three of those words at once. iconic behaviour tbh π
π¦ SYNOPSIS π¦
#include <Inventor/nodes/SoAsciiText.h>
Inherits SoShape. so it's a shape node, it's got shape node energy, and it's carrying a whole inheritance tree of stuff behind it π
πΈ Public Types πΈ
enum Justification { LEFT = 1, RIGHT, CENTER }β your three justification vibes.LEFTis1, and thenRIGHTandCENTERjust keep counting up from there like the rest of the group chat showing up late.
π«Ά 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 }β the whole bitmask family tree, every single one, no skipping π€
π Public Member Functions π
virtual SoType getTypeId (void) constSoAsciiText (void)β the constructor, the birth of a legend β¨virtual void GLRender (SoGLRenderAction *action)virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
π§ Public Member Functions inherited from SoShape
virtual SbBool affectsState (void) constvirtual 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) constvoid setNodeType (const NodeType type)NodeType getNodeType (void) constvirtual SoNode * copy (SbBool copyconnections=0) constvirtual 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) constvirtual SoChildList * getChildren (void) constvirtual void writeInstance (SoOutput *out)virtual SoNode * addToCopyDict (void) constvirtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)virtual SoFieldContainer * copyThroughConnection (void) const
π§ Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)SbBool hasDefaultValues (void) constSbBool fieldsAreEqual (const SoFieldContainer *container) constvoid copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)SbBool set (const char *const fielddata)void get (SbString &fielddata)virtual int getFields (SoFieldList &l) constvirtual int getAllFields (SoFieldList &l) constvirtual SoField * getField (const SbName &name) constvirtual SoField * getEventIn (const SbName &name) constvirtual SoField * getEventOut (const SbName &name) constSbBool getFieldName (const SoField *const field, SbName &name) constSbBool enableNotify (const SbBool flag)SbBool isNotifyEnabled (void) constSbBool 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) constvoid setUserData (void *userdata) constvoid * getUserData (void) const
π§ Public Member Functions inherited from SoBase
void ref (void) constvoid unref (void) constvoid unrefNoDelete (void) constint32_t getRefCount (void) constvoid touch (void)SbBool isOfType (SoType type) constvirtual SbName getName (void) constvirtual 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) constSbBool 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 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 you're actually gonna be poking at, bestie. the whole lineup, right here, no gatekeeping:
SoMFString stringSoSFFloat spacingSoSFEnum justificationSoMFFloat width
π¦ Protected Member Functions π¦
virtual const SoFieldData * getFieldData (void) constvirtual ~SoAsciiText ()virtual void computeBBox (SoAction *action, SbBox3f &box, SbVec3f ¢er)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)
π 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)~SoFieldContainer ()
π Protected Member Functions inherited from SoBase
SoBase (void)virtual ~SoBase ()virtual void destroy (void)SbBool hasMultipleWriteRefs (void) constSbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) constvoid writeFooter (SoOutput *out) constvirtual 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)
okay so that's the whole synopsis situation, every last signature accounted for, not one single one left behind, we don't do that here π«Ά and there's more coming β like, a lot more β so stay with me, we are absolutely not done yet π
static const SoFieldData ** getFieldDataPtr (void)β grabs the pointer to the class-wide field data table πstatic void setNextActionMethodIndex (int index)β sets that next-action-method index thingstatic int getNextActionMethodIndex (void)β reads it back outstatic void incNextActionMethodIndex (void)β bumps it up by one, go off queenstatic void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)β wires up compatibility types for a givennodetype+bitmask
Static protected member functions you also inherit from SoBase:
static uint32_t getCurrentWriteCounter (void)β returns the current write counter β¨static void staticDataLock (void)β locks the static datastatic void staticDataUnlock (void)β unlocks it again, we love a balanced pair
π«Ά Friends π«Ά
class SoAsciiTextPβ bestie has special access, iykyk
π Additional Inherited Members π
Protected types inherited from SoBase:
enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }
Protected attributes inherited from SoNode:
uint32_t uniqueId
Protected attributes inherited from SoFieldContainer:
SbBool isBuiltIn
Static protected attributes inherited from SoNode:
static uint32_t nextUniqueId = 0static int nextActionMethodIndex = 0
β¨ Detailed Description β¨
So the SoAsciiText class renders flat 3D text. No cap, it's literally flat 3D text and it's iconic π
The text is rendered using 3D polygon 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 no SoFont-nodes are used at all? The default is 10. Slay.
The complexity of the glyphs is controlled by a preceding SoComplexity node with Type set to OBJECT_SPACE. But heads up bestie: the default builtin 3D font will not be affected by the SoComplexity node. Nope. Not it. π«
This node is different from the SoText2 node in that it rotates, scales, translates etc just like other geometry in the scene. And it's different from the SoText3 node in that it renders the text "flat", i.e. it does not extrude the fonts to have depth. Flat is the vibe here π¦
Wanna get an intuitive feeling for how SoAsciiText works? Take a look at this sample Inventor file in examinerviewer:
#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. (Yes that's the whole flex π
)
FILE FORMAT/DEFAULTS:
AsciiText {
string ""
spacing 1
justification LEFT
width 0
}
π Since π
Inventor 2.1 β vintage but make it fashion π
πΈ Member Enumeration Documentation πΈ
enum SoAsciiText::Justification
The font justification values control the text alignment. Justification can have three distinct values, bestie, three.
The default value is SoAsciiText::LEFT, and the strings are rendered with a common left border. The second value is SoAsciiText::RIGHT, and it renders the strings with a common right border. The last value is SoAsciiText::CENTER, in which the strings are rendered with their centers aligned. And the origo of the three alignments are respectively left, right and center, located at the baseline of the first line of text. The way that works is so satisfying honestly π
Enumerator
LEFTβ The strings are left-aligned; rendered with a common left border. This is the default alignment. πRIGHTβ The strings are right-aligned; rendered with a common right border.CENTERβ The text is center-aligned; all strings are centered. Main character energy, obviously.
π§ Constructor & Destructor Documentation π§
SoAsciiText::SoAsciiText (void )
Constructor. The moment of creation, the origin story β¨
References CENTER, justification, LEFT, RIGHT, SoAsciiText(), spacing, and width.
Referenced by getFieldData(), and SoAsciiText().
SoAsciiText::~SoAsciiText () [protected], [virtual]
Destructor. She's done, she's leaving, we thank her for her service π
β Member Function Documentation β
SoType SoAsciiText::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
}
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. No skipping, bestie. 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 * 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. Nothing there, empty, ghosted π»
Reimplemented from SoShape.
References SoAsciiText().
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 who wants to throw geometry primitives at OpenGL overrides this method.
Reimplemented from SoShape.
References CENTER, SoAction::getState(), SoState::isElementEnabled(), justification, SoDebugError::postWarning(), RIGHT, SoShape::shouldGLRender(), and spacing.
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. Math! Counting! She contains multitudes π₯
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(), SoGetPrimitiveCountAction::addNumTriangles(), SoAction::getState(), and SoGetPrimitiveCountAction::is3DTextCountedAsTriangles().
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(). Don't do it, I'm begging π)
The box parameter sent in is guaranteed to be an empty box, while center is undefined upon function entry.
Implements SoShape.
References CENTER, SbBox3f::extendBy(), SbBox3f::getCenter(), SbBox3f::getMin(), SoAction::getState(), SbBox3f::isEmpty(), justification, LEFT, RIGHT, SbBox3f::setBounds(), and spacing.
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(). Same energy as above β hands off π€)
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 SoShape::beginShape(), CENTER, SoShape::endShape(), SoAction::getState(), justification, SoDebugError::postWarning(), RIGHT, SoTextDetail::setCharacterIndex(), SoPrimitiveVertex::setDetail(), SoPrimitiveVertex::setMaterialIndex(), SoPrimitiveVertex::setNormal(), SoTextDetail::setPart(), SoPrimitiveVertex::setPoint(), SoTextDetail::setStringIndex(), SoPrimitiveVertex::setTextureCoords(), SoShape::shapeVertex(), and spacing.
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. Your call bestie π
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 SoAsciiText::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 π
This is where we meet the actual data members that make SoAsciiText do its thing. no cap, every single one matters. let's go. π«Ά
πΈ SoMFString SoAsciiText::string
This is literally the lines of text you wanna render. It's a multifield, so you can specify several strings, and each string represents a line. Default value is a single empty string. periodt. π
β¨ SoSFFloat SoAsciiText::spacing
Spacing between each line. Defaults to 1.0.
- Referenced by:
computeBBox(),generatePrimitives(),GLRender(), andSoAsciiText().
π SoSFEnum SoAsciiText::justification
Horizontal alignment. Default SoAsciiText::LEFT.
- Referenced by:
computeBBox(),generatePrimitives(),GLRender(), andSoAsciiText().
π¦ SoMFFloat SoAsciiText::width
This one defines the width of each line. The text is scaled to be within the specified units. The size of the characters will remain the same; only the x-positions are scaled. When width <= 0, the width value is ignored and the text rendered as normal. 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. If fewer widths are specified than the number of strings, the strings without matching widths are rendered with default width.
- Referenced by:
SoAsciiText().
π Author π
Generated automatically by Doxygen for Coin from the source code. slay. π
And that's the whole vibe, bestie! The footer says Coin, Version 2.5.0, page SoAsciiText(3) β source/version and page name, no date in the footer, but you know I'd tell you if there was one. π
β¨
π¦ where this page comes from
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 43: Coin2-devel 2.5.0-52.fc43 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- fedora 44: Coin2-devel 2.5.0-54.fc44 Β· GPL-2.0-only
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms