SoSFBitMask(3IV)NAMESoSFBitMask (SoSBitMask) - single-value field containing a set of bit
flags
INHERITS FROM
SoField > SoSField > SoSFEnum > SoSFBitMaskSYNOPSIS
#include <Inventor_c/fields/SoSFBitMask.h>
typedef SoSFBitMask SoSBitMask
Functions from class SoSFBitMask:
SoType SoSBitMaskGetClassTypeId()
void SoSBitMaskGetTypeId(const SoSBitMask *this)
int SoSBitMaskGet(const SoSBitMask *this)
void SoSBitMaskSet(SoSBitMask *this, int newValue)
int SoSBitMaskIsEq(const SoSBitMask *this, const
SoSFBitMask *f)
int SoSBitMaskIsNEq(const SoSBitMask *this, const
SoSFBitMask *f)
Functions from class SoSFEnum:
void SoSBitMaskSetStr(SoSBitMask *this, const char *name)
Functions from class SoField:
void SoSBitMaskSetIgnored(SoSBitMask *this, SbBool ignore)
SbBool SoSBitMaskIsIgnored(const SoSBitMask *this)
SbBool SoSBitMaskIsDflt(const SoSBitMask *this)
SbBool SoSBitMaskIsOfType(const SoSBitMask *this, SoType
type)
SbBool SoSBitMaskSetFromStr(SoSBitMask *this, const char
*valueString)
void SoSBitMaskGetIntoStr(SoSBitMask *this, SbString
*valueString)
void SoSBitMaskTouch(SoSBitMask *this)
SbBool SoSBitMaskConnFromField(SoSBitMask *this, SoField
*fromField)
SbBool SoSBitMaskConnFrom(SoSBitMask *this, SoEngineOutput
*fromEngine)
void SoSBitMaskDisconn(SoSBitMask *this)
SbBool SoSBitMaskIsConn(const SoSBitMask *this)
SbBool SoSBitMaskIsConnFromField(const SoSBitMask *this)
SbBool SoSBitMaskGetConnField(const SoSBitMask *this,
SoField **writingField)
SbBool SoSBitMaskIsConnFromEngine(const SoSBitMask *this)
SbBool SoSBitMaskGetConnEngine(const SoSBitMask *this,
SoEngineOutput **engineOutput)
Page 1SoSFBitMask(3IV)
void SoSBitMaskEnableConn(SoSBitMask *this, SbBool flag)
SbBool SoSBitMaskIsConnEnabled(const SoSBitMask *this)
int SoSBitMaskGetForwardConn(const SoSBitMask *this,
SoFieldList *list)
SoFieldContainer * SoSBitMaskGetContainer(const SoSBitMask *this)
DESCRIPTION
A single-value field that contains a mask of bit flags, stored as an
integer. Nodes that use this field class define mnemonic names for the
bit flags. These names should be used when setting or testing the values
of the field, even though the values are treated as integers in the
methods.
The bit-wise "&" and "|" operators should be used when testing and
setting flags in a mask. For example, to turn on the sides of a 3D text
node and turn off the back you would write:
SoSBitMaskSetValue(text3->parts,
SoSBitMaskGetValue(text3->parts) | SO_TXT3_SIDES);
SoSBitMaskSetValue(text3->parts,
SoSBitMaskGetValue(text3->parts) & ~SO_TXT3_BACK);
SoSFBitMasks are written to file as one or more mnemonic enumerated type
names, in this format:
( flag1 | flag2 | ... )
If only one flag is used in a mask, the parentheses are optional. These
names differ among uses of this field in various node or engine classes.
See their man pages for the names.
The field values may also be represented as integers, but this is not
guaranteed to be portable.
FUNCTIONS
SoType SoSBitMaskGetClassTypeId()
void SoSBitMaskGetTypeId(const SoSBitMask *this)
Returns the type for this class or a particular object of this
class.
int SoSBitMaskGet(const SoSBitMask *this)
Returns this field's value.
void SoSBitMaskSet(SoSBitMask *this, int newValue)
int SoSBitMaskIsEq(const SoSBitMask *this, const
SoSFBitMask *f)
int SoSBitMaskIsNEq(const SoSBitMask *this, const
SoSFBitMask *f)
Returns TRUE if f is of the same type and has the same value as this
field.
Page 2SoSFBitMask(3IV)SEE ALSO
SoField, SoSField, SoMFBitMask
Page 3
