SoSFBitMask Class Reference
[Fields]
Single-value field containing a set of bit flags. More...
#include <Inventor/fields/SoSFBitMask.h>
Public Member Functions | |
| virtual SoType | getTypeId () const |
| const SoSFBitMask & | operator= (const SoSFBitMask &f) |
| SoSFBitMask () | |
| virtual | ~SoSFBitMask () |
| int | operator= (int newValue) |
Static Public Member Functions | |
| static SoType | getClassTypeId () |
Detailed Description
Single-value field containing a set of bit flags.
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:
// Add sides to the set of parts rendered text3->parts = text3->parts.getValue() | SoText3::SIDES; // Remove sides from the set of parts rendered text3->parts = text3->parts.getValue() & ~SoText3::SIDES;
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 reference pages for the names.
The field values may also be represented as integers, but this is not guaranteed to be portable.
SEE ALSO
SoField, SoSField, SoMFBitMask
Constructor & Destructor Documentation
| SoSFBitMask::SoSFBitMask | ( | ) |
Default constructor.
| virtual SoSFBitMask::~SoSFBitMask | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| static SoType SoSFBitMask::getClassTypeId | ( | ) | [static] |
Returns the type identifier for this class.
Reimplemented from SoSFEnum.
| virtual SoType SoSFBitMask::getTypeId | ( | ) | const [virtual] |
Returns the type identifier for this specific instance.
Reimplemented from SoSFEnum.
| int SoSFBitMask::operator= | ( | int | newValue | ) | [inline] |
Sets this field to newValue.
Reimplemented from SoSFEnum.
| const SoSFBitMask& SoSFBitMask::operator= | ( | const SoSFBitMask & | f | ) |
Copy from another field of same type.
Reimplemented from SoSFEnum.
The documentation for this class was generated from the following file:
- Inventor/fields/SoSFBitMask.h