Open Inventor Reference
SoMFBitMask Class Reference

Multiple-value field containing any number of masks of bit flags. More...

#include <Inventor/fields/SoMFBitMask.h>

Inheritance diagram for SoMFBitMask:
SoMFEnum SoMField SoField

List of all members.

Static Public Member Functions

static void initClass ()

Protected Member Functions

virtual SbBool findEnumValue (const SbName &name, int &val)
 Looks up enum name, returns value. Returns FALSE if not found.

Detailed Description

A multiple-value field that contains any number of masks of bit flags, stored as ints. Nodes or engines 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.

SoMFBitMasks 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 the reference pages for specific nodes or engines for the names.

The field values may also be represented as integers, but this is not guaranteed to be portable.

When more than one value is present, all of the values are enclosed in square brackets and separated by commas.

Definition at line 99 of file SoMFBitMask.h.


Member Function Documentation

virtual SbBool SoMFBitMask::findEnumValue ( const SbName name,
int &  val 
) [protected, virtual]

Reimplemented from SoMFEnum.

static void SoMFBitMask::initClass ( ) [static]

Reimplemented from SoMFEnum.


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