Man Linux: Main Page and Category List

NAME

       SoSFBitMask -

       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.

SYNOPSIS

       #include <Inventor/fields/SoSFBitMask.h>

       Inherits SoSFEnum.

   Public Member Functions
       virtual SoType getTypeId (void) const
       virtual void copyFrom (const SoField &field)
       const SoSFBitMask & operator= (const SoSFBitMask &field)
       virtual SbBool isSame (const SoField &field) const
       PRIVATE_SFIELD_IO_HEADER ()
       int operator= (int newvalue)

   Static Public Member Functions
       static void * createInstance (void)
       static SoType getClassTypeId (void)
       static void initClass (void)

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

   static SoType SoSFBitMask::getClassTypeId (void) [static] Returns a unique
       type identifier for this field class.
       See also:
           getTypeId(), SoType

       Reimplemented from SoSFEnum.

   virtual SoType SoSFBitMask::getTypeId (void) const [virtual] Returns the
       type identification instance which uniquely identifies the Coin field
       class the object belongs to.
       See also:
           getClassTypeId(), SoType

       Reimplemented from SoSFEnum.

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

   virtual SbBool SoSFBitMask::isSame (const SoField & f) const [virtual]
       Check for equal type and value(s).
       Reimplemented from SoSFEnum.

   void SoSFBitMask::initClass (void) [static] Internal method called upon
       initialization of the library (from SoDB::init()) to set up the type
       system.
       Reimplemented from SoSFEnum.

Author

       Generated automatically by Doxygen for Coin from the source code.