SoGate(3iv)

1SoGate(3IV)()                                                    SoGate(3IV)()
2
3
4

NAME

6       SoGate — selectively copies its input to its output
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoEngine > SoGate
10

SYNOPSIS

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

DESCRIPTION

68       This engine selectively copies its input to its output. The type of the
69       input field can be any subclass of SoMField. The type is specified when
70       an  instance  of  the  class  is  created.  For  example,  SoGate(SoMF‐
71       Float::getClassTypeId())   creates an engine that copies floating-point
72       values.
73
74       The enable input  controls  continous  flow-through  of  values.  While
75       enable  is TRUE, the input will be copied to the output. Alternatively,
76       by touching the trigger input, you can copy a  single  value  from  the
77       input to the output.
78
79       Note  that unlike most other engine fields, input and output are point‐
80       ers. Note also that by default input does not contain any values.
81

INPUTS

83     SoSFBool            enable
84          Enable continous flow-through.
85
86     SoSFTrigger         trigger
87          Copy a single value.
88
89     <inputType>         input
90          The value that is copied to the output when the gate is open.
91
92

OUTPUTS

94     (<outputType>)      output
95          Contains a copy of the input value if the gate is open.
96
97

METHODS

99                         SoGate(SoType inputType)
100          Constructor. The argument specifies the type of the input field.
101
102

FILE FORMAT/DEFAULTS

104       Gate {
105          type     <inputType>
106          input    []
107          enable   FALSE
108          trigger
109     }
110