SoShuttle(3iv)

1SoShuttle(3IV)()                                              SoShuttle(3IV)()
2
3
4

NAME

6       SoShuttle — animated oscillating translation node
7

INHERITS FROM

9       SoBase > SoFieldContainer > SoNode > SoTransformation > SoTranslation >
10       SoShuttle
11

SYNOPSIS

13       #include <Inventor/nodes/SoShuttle.h>
14
15          Fields from class SoShuttle:
16
17     SoSFVec3f           translation0
18     SoSFVec3f           translation1
19     SoSFFloat           speed
20     SoSFBool            on
21
22          Fields from class SoTranslation:
23
24     SoSFVec3f           translation
25
26          Methods from class SoShuttle:
27
28                         SoShuttle()
29     static SoType       getClassTypeId()
30
31          Methods from class SoNode:
32
33     void                setOverride(SbBool state)
34     SbBool              isOverride() const
35     SoNode *            copy(SbBool copyConnections = FALSE) const
36     virtual SbBool      affectsState() const
37     static SoNode *     getByName(const SbName &name)
38     static int          getByName(const SbName &name, SoNodeList &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       The SoShuttle class is derived from  SoTranslation,  so  it  applies  a
70       translation  to  the current transformation. Using engines connected to
71       the realTime global field, the translation value is animated over  time
72       between  two  fixed  translations,  achieving  a  shuttling effect. The
73       period of the motion can be adjusted by changing the speed  field.  The
74       current  translation at any time is available in the translation field,
75       inherited from SoTranslation
76

FIELDS

78     SoSFVec3f           translation0
79     SoSFVec3f           translation1
80          These define the two fixed translations  that  are  interpolated  to
81          create the shuttling motion.
82
83     SoSFFloat           speed
84          Defines the speed of the shuttle, in cycles per second.
85
86     SoSFBool            on
87          Allows applications to enable or disable the motion easily.
88
89

METHODS

91                         SoShuttle()
92          Creates a shuttle node with default settings.
93
94     static SoType       getClassTypeId()
95          Returns type identifier for this class.
96
97

ACTION BEHAVIOR

99       SoGLRenderAction,  SoCallbackAction, SoGetBoundingBoxAction, SoRayPick‐
100       Action
101          Concatenates interpolated translation value with the current  trans‐
102          formation matrix.
103
104     SoGetMatrixAction
105          Returns transformation matrix specified by the interpolated transla‐
106          tion.
107
108

FILE FORMAT/DEFAULTS

110       Shuttle {
111          translation   0 0 0
112          translation0  0 0 0
113          translation1  0 0 0
114          speed         1
115          on            TRUE
116     }
117