SoFontStyle(3)

📦 version 2.5.0, in fedora 43, fedora 44

🌸 SoFontStyle(3) 🌸

okay bestie, pull up a chair 🫶 this is SoFontStyle from the Library Functions Manual, and she's here to change the appearance of fonts for text rendering nodes. iconic behavior, honestly 💅

✨ NAME ✨

SoFontStyle — the class that changes the appearance of fonts for text rendering nodes 💖

🎀 SYNOPSIS 🎀

#include <Inventor/nodes/SoFontStyle.h>

Inherits SoFont.

👑 Public Types

  • enum Family { SERIF, SANS, TYPEWRITER }
  • enum Style { NONE, BOLD, ITALIC }

🦋 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
  • SoFontStyle (void)
  • SbString getFontName (void) const
  • virtual void doAction (SoAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)

🌈 Public Member Functions inherited from SoFont

  • SoFont (void)

🌈 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 SbBool affectsState (void) const
  • 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 rayPick (SoRayPickAction *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)
  • virtual void notify (SoNotList *l)
  • 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

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

🧚 Static Public Member Functions inherited from SoFont

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

🧚 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

  • SoSFEnum family
  • SoSFBitMask style

🎀 Public Attributes inherited from SoFont

  • SoSFName name
  • SoSFFloat size

🔥 Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoFontStyle ()

💜 Protected Member Functions inherited from SoFont

  • virtual ~SoFont ()

💜 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 SoFont

  • 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

  • uint32_t uniqueId

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

Static Protected Attributes inherited from SoNode

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

💅 Detailed Description 💅

so like, the SoFontStyle class changes the appearance of fonts for text rendering nodes. that's the whole gig 💖

Successive text rendering nodes will use fonts with the style settings of this node, if a font with the given settings can be found and loaded from the system. bestie it's out here manifesting your font dreams ✨

If the specified font style cannot be found on the client system, a default fallback will be used. So the application programmer must consider SoFontStyle nodes as nodes giving hints about font settings, as you are not guaranteed to get exactly what you want. 🥲 it's giving "suggestion, not a contract" — manage your expectations, queen.

Currently the SERIF family is mapped to "Times New Roman", SANS is mapped to "Arial" and TYPEWRITER is mapped to "Courier New". the mapping, she's mapped 💅

Please note that this node is inheriting SoFont. Previous font settings in a branch will therefore be overwritten with the default values of SoFont if an empty SoFontStyle node is inserted in the branch. 😭 yes bestie she will steamroll your earlier settings, that's the way it is.

NB! This node is provided for reasons of compatibility with Open Inventor 2.1 but will in most cases result in the default font being rendered. It is highly recommended to use the SoFont node instead. 🚨 okay so this is the important part: she's here for Open Inventor 2.1 compatibility, and most of the time you'll just get the default font. use SoFont instead, fr fr. 👑

FILE FORMAT/DEFAULTS:

FontStyle {
    name "defaultFont"
    size 10
    family SERIF
    style ()
}

Since

  • Inventor 2.1

See also

  • SoFont, SoText2, SoText3, SoAsciiText, SoGlyph

🌈 Member Enumeration Documentation 🌈

enum SoFontStyle::Family

Enumeration of the font family to use. pick your fighter 🎀

enum SoFontStyle::Style

Enumeration of font style characteristics. the vibe options, basically ✨

🧚 Constructor & Destructor Documentation 🧚

SoFontStyle::SoFontStyle (void )

Constructor. 💖

References family, SoFontStyle(), and style.

Referenced by getFieldData(), and SoFontStyle().

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

Destructor. 🥲

bestie this is only part 1 — more is coming, don't go anywhere 💜

💖 Member Function Documentation 💖

✨ SoType SoFontStyle::getTypeId (void ) const [virtual]

Bestie, this one is the ID check of the whole class system. It hands you back the type identification of an object derived from a class that inherits SoBase. What's it for? Run-time type checking and "downward" casting, babes. That's it, that's the gig. 💅

