SoOnOff(3iv)

1SoOnOff(3IV)()                                                  SoOnOff(3IV)()
2
3
4

NAME

6       SoOnOff — engine that functions as an on/off switch
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoEngine > SoOnOff
10

SYNOPSIS

12       #include <Inventor/engines/SoOnOff.h>
13
14          Inputs from class SoOnOff:
15
16     SoSFTrigger         on
17     SoSFTrigger         off
18     SoSFTrigger         toggle
19
20          Outputs from class SoOnOff:
21
22     (SoSFBool)          isOn
23     (SoSFBool)          isOff
24
25          Methods from class SoOnOff:
26
27                         SoOnOff()
28
29          Methods from class SoEngine:
30
31     static SoType       getClassTypeId()
32     virtual int         getOutputs(SoEngineOutputList &list) const
33     SoEngineOutput *    getOutput(const SbName &outputName) const
34     SbBool              getOutputName(const  SoEngineOutput  *output,  SbName
35                              &outputName) const
36     SoEngine *          copy() const
37     static SoEngine *   getByName(const SbName &name)
38     static int          getByName(const SbName &name, SoEngineList &list)
39
40          Methods from class SoFieldContainer:
41
42     void                setToDefaults()
43     SbBool              hasDefaultValues() const
44     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
45     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
46                              copyConnections = FALSE)
47     SbBool              set(const char *fieldDataString)
48     void                get(SbString &fieldDataString)
49     virtual int         getFields(SoFieldList &resultList) const
50     virtual SoField *   getField(const SbName &fieldName) const
51     SbBool              getFieldName(const SoField *field, SbName &fieldName)
52                              const
53     SbBool              isNotifyEnabled() const
54     SbBool              enableNotify(SbBool flag)
55
56          Methods from class SoBase:
57
58     void                ref()
59     void                unref() const
60     void                unrefNoDelete() const
61     void                touch()
62     virtual SoType      getTypeId() const
63     SbBool              isOfType(SoType type) const
64     virtual void        setName(const SbName &name)
65     virtual SbName      getName() const
66
67

DESCRIPTION

69       This engine has three triggers as input and two Boolean values as  out‐
70       put.  The isOn output is a switch that can be turned on or off by trig‐
71       gering the corresponding input. You can toggle the value by  triggering
72       the  toggle  input. By default isOn is FALSE. The isOff output value is
73       the inverse of isOn
74

INPUTS

76     SoSFTrigger         on
77          Turn the isOn switch on.
78
79     SoSFTrigger         off
80          Turn the isOn switch off.
81
82     SoSFTrigger         toggle
83          Toggle the switch value.
84
85

OUTPUTS

87     (SoSFBool)          isOn
88          Switch value.
89
90     (SoSFBool)          isOff
91          The inverse of isOn.
92
93

METHODS

95                         SoOnOff()
96          Constructor.
97
98

FILE FORMAT/DEFAULTS

100       OnOff {
101          on
102          off
103          toggle
104     }
105