SoSFBitMask(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

✨ SoSFBitMask ✨

okay bestie, pull up a chair, because we're about to get SO cozy with the SoSFBitMask class from Coin's manual page SoSFBitMask(3) 💖

🌸 NAME 🌸

SoSFBitMask — the class that's literally just a container for a set of bit flags. that's it. that's the whole vibe. 🎀

🦋 SYNOPSIS 🦋

#include <Inventor/fields/SoSFBitMask.h>

Inherits SoSFEnum. yes, it's giving nepo baby, and honestly? iconic. 👑

💅 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual void copyFrom (const SoField &field)
  • const SoSFBitMask & operator= (const SoSFBitMask &field)
  • virtual SbBool isSame (const SoField &field) const
  • int operator= (int newvalue)

🫶 Public Member Functions inherited from SoSFEnum

  • const SoSFEnum & operator= (const SoSFEnum &field)
  • int getValue (void) const
  • void setValue (int newvalue)
  • int operator= (int newvalue)
  • int operator== (const SoSFEnum &field) const
  • int operator!= (const SoSFEnum &field) const
  • void setValue (const SbName name)
  • void setEnums (const int num, const int *vals, const SbName *names)
  • int getNumEnums (void) const
  • int getEnum (const int idx, SbName &name) const

✨ Public Member Functions inherited from SoSField

  • virtual ~SoSField ()

💜 Public Member Functions inherited from SoField

  • virtual ~SoField ()
  • void setIgnored (SbBool ignore)
  • SbBool isIgnored (void) const
  • void setDefault (SbBool defaultVal)
  • SbBool isDefault (void) const
  • SbBool isOfType (const SoType type) const
  • void enableConnection (SbBool flag)
  • SbBool isConnectionEnabled (void) const
  • SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
  • void disconnect (SoEngineOutput *engineoutput)
  • SbBool isConnectedFromEngine (void) const
  • SbBool getConnectedEngine (SoEngineOutput *&master) const
  • SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
  • SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
  • void disconnect (SoField *field)
  • SbBool isConnectedFromField (void) const
  • SbBool getConnectedField (SoField *&master) const
  • int getNumConnections (void) const
  • int getForwardConnections (SoFieldList &slavelist) const
  • int getConnections (SoFieldList &masterlist) const
  • void disconnect (void)
  • SbBool isConnected (void) const
  • void setContainer (SoFieldContainer *cont)
  • SoFieldContainer * getContainer (void) const
  • SbBool set (const char *valuestring)
  • void get (SbString &valuestring)
  • SbBool shouldWrite (void) const
  • virtual void touch (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *nlist)
  • SbBool enableNotify (SbBool on)
  • SbBool isNotifyEnabled (void) const
  • void addAuditor (void *f, SoNotRec::Type type)
  • void removeAuditor (void *f, SoNotRec::Type type)
  • int operator== (const SoField &f) const
  • int operator!= (const SoField &f) const
  • virtual void connectionStatusChanged (int numconnections)
  • SbBool isReadOnly (void) const
  • virtual void fixCopy (SbBool copyconnections)
  • virtual SbBool referencesCopy (void) const
  • void copyConnection (const SoField *fromfield)
  • virtual SbBool read (SoInput *input, const SbName &name)
  • virtual void write (SoOutput *out, const SbName &name) const
  • virtual void countWriteRefs (SoOutput *out) const
  • void setFieldType (int type)
  • int getFieldType (void) const
  • SbBool getDirty (void) const
  • void setDirty (SbBool dirty)
  • void evaluate (void) const

🌈 Static Public Member Functions

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

🍓 Static Public Member Functions inherited from SoSFEnum

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

🧚 Static Public Member Functions inherited from SoSField

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

⭐ Static Public Member Functions inherited from SoField

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

🎀 Additional Inherited Members

💫 Public Types inherited from SoField

  • enum FieldType { NORMAL_FIELD = 0, EVENTIN_FIELD, EVENTOUT_FIELD, EXPOSED_FIELD }

🦋 Protected Member Functions inherited from SoSFEnum

  • virtual SbBool findEnumValue (const SbName &name, int &val)
  • virtual SbBool findEnumName (int value, const SbName *&name) const

🌸 Protected Member Functions inherited from SoSField

  • SoSField (void)

💖 Protected Member Functions inherited from SoField

  • SoField (void)
  • void valueChanged (SbBool resetdefault=TRUE)
  • virtual void evaluateConnection (void) const
  • virtual SbBool readConnection (SoInput *in)
  • virtual void writeConnection (SoOutput *out) const
  • SbBool isDestructing (void) const
  • virtual SoNotRec createNotRec (SoBase *cont)

👑 Protected Attributes inherited from SoSFEnum

  • int value
  • int numEnums
  • int * enumValues
  • SbName * enumNames
  • SbBool legalValuesSet

💅 Detailed Description 💅

okay so the SoSFBitMask class is, and I cannot stress this enough, a container for a set of bit flags. that's her whole job. she contains bit flags. periodt. ✨

so like, this field is what you use when nodes, engines, or other field containers need to store one particular set of bit flags from an enumerated set. it's a very specific girlboss role and she does it flawlessly. 💖

here's the cute part: a field of this type stores its value to file as the symbolic names, not the actual integer bitmask. so if more than one bit is set in the value when exporting, the bits get written out like this:

"(BITNAME|BITNAME|BITNAME|...)"

yes bestie, with the pipes and the parentheses. that's the whole fit. 🔥

and ngl, SoSFBitMask instances are derived from SoSFEnum instances — the family resemblance is real — and they get initialized in the exact same way, using the exact same enum-field-related macros. no new tricks, no secret handshake. 🫶

See also

  • SoMFBitMask, SoSFEnum

🌈 Member Function Documentation 🌈

void * SoSFBitMask::createInstance (void ) [static]

so, fair warning — this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. iykyk, but also like… you don't need to know. 🙈

it creates a new instance of the class type corresponding to the SoType object. ✨

SoType SoSFBitMask::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. it's literally just handing you the type. slay. 💅

SoType SoSFBitMask::getTypeId (void ) const [virtual]

returns the type identification of an object derived from a class inheriting SoField. this is what you use for runtime type checking and "downward" casting. 🦋

Reimplemented from SoSFEnum.

void SoSFBitMask::copyFrom (const SoField & f) [virtual]

copy value(s) from f into this field. f must be of the same type as this field — no mixing, bestie, she's not flexible like that. 💀

Reimplemented from SoSFEnum.

SbBool SoSFBitMask::isSame (const SoField & f) const [virtual]

checks for equal type and value(s). basically a vibe check but for fields. 🎀

Reimplemented from SoSFEnum.

void SoSFBitMask::initClass (void ) [static]

internal method called upon initialization of the library (from SoDB::init()) to set up the type system. very backstage, very stage-manager energy. 👑

🧚 Author 🧚

Generated automatically by Doxygen for Coin from the source code. no human wrote this, she was born fully-formed from a doc generator and we respect her for it. 🫶

and that's the whole page bestie!! 💖 this was version 4.0.10, dated Thu Jun 25 2026 00:00:00, and yeah — that timestamp is giving future girl, we know, we're obsessed. go forth and contain some bit flags. periodt. ✨🌸💅

📦 where this page comes from