SoSFBitMask(3)

✨ SoSFBitMask ✨

okay bestie, welcome to the manual page for SoSFBitMask(3) — it lives in the Library Functions Manual and it's literally the whole vibe for storing a little bundle of bit flags. pull up a chair 🫶

---

💖 NAME 💖

SoSFBitMask — the SoSFBitMask class is a container for a set of bit flags. no cap, that's the whole job. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFBitMask.h>

It inherits from SoSFEnum. yes ma'am, it's giving "enum but make it a mask". 🧚

✨ 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

Protected Attributes inherited from SoSFEnum

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

---

🦋 Detailed Description 🦋

So like… the SoSFBitMask class is a container for a set of bit flags. (yes, same sentence as NAME, it's consistent, we love that for her 💅)

This field is used where nodes, engines or other field containers need to store one particular set of bit flags from an enumerated set.

A field of this type stores its value to file as the symbolic names, rather than the actual integer bitmask. and if more than one bit is set in the value when exporting, the bits are written like this:

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

SoSFBitMask instances are derived from SoSFEnum instances, and they're initialized in the exact same way, using the exact same enum-field-related macros. periodt. 🫶

See also

• SoMFBitMask
• SoSFEnum

---

💅 Member Function Documentation 💅

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to. it's literally the "who dis" of Coin fields 🔥

See also

• getClassTypeId()
• SoType

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, it's not that kind of party 🙈)

Reimplemented from SoSFEnum.

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

Check for equal type and value(s). slay, a vibe check. ✨

Reimplemented from SoSFEnum.

---

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code.

---

and that's the whole page, bestie 💖 this one's Coin, Version 3.1.3 — go forth and mask those bits, you absolute icon 👑🦋✨