SoFontStyle(3)

📦

version 4.0.10 · 4 versions

4.0.10 · fedora 43, fedora 44 (latest)
4.0.10 · epel 9
4.0.3 · fedora 43
4.0.7 · fedora 44

SoFontStyle(3) 💖

okay bestie, gather round, because this is a Coin manual page and it's about to be your new obsession. we're in section 3 (library functions, iykyk), and the whole vibe here is fonts. yes, fonts. the glow-up kind. ✨

NAME 🎀

SoFontStyle — The SoFontStyle class changes the appearance of fonts for text rendering nodes.

literally it's the node that gives your text a whole new look. main character energy for your fonts, no cap. 💅

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,
    COIN_3_0 = 0x8000, INVENTOR_6_0 = 0x10000, COIN_4_0 = 0x20000 }

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=FALSE) 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)
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 the type of this object is either of the same type or inherited from type.
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)
- Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Static Public Member Functions inherited from SoFont 💖

static SoType getClassTypeId (void)
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 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 💅

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)
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 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
- SbUniqueId uniqueId
Protected Attributes inherited from SoFieldContainer
- SbBool isBuiltIn
Static Protected Attributes inherited from SoNode
- static SbUniqueId nextUniqueId = 1
- static int nextActionMethodIndex = 0

bestie this is only part 1, so hold that thought — more is literally coming. don't go anywhere 💖

💖 DETAILED DESCRIPTION 💖

okay so bestie, SoFontStyle is literally the node that changes the appearance of fonts for text rendering nodes. she's the font glow-up node, that's her whole job ✨

Here's the tea: successive text rendering nodes will use fonts with the style settings of this node — but ONLY if a font with the given settings can be found and loaded from the system. iykyk.

And if the specified font style cannot be found on the client system? a default fallback gets used. periodt. So the application programmer must consider SoFontStyle nodes as nodes giving hints about font settings, because you are not guaranteed to get exactly what you want 😭 it's giving "suggestions welcome" energy.

Currently, for the record:

the SERIF family is mapped to "Times New Roman" 🎀
SANS is mapped to "Arial"
TYPEWRITER is mapped to "Courier New"

🚨 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. so like, watch out, she will absolutely steamroll your earlier font vibes.

💀 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. not me telling you the new thing is better, but also, the new thing is better 🙈

FILE FORMAT/DEFAULTS:

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

Since: SGI Inventor 2.1 — she's an elder icon, been here since forever 👑

See also: SoFont, SoText2, SoText3, SoAsciiText

🧬 MEMBER ENUMERATION DOCUMENTATION 🧬

enum SoFontStyle::Family

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

Enumerator

SERIF — Serif font family should be used.
SANS — Sans serif font family should be used.
TYPEWRITER — Type writer font family should be used.

enum SoFontStyle::Style

Enumeration of font style characteristics. the lil accessories for your font 🎀

Enumerator

NONE — No modification to the style attributes of the font family.
BOLD — The bold font of the font family should be used.
ITALIC — The italic font of the font family should be used.

🔨 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 🔨

SoFontStyle::SoFontStyle (void )

Constructor. she's born ✨

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

Destructor. she's gone 🦋

🌸 MEMBER FUNCTION DOCUMENTATION 🌸

SoType SoFontStyle::getClassTypeId (void ) [static]

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

SoType SoFontStyle::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.