SoSFBitMask(3)

💖 SoSFBitMask 💖

okay bestie, welcome to the SoSFBitMask(3) page from the Library Functions Manual — yes we're in section 3, we're in the library, and we are about to get fully obsessed with a lil field that holds an entire SET of bit flags and looks gorgeous doing it. 🎀

---

✨ NAME ✨

SoSFBitMask — the SoSFBitMask class is a container for a set of bit flags.

that's it. that's the whole girl. container of bit flags. icon behavior only. 💅

---

🌸 SYNOPSIS 🌸

#include <Inventor/fields/SoSFBitMask.h>

Inherits SoSFEnum — yeah she comes from a rich family, she inherited literally everything. 👑

🫶 Public Member Functions

• virtual SoType getTypeId (void) const — hands you the type ID, the little name tag that says which Coin field class this baby belongs to.
• virtual void copyFrom (const SoField &field) — copies the value(s) out of field and into this one. plot twist: field has to be the same type as this field or it's not happening.
• const SoSFBitMask & operator= (const SoSFBitMask &field) — assignment operator, but make it SoSFBitMask-flavored.
• virtual SbBool isSame (const SoField &field) const — vibe check: same type? same value(s)? yes or no.
• int operator= (int newvalue) — drop a fresh int in there, very direct of her.

🧚 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 () — the destructor, she says bye.

🌈 Public Member Functions inherited from SoField

bestie this list is LONG and we do not skip a single line of it, so here it is, all of it, untouched:

virtual ~SoField ()
void setIgnored (SbBool ignore)
SbBool isIgnored (void) const
void setDefault (SbBool def)
SbBool isDefault (void) const
SbBool isOfType (const SoType type) const
void enableConnection (SbBool flag)
SbBool isConnectionEnabled (void) const
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=0)
void disconnect (SoEngineOutput *engineoutput)
SbBool isConnectedFromEngine (void) const
SbBool getConnectedEngine (SoEngineOutput *&master) const
SbBool connectFrom (SoField *master, SbBool notnotify=0, SbBool append=0)
SbBool appendConnection (SoField *master, SbBool notnotify=0)
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 *in, 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 Public Member Functions inherited from SoField

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

👯 Friends

• class SoMFBitMask — her bestie fr fr.

🧁 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=1)
• 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 🔥

The SoSFBitMask class is a container for a set of bit flags. (yes, we said it in NAME, we're saying it again, because it's the whole point of her existence.)

This field is used where nodes, engines or other field containers needs to store one particular set of bit flags from an enumerated set. so like… everywhere that needs a lil collection of flags from a menu of flags. periodt.

A field of this type stores its value to file as the symbolic names, rather than the actual integer bitmask. no cap, names only. And if more than one bit is set in the value when exporting, the bits are written like this: "(BITNAME|BITNAME|BITNAME|...)". pipes. so many pipes. it's giving pipeline. 🫧

See also

• SoMFBitMask

---

💅 Member Function Documentation 💅

🌸 getTypeId 🌸

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

Returns the type identification instance which uniquely identifies the Coin field class the object belongs to.

See also

• getClassTypeId(), SoType

Reimplemented from SoSFEnum.

🦋 copyFrom 🦋

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. (she said MUST. don't try to sneak a different type in here bestie, she will know. 😭)

Reimplemented from SoSFEnum.

💜 isSame 💜

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

Check for equal type and value(s). two boxes, two checks, one SbBool. slay.

Reimplemented from SoSFEnum.

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

---

and that's the whole page, bestie!! 🫶 you just read the entire SoSFBitMask(3) manual, every single inherited member function included, no skips, no cuts, we ate and left no crumbs. this little cutie is from Coin, Version 2.5.0, so go forth, set those bit flags, and write them out as symbolic names like the main character you are. bye bestie, ilysm 💖✨🎀