logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

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

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.

Inherits From

       SoField > SoSField > SoSFEnum > SoSFBitMask

Methods

staticSoTypegetClassTypeId()virtualvoidgetTypeId()const
          Returns the type for this class or a particular object of this class.

     intgetValue()const
          Returns this field's value.

     voidsetValue(intnewValue)intoperator=(intnewValue)
          Sets this field to newValue.

     intoperator==(constSoSFBitMask&f)constintoperator!=(constSoSFBitMask&f)const
          Returns TRUE if f is of the same type and has the same value as this field.

Name

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

See Also

SoField,SoSField,SoMFBitMaskSoSFBitMask(3IV)()

Synopsis

#include<Inventor/fields/SoSFBitMask.h>

          Methods from class SoSFBitMask:

     staticSoTypegetClassTypeId()virtualvoidgetTypeId()constintgetValue()constvoidsetValue(intnewValue)intoperator=(intnewValue)intoperator==(constSoSFBitMask&f)constintoperator!=(constSoSFBitMask&f)const

          Methods from class SoField:

     voidsetIgnored(SbBoolignore)SbBoolisIgnored()constSbBoolisDefault()constvirtualSbBoolisOfType(SoTypetype)constSbBoolset(constchar*valueString)voidget(SbString&valueString)voidtouch()SbBoolconnectFrom(SoField*fromField)SbBoolconnectFrom(SoEngineOutput*fromEngine)voiddisconnect()SbBoolisConnected()constSbBoolisConnectedFromField()constSbBoolgetConnectedField(SoField*&writingField)constSbBoolisConnectedFromEngine()constSbBoolgetConnectedEngine(SoEngineOutput*&engineOutput)constvoidenableConnection(SbBoolflag)SbBoolisConnectionEnabled()constintgetForwardConnections(SoFieldList&list)constSoFieldContainer*getContainer()const

See Also