SoTranslate1Dragger(3iv)

1SoTranslate1Dragger(3IV)()                          SoTranslate1Dragger(3IV)()
2
3
4

NAME

6       SoTranslate1Dragger — object you can translate along a line by dragging
7       With the mouse
8

INHERITS FROM

10       SoBase > SoFieldContainer > SoNode >  SoBaseKit  >  SoInteractionKit  >
11       SoDragger > SoTranslate1Dragger
12

SYNOPSIS

14       #include <Inventor/draggers/SoTranslate1Dragger.h>
15
16          Fields from class SoTranslate1Dragger:
17
18     SoSFVec3f           translation
19
20          Fields from class SoDragger:
21
22     SoSFBool            isActive
23
24          Fields from class SoInteractionKit:
25
26     SoSFEnum            renderCaching
27     SoSFEnum            boundingBoxCaching
28     SoSFEnum            renderCulling
29     SoSFEnum            pickCulling
30
31          Parts from class SoBaseKit:
32
33     (SoNodeKitListPart)  callbackList
34
35          Methods from class SoTranslate1Dragger:
36
37                         SoTranslate1Dragger()
38     static const SoNodekitCatalog *
39                         getClassNodekitCatalog() const
40     static SoType       getClassTypeId()
41
42          Methods from class SoDragger:
43
44     void                addStartCallback(SoDraggerCB  *f,  void  *userData  =
45                              NULL)
46     void                removeStartCallback(SoDraggerCB *f, void *userData  =
47                              NULL)
48     void                addMotionCallback(SoDraggerCB  *f,  void  *userData =
49                              NULL)
50     void                removeMotionCallback(SoDraggerCB *f, void *userData =
51                              NULL)
52     void                addFinishCallback(SoDraggerCB  *f,  void  *userData =
53                              NULL)
54     void                removeFinishCallback(SoDraggerCB *f, void *userData =
55                              NULL)
56     void                addValueChangedCallback(SoDraggerCB  *f,  void *user‐
57                              Data = NULL)
58     void                removeValueChangedCallback(SoDraggerCB    *f,    void
59                              *userData = NULL)
60     SbBool              enableValueChangedCallbacks()
61     void                setMinGesture(int pixels)
62     int                 getMinGesture() const
63     static void         setMinScale(float newMinScale)
64     static float        getMinScale()
65
66          Methods from class SoInteractionKit:
67
68     virtual  SbBool      setPartAsPath(const SbName &partName, SoPath *surro‐
69                              gatePath )
70
71          Methods from class SoBaseKit:
72
73     virtual const SoNodekitCatalog *
74                              getNodekitCatalog() const
75     virtual   SoNode   *         getPart(const   SbName   &partName,   SbBool
76                                   makeIfNeeded)
77     SbString                 getPartString(const SoBase *part)
78     virtual  SoNodeKitPath *  createPathToPart(const SbName &partName, SbBool
79                                   makeIfNeeded, const SoPath *pathToExtend  =
80                                   NULL)
81     virtual SbBool           setPart(const SbName &partName, SoNode *newPart)
82     SbBool                   set(char *partName, char *parameters)
83     SbBool                   set(char *nameValuePairs)
84     static SbBool            isSearchingChildren()
85     static void              setSearchingChildren(SbBool newVal)
86
87          Methods from class SoNode:
88
89     void                setOverride(SbBool state)
90     SbBool              isOverride() const
91     SoNode *            copy(SbBool copyConnections = FALSE) const
92     virtual SbBool      affectsState() const
93     static SoNode *     getByName(const SbName &name)
94     static int          getByName(const SbName &name, SoNodeList &list)
95
96          Methods from class SoFieldContainer:
97
98     void                setToDefaults()
99     SbBool              hasDefaultValues() const
100     SbBool              fieldsAreEqual(const SoFieldContainer *fc) const
101     void                copyFieldValues(const  SoFieldContainer  *fc,  SbBool
102                              copyConnections = FALSE)
103     void                get(SbString &fieldDataString)
104     virtual int         getFields(SoFieldList &resultList) const
105     virtual SoField *   getField(const SbName &fieldName) const
106     SbBool              getFieldName(const SoField *field, SbName &fieldName)
107                              const
108     SbBool              isNotifyEnabled() const
109     SbBool              enableNotify(SbBool flag)
110
111          Methods from class SoBase:
112
113     void                ref()
114     void                unref() const
115     void                unrefNoDelete() const
116     void                touch()
117     virtual SoType      getTypeId() const
118     SbBool              isOfType(SoType type) const
119     virtual void        setName(const SbName &name)
120     virtual SbName      getName() const
121
122          Macros from class SoBaseKit:
123
124     SO_GET_PART(kit, partName, partClass)
125     SO_CHECK_PART(kit, partName, partClass)
126
127

