man SoSFBitMask () - single-value field containing a set of bit flags

NAME

SoSFBitMask - single-value field containing a set of bit flags

INHERITS FROM

SoField > SoSField > SoSFEnum > SoSFBitMask

SYNOPSIS

#include <Inventor/fields/SoSFBitMask.h> Methods from class SoSFBitMask: c } c } getClassTypeId()

c } c } getTypeId() const

c } c } getValue() const

c } c } setValue(int newValue)

c } c } operator =(int newValue)

c } c } operator ==(const SoSFBitMask &f) const

c } c } operator !=(const SoSFBitMask &f) const Methods from class SoField: c } c } setIgnored(SbBool ignore)

c } c } isIgnored() const

c } c } isDefault() const

c } c } isOfType(SoType type) const

c } c } set(const char *valueString)

c } c } get(SbString &valueString)

c } c } touch()

c } c } connectFrom(SoField *fromField)

c } c } connectFrom(SoEngineOutput *fromEngine)

c } c } disconnect()

c } c } isConnected() const

c } c } isConnectedFromField() const

c } c } getConnectedField(SoField *&writingField) const

c } c } isConnectedFromEngine() const

c } c } getConnectedEngine(SoEngineOutput *&engineOutput) const

c } c } enableConnection(SbBool flag)

c } c } isConnectionEnabled() const

c } c } getForwardConnections(SoFieldList &list) const

c } c } getContainer() const

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:

text3->parts = text3->parts.getValue() | SoText3::SIDES; text3->parts = text3->parts.getValue() & ~SoText3::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.

METHODS

c } c } getClassTypeId()

c } c } getTypeId() const

Returns the type for this class or a particular object of this class. c } c } getValue() const

Returns this field's value. c } c } setValue(int newValue)

c } c } operator =(int newValue)

Sets this field to newValue. c } c } operator ==(const SoSFBitMask &f) const

c } c } operator !=(const SoSFBitMask &f) const

Returns TRUE if f is of the same type and has the same value as this field.

SEE ALSO

SoField, SoSField, SoMFBitMask