SoMFBitMask(3)

📦 version 2.5.0, in fedora 43, fedora 44

🎀 NAME 🎀

SoMFBitMask — bestie, it's a container for a set of bitmasks. That's the whole job. 💅

(and yes, this page is living in the Library Functions Manual, under the name SoMFBitMask(3) — folded in near the top, cute, we move on 🫶)

✨ SYNOPSIS ✨

#include <Inventor/fields/SoMFBitMask.h>

Inherits SoMFEnum. Periodt.

💖 Public Member Functions 💖

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

🦋 Public Member Functions inherited from SoMFEnum 🦋

  • const SoMFEnum & operator= (const SoMFEnum &field)
  • int operator[] (const int idx) const
  • const int * getValues (const int start) const
  • int find (int value, SbBool addifnotfound=0)
  • void setValues (const int start, const int num, const int *newvals)
  • void set1Value (const int idx, int value)
  • void setValue (int value)
  • int operator= (int val)
  • SbBool operator== (const SoMFEnum &field) const
  • SbBool operator!= (const SoMFEnum &field) const
  • int * startEditing (void)
  • void finishEditing (void)
  • void setValue (const SbName name)
  • void set1Value (const int idx, const SbName name)
  • void setEnums (const int num, const int *const values, const SbName *const names)
  • int getNumEnums (void) const
  • int getEnum (const int idx, SbName &name) const

🌸 Public Member Functions inherited from SoMField 🌸

  • virtual ~SoMField ()
  • int getNum (void) const
  • void setNum (const int num)
  • virtual void deleteValues (int start, int num=-1)
  • virtual void insertSpace (int start, int num)
  • SbBool set1 (const int index, const char *const valuestring)
  • void get1 (const int index, SbString &valuestring)
  • virtual void enableDeleteValues (void)
  • virtual SbBool isDeleteValuesEnabled (void)

🌈 Public Member Functions inherited from SoField 🌈

  • 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 SoMFEnum 💜

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

🧚 Static Public Member Functions inherited from SoMField 🧚

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

🍓 Static Public Member Functions inherited from SoField 🍓

  • static void initClass (void)
  • static void initClasses (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 SoMFEnum 🔥

  • virtual void deleteAllValues (void)
  • virtual void copyValue (int to, int from)
  • virtual int fieldSizeof (void) const
  • virtual void * valuesPtr (void)
  • virtual void setValuesPtr (void *ptr)
  • virtual void allocValues (int num)
  • virtual SbBool findEnumValue (const SbName &name, int &value)
  • virtual SbBool findEnumName (int value, const SbName *&name) const

🩷 Protected Member Functions inherited from SoMField 🩷

  • SoMField (void)
  • virtual void makeRoom (int newnum)

💀 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 SoMFEnum 🦄

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

🌻 Protected Attributes inherited from SoMField 🌻

  • int num
  • int maxNum
  • SbBool userDataIsUsed

💖 Detailed Description 💖

The SoMFBitMask class is a container for a set of bitmasks. Yeah, we said it in the NAME section too, but it bears repeating because it's literally the entire personality of this class. 💅

This field is used where nodes, engines or other field containers needs to store multiple bitmasks with values from an enumerated set. So like, one field, many bitmask values, all coming from an enum. Slay. ✨

See also

  • SoSFBitMask — its single-value sibling, go say hi 🫶

📖 Member Function Documentation 📖

🦋 SoType SoMFBitMask::getTypeId (void ) const [virtual] 🦋

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

Basically it's the "who am I" of the field. Main character energy, but for type systems. 👑

See also

  • getClassTypeId(), SoType

Reimplemented from SoMFEnum.

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

Copy value(s) from f into this field. f must be of the same type as this field.

⚠️ no cap: if f isn't the same type as this field, that's not it, bestie. Type match or nothing. 💀

Reimplemented from SoMFEnum.

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

Check for equal type and value(s). That's the vibe check — same type, same values, or we're not the same. 🌸

Reimplemented from SoMFEnum.

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. Not a human, just a very diligent little robot doing its thing. 🤖✨

aaaand that's the whole page, bestie 🎀 — this was Coin, Version 2.5.0, and the page was SoMFBitMask(3). Love that for us. Bye bye, go set some bitmasks 💖🦋

📦 where this page comes from