DESCRIPTION

129       SoTranslate1Dragger  is  a simple dragger that translates in one dimen‐
130       sion when dragged with the mouse. It moves along  the  x  axis  of  its
131       local space, determined by its location in the scene graph. Transforma‐
132       tion nodes placed before it will affect both the dragger and the direc‐
133       tion of motion.
134
135       This node has a translation field which always reflects its position in
136       local space. If you set the field, the dragger will  move  accordingly.
137       You  can also connect fields of other nodes or engines from this one to
138       make them follow the dragger's motion.
139
140       This dragger contains four parts, translator,  translatorActive,  feed‐
141       back, and feedbackActive.
142
143       Each  of these is set by default from a resource described in the Drag‐
144       ger Resources section of the online reference page for this class.  You
145       can change the parts in any instance of this dragger using setPart().
146
147       You can make your program use different default resources for the parts
148       by  copying  the  file  /usr/share/data/draggerDefaults/translate1Drag‐
149       ger.iv  into your own directory, editing the file, and then setting the
150       environment variable SO_DRAGGER_DIR to be a path to that directory.
151

FIELDS

153     SoSFVec3f           translation
154          Position of the dragger.
155
156

METHODS

158                         SoTranslate1Dragger()
159          Constructor.
160
161     static const SoNodekitCatalog *
162                         getClassNodekitCatalog() const
163          Returns an SoNodekitCatalog for this class
164
165     static SoType       getClassTypeId()
166          Returns type identifier for this class.
167
168

CATALOG PARTS

170       ┌────────────────────────────────────────────────────────────┐
171       │                         All parts                          │
172       │                                                    NULL by │
173       │Part Name          Part Type         Default Type   Default │
174       │                                                            │
175       │callbackList       NodeKitListPart   --               yes   │
176       │translator         Separator         --               yes   │
177       │translatorActive   Separator         --               yes   │
178       │feedback           Separator         --               yes   │
179       │feedbackActive     Separator         --               yes   │
180       │                                                            │
181       └────────────────────────────────────────────────────────────┘
182       ┌───────────────────────────────────────────────────────────────┐
183       │      Extra information for list parts from above table        │
184       │                                                               │
185       │Part Name      Container Type   Permissible Types              │
186       │                                                               │
187       │callbackList   Separator        Callback, EventCallback        │
188       │                                                               │
189       └───────────────────────────────────────────────────────────────┘

DRAGGER RESOURCES

191       .in 0n+.5i
192     Resource:         translate1Translator
193       .in 0n+.5i
194     Part:             translator
195     Appearance:       white arrow
196     Description:      picking this initiates translation
197
198                         .in 0n+.5i
199     Resource:         translate1TranslatorActive
200                         .in 0n+.5i
201     Part:             translatorActive
202     Appearance:       yellow arrow
203     Description:      displayed during translation instead of the translator
204
205                         .in 0n+.5i
206     Resource:         translate1Feedback
207                         .in 0n+.5i
208     Part:             feedback
209     Appearance:       empty Separator by default
210     Description:      feedback displayed when not in motion
211
212                         .in 0n+.5i
213     Resource:         translate1FeedbackActive
214                         .in 0n+.5i
215     Part:             feedbackActive
216     Appearance:       empty Separator by default
217     Description:      feedback displayed while moving
218
219

FILE FORMAT/DEFAULTS

221       Translate1Dragger {
222          renderCaching       AUTO
223          boundingBoxCaching  AUTO
224          renderCulling       AUTO
225          pickCulling         AUTO
226          isActive            FALSE
227          translation         0 0 0
228          callbackList        NULL
229          translator          <translate1Translator resource>
230          translatorActive    <translate1TranslatorActive resource>
231          feedback            <translate1Feedback resource>
232          feedbackActive      <translate1FeedbackActive resource>
233     }
234