Usage example, and yes it's giving very much copy-this-exactly:

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
  }
}

So if you're an application programmer who wants to extend the library with brand-new nodes, engines, nodekits, draggers or whatever else — this method needs to be overridden in all subclasses. No skipping it, fr fr. 🙈

Usually you do that as part of setting up the full type system for your extension classes, which is normally accomplished by using the pre-defined macros available through, for instance, Inventor/nodes/SoSubNode.h (that's SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes), and so on and so forth. 🦋

Want more info on writing Coin extensions? Go read the class documentation of the toplevel superclasses for the various class groups. It's all in there. 👑

Reimplemented from SoFont.

🌸 const SoFieldData * SoFontStyle::getFieldData (void ) const [protected], [virtual]

Returns a pointer to the class-wide field data storage object for this instance. And if there are no fields present? It returns NULL. That's the whole vibe. 💀

Reimplemented from SoFont.

References SoFontStyle().

🎀 SbString SoFontStyle::getFontName (void ) const

Returns a system-specific text string to use for font loading, based on the style settings of this node. That's the tea. 🫶

References family, SbString::getString(), SoFont::name, SoDebugError::postWarning(), and style.

🌈 void SoFontStyle::doAction (SoAction * action) [virtual]

This function performs the typical operation of a node for any action. Any of them. All of them. It's the main character of node behaviour, periodt. 👑

Reimplemented from SoFont.

References SoAction::getState(), SoNode::isOverride(), SoFont::name, SoOverrideElement::setFontNameOverride(), SoOverrideElement::setFontSizeOverride(), and SoFont::size.

Referenced by callback(), getBoundingBox(), getPrimitiveCount(), GLRender(), and pick().

💜 void SoFontStyle::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

Action method for the SoGetBoundingBoxAction. 🦋

Calculates bounding box and center coordinates for the node, and modifies the values of the action to encompass the bounding box for this node — and to shift the center point for the scene more towards the one for this node. Very "make it about me" of it, and honestly? Valid. ✨

Nodes that influence how geometry nodes calculate their bounding box also override this method, so they can change the relevant state variables.

Reimplemented from SoFont.

References doAction().

⭐ void SoFontStyle::GLRender (SoGLRenderAction * action) [virtual]

Action method for the SoGLRenderAction. 🔥

This one gets called during rendering traversals. Nodes that influence the rendering state in any way — or that just want to throw geometry primitives at OpenGL — override this method. If that's your node, this is your moment. Slay.

Reimplemented from SoFont.

References doAction().

🍓 void SoFontStyle::callback (SoCallbackAction * action) [virtual]

Action method for SoCallbackAction. 🌸

It simply updates the state according to how the node behaves for the render action, so that you, the application programmer, can use SoCallbackAction for extracting information about the scene graph. Lowkey the most useful little guy here. 🫶

Reimplemented from SoFont.

References doAction().

🧚 void SoFontStyle::pick (SoPickAction * action) [virtual]

Action method for SoPickAction. ✨

Does common processing for SoPickAction action instances. That's the whole description, bestie, it's short and it knows it.

Reimplemented from SoFont.

References doAction().

💅 void SoFontStyle::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. Counting era, we love to see it. 🔢

Nodes that influence how geometry nodes calculate their primitive count also override this method, so they can change the relevant state variables.

Reimplemented from SoFont.

References doAction().

🎀 Member Data Documentation 🎀

  • SoSFEnum SoFontStyle::family — Font family hint. 🦋
    • Referenced by getFontName(), and SoFontStyle().
  • SoSFBitMask SoFontStyle::style — Font style hint. 💜
    • Referenced by getFontName(), and SoFontStyle().

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. Not a human, not a bestie, just Doxygen doing its lil thing. 🤖💖

And that's a wrap on SoFontStyle(3)! This page came straight out of the Coin source, Version 2.5.0, and the footer's whole personality was just "Coin · Version 2.5.0 · SoFontStyle(3)" — so there you go, babes, source and version noted, no cap. Go forth and style your fonts. 🎀✨

📦 where this page comes from