Coin  4.0.3
Coin3D core library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
SoSFBitMask Class Reference
Field Classes

The SoSFBitMask class is a container for a set of bit flags. More...

#include <Inventor/fields/SoSFBitMask.h>

Inheritance diagram for SoSFBitMask:
SoSFEnum SoSField SoField

Public Member Functions

virtual void copyFrom (const SoField &field)
 
virtual SoType getTypeId (void) const
 
virtual SbBool isSame (const SoField &field) const
 
const SoSFBitMask & operator= (const SoSFBitMask &field)
 
int operator= (int newvalue)
 
- Public Member Functions inherited from SoSFEnum
int getEnum (const int idx, SbName &name) const
 
int getNumEnums (void) const
 
int getValue (void) const
 
int operator!= (const SoSFEnum &field) const
 
const SoSFEnum & operator= (const SoSFEnum &field)
 
int operator= (int newvalue)
 
int operator== (const SoSFEnum &field) const
 
void setEnums (const int num, const int *vals, const SbName *names)
 
void setValue (const SbName name)
 
void setValue (int newvalue)
 
- Public Member Functions inherited from SoSField
virtual ~SoSField ()
 
- Public Member Functions inherited from SoField
virtual ~SoField ()
 
void addAuditor (void *f, SoNotRec::Type type)
 
SbBool appendConnection (SoEngineOutput *master, SbBool notnotify=FALSE)
 
SbBool appendConnection (SoField *master, SbBool notnotify=FALSE)
 
SbBool connectFrom (SoEngineOutput *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
SbBool connectFrom (SoField *master, SbBool notnotify=FALSE, SbBool append=FALSE)
 
virtual void connectionStatusChanged (int numconnections)
 
void copyConnection (const SoField *fromfield)
 
virtual void countWriteRefs (SoOutput *out) const
 
void disconnect (SoEngineOutput *engineoutput)
 
void disconnect (SoField *field)
 
void disconnect (void)
 
void enableConnection (SbBool flag)
 
SbBool enableNotify (SbBool on)
 
void evaluate (void) const
 
virtual void fixCopy (SbBool copyconnections)
 
void get (SbString &valuestring)
 
SbBool getConnectedEngine (SoEngineOutput *&master) const
 
SbBool getConnectedField (SoField *&master) const
 
int getConnections (SoFieldList &masterlist) const
 
SoFieldContainer * getContainer (void) const
 
SbBool getDirty (void) const
 
int getFieldType (void) const
 
int getForwardConnections (SoFieldList &slavelist) const
 
int getNumConnections (void) const
 
SbBool isConnected (void) const
 
SbBool isConnectedFromEngine (void) const
 
SbBool isConnectedFromField (void) const
 
SbBool isConnectionEnabled (void) const
 
SbBool isDefault (void) const
 
SbBool isIgnored (void) const
 
SbBool isNotifyEnabled (void) const
 
SbBool isOfType (const SoType type) const
 
SbBool isReadOnly (void) const
 
virtual void notify (SoNotList *nlist)
 
int operator!= (const SoField &f) const
 
int operator== (const SoField &f) const
 
virtual SbBool read (SoInput *input, const SbName &name)
 
virtual SbBool referencesCopy (void) const
 
void removeAuditor (void *f, SoNotRec::Type type)
 
SbBool set (const char *valuestring)
 
void setContainer (SoFieldContainer *cont)
 
void setDefault (SbBool defaultVal)
 
void setDirty (SbBool dirty)
 
void setFieldType (int type)
 
void setIgnored (SbBool ignore)
 
SbBool shouldWrite (void) const
 
virtual void startNotify (void)
 
virtual void touch (void)
 
virtual void write (SoOutput *out, const SbName &name) 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 atexit_cleanup (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
- Static Public Member Functions inherited from SoField
static void cleanupClass (void)
 
static SoType getClassTypeId (void)
 
static void initClass (void)
 
static void initClasses (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 findEnumName (int value, const SbName *&name) const
 
virtual SbBool findEnumValue (const SbName &name, int &val)
 
- Protected Member Functions inherited from SoSField
 SoSField (void)
 
- Protected Member Functions inherited from SoField
 SoField (void)
 
virtual SoNotRec createNotRec (SoBase *cont)
 
virtual void evaluateConnection (void) const
 
SbBool isDestructing (void) const
 
virtual SbBool readConnection (SoInput *in)
 
void valueChanged (SbBool resetdefault=TRUE)
 
virtual void writeConnection (SoOutput *out) const
 
- Protected Attributes inherited from SoSFEnum
SbName * enumNames
 
int * enumValues
 
SbBool legalValuesSet
 
int numEnums
 
int value
 

Detailed Description

The SoSFBitMask class is a container for a set of bit flags.

This field is used where nodes, engines or other field containers needs 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. 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 are initialized in the same way using the exact same enum-field-related macros.

See also
SoMFBitMask, SoSFEnum

Member Function Documentation

◆ 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.

Reimplemented from SoSFEnum.

◆ createInstance()

void * SoSFBitMask::createInstance ( void )
static

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object.

◆ getClassTypeId()

SoType SoSFBitMask::getClassTypeId ( void )
static

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

◆ getTypeId()

SoType SoSFBitMask::getTypeId ( void ) const
virtual

Returns the type identification of an object derived from a class inheriting SoField. This is used for runtime type checking and "downward" casting.

Reimplemented from SoSFEnum.

◆ initClass()

void SoSFBitMask::initClass ( void )
static

Internal method called upon initialization of the library (from SoDB::init()) to set up the type system.

◆ isSame()

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

Check for equal type and value(s).

Reimplemented from SoSFEnum.

The documentation for this class was generated from the following files: