GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SOSFBITMASK (3)

NAME

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

CONTENTS

Inherits From
Synopsis
Description
Methods
See Also

INHERITS FROM

SoField > SoSField > SoSFEnum > SoSFBitMask

SYNOPSIS

#include <Inventor/fields/SoSFBitMask.h>

Methods from class SoSFBitMask:

    static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const    
int    
                    
int                  getValue() const    
void    
                    
void                 setValue(int newValue)    
int    
                    
int                  operator =(int newValue)    
int    
                    
int                  operator ==(const SoSFBitMask &f) const    
int    
                    
int                  operator !=(const SoSFBitMask &f) const

Methods from class SoField:

    void    
                    
void                 setIgnored(SbBool ignore)    
SbBool    
                    
SbBool               isIgnored() const    
SbBool    
                    
SbBool               isDefault() const    
virtual SbBool    
                    
virtual SbBool       isOfType(SoType type) const    
SbBool    
                    
SbBool               set(const char *valueString)    
void    
                    
void                 get(SbString &valueString)    
void    
                    
void                 touch()    
SbBool    
                    
SbBool               connectFrom(SoField *fromField)    
SbBool    
                    
SbBool               connectFrom(SoEngineOutput *fromEngine)    
void    
                    
void                 disconnect()    
SbBool    
                    
SbBool               isConnected() const    
SbBool    
                    
SbBool               isConnectedFromField() const    
SbBool    
                    
SbBool               getConnectedField(SoField *&writingField) const    
SbBool    
                    
SbBool               isConnectedFromEngine() const    
SbBool    
                    
SbBool               getConnectedEngine(SoEngineOutput *&engineOutput) const    
void    
                    
void                 enableConnection(SbBool flag)    
SbBool    
                    
SbBool               isConnectionEnabled() const    
int    
                    
int                  getForwardConnections(SoFieldList &list) const    
SoFieldContainer *    
                    
SoFieldContainer *   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

    static SoType    
                    
static SoType        getClassTypeId()    
virtual void    
                    
virtual void         getTypeId() const
Returns the type for this class or a particular object of this class.

    int    
                    
int                  getValue() const
Returns this field’s value.

    void    
                    
void                 setValue(int newValue)    
int    
                    
int                  operator =(int newValue)
Sets this field to newValue.

    int    
                    
int                  operator ==(const SoSFBitMask &f) const    
int    
                    
int                  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

Search for    or go to Top of page |  Section 3 |  Main Index


SOSFBITMASK(3IV) (-->)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.