1SoSFBitMask(3IV)()                                          SoSFBitMask(3IV)()
2
3
4

NAME

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

INHERITS FROM

9       SoField > SoSField > SoSFEnum > SoSFBitMask
10

SYNOPSIS

12       #include <Inventor/fields/SoSFBitMask.h>
13
14          Methods from class SoSFBitMask:
15
16     static SoType       getClassTypeId()
17     virtual void        getTypeId() const
18     int                 getValue() const
19     void                setValue(int newValue)
20     int                 operator =(int newValue)
21     int                 operator ==(const SoSFBitMask &f) const
22     int                 operator !=(const SoSFBitMask &f) const
23
24          Methods from class SoField:
25
26     void                setIgnored(SbBool ignore)
27     SbBool              isIgnored() const
28     SbBool              isDefault() const
29     virtual SbBool      isOfType(SoType type) const
30     SbBool              set(const char *valueString)
31     void                get(SbString &valueString)
32     void                touch()
33     SbBool              connectFrom(SoField *fromField)
34     SbBool              connectFrom(SoEngineOutput *fromEngine)
35     void                disconnect()
36     SbBool              isConnected() const
37     SbBool              isConnectedFromField() const
38     SbBool              getConnectedField(SoField *&writingField) const
39     SbBool              isConnectedFromEngine() const
40     SbBool              getConnectedEngine(SoEngineOutput     *&engineOutput)
41                              const
42     void                enableConnection(SbBool flag)
43     SbBool              isConnectionEnabled() const
44     int                 getForwardConnections(SoFieldList &list) const
45     SoFieldContainer *  getContainer() const
46
47

DESCRIPTION

49       A single-value field that contains a mask of bit flags,  stored  as  an
50       integer.  Nodes that use this field class define mnemonic names for the
51       bit flags. These names should be used when setting or testing the  val‐
52       ues of the field, even though the values are treated as integers in the
53       methods.
54
55       The bit-wise "&" and "|" operators should be used when testing and set‐
56       ting  flags  in  a mask. For example, to turn on the sides of a 3D text
57       node and turn off the back you would write:
58
59          text3->parts = text3->parts.getValue() | SoText3::SIDES;
60          text3->parts = text3->parts.getValue() & ~SoText3::BACK;
61
62       SoSFBitMasks are written to file as one  or  more  mnemonic  enumerated
63     type names, in this format:
64
65          ( flag1 | flag2 | ... )
66
67     If  only  one flag is used in a mask, the parentheses are optional. These
68     names differ among uses of this field in various node or engine  classes.
69     See their man pages for the names.
70
71     The  field  values  may  also be represented as integers, but this is not
72     guaranteed to be portable.
73

METHODS

75     static SoType       getClassTypeId()
76     virtual void        getTypeId() const
77          Returns the type for this class  or  a  particular  object  of  this
78          class.
79
80     int                 getValue() const
81          Returns this field's value.
82
83     void                setValue(int newValue)
84     int                 operator =(int newValue)
85          Sets this field to newValue.
86
87     int                 operator ==(const SoSFBitMask &f) const
88     int                 operator !=(const SoSFBitMask &f) const
89          Returns TRUE if f is of the same type and has the same value as this
90          field.
91
92

SEE ALSO

94       SoField, SoSField, SoMFBitMask
95
96
97
98
99                                                            SoSFBitMask(3IV)()
Impressum