1SoXtWalkViewer(3IV)()                                    SoXtWalkViewer(3IV)()
2
3
4

NAME

6       SoXtWalkViewer — viewer component which moves the camera in a plane
7

INHERITS FROM

9       SoXtComponent  >  SoXtGLWidget > SoXtRenderArea > SoXtViewer > SoXtFul‐
10       lViewer > SoXtConstrainedViewer > SoXtWalkViewer
11

SYNOPSIS

13       #include <Inventor/Xt/viewers/SoXtWalkViewer.h>
14
15          Methods from class SoXtWalkViewer:
16
17                         SoXtWalkViewer(Widget parent = NULL, const char *name
18                              =  NULL,  SbBool buildInsideParent = TRUE, SoXt‐
19                              FullViewer::BuildFlag    flag    =    BUILD_ALL,
20                              SoXtViewer::Type type = BROWSER)
21                         ~SoXtWalkViewer()
22
23          Methods from class SoXtConstrainedViewer:
24
25     void                setUpDirection(const SbVec3f &newUpDirection)
26     SbVec3f             getUpDirection()
27
28          Methods from class SoXtFullViewer:
29
30     void                setDecoration(SbBool onOrOff)
31     SbBool              isDecoration()
32     void                setPopupMenuEnabled(SbBool trueOrFalse)
33     SbBool              isPopupMenuEnabled()
34     Widget              getAppPushButtonParent() const
35     void                addAppPushButton(Widget newButton)
36     void                insertAppPushButton(Widget newButton, int index)
37     void                removeAppPushButton(Widget oldButton)
38     int                 findAppPushButton(Widget oldButton)
39     int                 lengthAppPushButton()
40     Widget              getRenderAreaWidget()
41
42          Methods from class SoXtViewer:
43
44     virtual void            setCamera(SoCamera *cam)
45     SoCamera *              getCamera()
46     virtual void            setCameraType(SoType type)
47     SoType                  getCameraType()
48     virtual void            viewAll()
49     virtual void            saveHomePosition()
50     virtual void            resetToHomePosition()
51     virtual void            setHeadlight(SbBool onOrOff)
52     SbBool                  isHeadlight()
53     SoDirectionalLight *    getHeadlight()
54     virtual      void            setDrawStyle(SoXtViewer::DrawType      type,
55                                  SoXtViewer::DrawStyle style)
56     SoXtViewer::DrawStyle   getDrawStyle(SoXtViewer::DrawType type)
57     virtual void            setBufferingType(SoXtViewer::BufferType type)
58     SoXtViewer::BufferType  getBufferingType()
59     virtual void            setViewing(SbBool onOrOff)
60     SbBool                  isViewing() const
61     virtual void            setCursorEnabled(SbBool onOrOff)
62     SbBool                  isCursorEnabled() const
63     void                    setAutoClipping(SbBool onOrOff)
64     SbBool                  isAutoClipping() const
65     virtual void            setStereoViewing(SbBool onOrOff)
66     virtual SbBool          isStereoViewing()
67     void                    setStereoOffset(float dist)
68     float                   getStereoOffset()
69     void                    setDetailSeek(SbBool onOrOff)
70     SbBool                  isDetailSeek()
71     void                    setSeekTime(float seconds)
72     float                   getSeekTime()
73     void                    addStartCallback(SoXtViewerCB *f, void  *userData
74                                  = NULL)
75     void                    addFinishCallback(SoXtViewerCB *f, void *userData
76                                  = NULL)
77     void                    removeStartCallback(SoXtViewerCB *f, void  *user‐
78                                  Data = NULL)
79     void                    removeFinishCallback(SoXtViewerCB *f, void *user‐
80                                  Data = NULL)
81     void                    copyView(Time eventTime)
82     void                    pasteView(Time eventTime)
83     virtual void            recomputeSceneSize()
84
85          Methods from class SoXtRenderArea:
86
87     virtual void              setSceneGraph(SoNode *newScene)
88     virtual SoNode *          getSceneGraph()
89     void                      setOverlaySceneGraph(SoNode *newScene)
90     SoNode *                  getOverlaySceneGraph()
91     void                      registerDevice(SoXtDevice *)
92     void                      unregisterDevice(SoXtDevice *)
93     void                      setBackgroundColor(const SbColor &c)
94     const SbColor &           getBackgroundColor() const
95     void                      setBackgroundIndex(int index)
96     int                       getBackgroundIndex() const
97     void                      setOverlayBackgroundIndex(int index)
98     int                       getOverlayBackgroundIndex() const
99     void                      setColorMap(int  startIndex,  int  num,   const
100                                    SbColor *colors)
101     void                      setOverlayColorMap(int   startIndex,  int  num,
102                                    const SbColor *colors)
103     void                      setViewportRegion(const        SbViewportRegion
104                                    &newRegion)
105     const SbViewportRegion &  getViewportRegion() const
106     void                      setTransparencyType(SoGLRenderAction::Trans‐
107                                    parencyType type)
108     SoGLRenderAction::TransparencyType
109                               getTransparencyType() const
110     void                      setAntialiasing(SbBool      smoothing,      int
111                                    numPasses)
112     void                      getAntialiasing(SbBool      &smoothing,     int
113                                    &numPasses) const
114     void                      setClearBeforeRender(SbBool trueOrFalse)
115     SbBool                    isClearBeforeRender() const
116     void                      setClearBeforeOverlayRender(SbBool trueOrFalse)
117     SbBool                    isClearBeforeOverlayRender() const
118     void                      setAutoRedraw(SbBool trueOrFalse)
119     SbBool                    isAutoRedraw() const
120     void                      setRedrawPriority(uint32_t priority)
121     uint32_t                  getRedrawPriority() const
122     static uint32_t           getDefaultRedrawPriority()
123     void                      render()
124     void                      renderOverlay()
125     void                      scheduleRedraw()
126     void                      scheduleOverlayRedraw()
127     void                      redrawOnSelectionChange(SoSelection *s)
128     void                      redrawOverlayOnSelectionChange(SoSelection *s)
129     void                      setEventCallback(SoXtRenderAreaEventCB    *fcn,
130                                    void *userData = NULL)
131     void                      setGLRenderAction(SoGLRenderAction *ra)
132     SoGLRenderAction *        getGLRenderAction() const
133     void                      setOverlayGLRenderAction(SoGLRenderAction *ra)
134     SoGLRenderAction *        getOverlayGLRenderAction() const
135     void                      setSceneManager(SoSceneManager *sm)
136     SoSceneManager *          getSceneManager() const
137     void                      setOverlaySceneManager(SoSceneManager *sm)
138     SoSceneManager *          getOverlaySceneManager() const
139
140          Methods from class SoXtGLWidget:
141
142     void                setBorder(SbBool onOrOff)
143     SbBool              isBorder() const
144     virtual void        setDoubleBuffer(SbBool onOrOff)
145     SbBool              isDoubleBuffer()
146     Window              getNormalWindow()
147     Window              getOverlayWindow()
148     GLXContext          getNormalContext()
149     GLXContext          getOverlayContext()
150     Widget              getNormalWidget()
151     Widget              getOverlayWidget()
152     virtual void        setNormalVisual(XVisualInfo *vis)
153     XVisualInfo *       getNormalVisual()
154     virtual void        setOverlayVisual(XVisualInfo *vis)
155     XVisualInfo *       getOverlayVisual()
156     void                setDrawToFrontBufferEnable(SbBool enableFlag)
157     SbBool              isDrawToFrontBufferEnable() const
158
159          Methods from class SoXtComponent:
160
161     virtual void            show()
162     virtual void            hide()
163     SbBool                  isVisible()
164     Widget                  getWidget() const
165     SbBool                  isTopLevelShell() const
166     Widget                  getShellWidget() const
167     Widget                  getParentWidget() const
168     void                    setSize(const SbVec2s &size)
169     SbVec2s                 getSize()
170     Display *               getDisplay()
171     void                    setTitle(const char *newTitle)
172     const char *            getTitle() const
173     void                    setIconTitle(const char *newIconTitle)
174     const char *            getIconTitle() const
175     void                    setWindowCloseCallback(SoXtComponentCB     *func,
176                                  void *data = NULL)
177     static SoXtComponent *  getComponent(Widget w)
178     const char *            getWidgetName() const
179     const char *            getClassName() const
180
181

DESCRIPTION

183       The paradigm for this viewer  is  a  walkthrough  of  an  architectural
184       model.  Its primary behavior is forward, backward, and left/right turn‐
185       ing motion while maintaining a constant "eye level". It is also  possi‐
186       ble  to  stop  and look around at the scene. The eye level plane can be
187       disabled, allowing the viewer to proceed in the "look at" direction, as
188       if  on  an escalator. The eye level plane can also be translated up and
189       down — similar to an elevator.
190

METHODS

192                         SoXtWalkViewer(Widget parent = NULL, const char *name
193                              =  NULL,  SbBool buildInsideParent = TRUE, SoXt‐
194                              FullViewer::BuildFlag    flag    =    BUILD_ALL,
195                              SoXtViewer::Type type = BROWSER)
196                         ~SoXtWalkViewer()
197          Constructor  and  destructor which specifies the viewer type. Please
198          refer to the SoXtViewer man pages for a description  of  the  viewer
199          types.
200
201

RESOURCES

203          *SoXtWalkViewer.decoration: on (on | off)
204          *SoXtWalkViewer.seekAnimationTime: 2.0 (float)
205          *SoXtWalkViewer.seekTo: point (point | object)
206          *SoXtWalkViewer.seekDistanceUsage: percentage (percentage | absolute)
207          *SoXtWalkViewer.zoomMin: 1.0 (float)
208          *SoXtWalkViewer.zoomMax: 179.0 (float)
209          *SoXtWalkViewer.autoClipping: on (on | off)
210          *SoXtWalkViewer.nearDistance: 2.4 (float, when autoClipping is off)
211          *SoXtWalkViewer.farDistance: 2.8 (float, when autoClipping is off)
212          *SoXtWalkViewer*BackgroundColor: black (color name or hex value)
213
214
215

USAGE

217       Left  Mouse:  walk  mode. Click down and move up/down for fowards/back‐
218       wards motion. Move right and left for turning. Speed increases exponen‐
219       tially with the distance from the mouse-down origin.
220
221       Middle Mouse - or
222
223       Ctrl + Left Mouse: Translate up, down, left and right.
224
225       Ctrl  +  Middle  Mouse:  tilt  the  camera up/down and right/left. This
226       allows you to look around while stopped.
227
228       <s> + click: Alternative to the Seek button. Press  (but  do  not  hold
229       down) the <s> key, then click on a target object.
230
231       <u>  + click: Press (but do not hold down) the <u> key, then click on a
232       target object to set the "up"  direction  to  the  surface  normal.  By
233       default +y is the "up" direction.
234
235       Right Mouse: Open the popup menu.
236

SEE ALSO

238       SoXtFullViewer,   SoXtViewer,   SoXtComponent,   SoXtRenderArea,  SoXt‐
239       PlaneViewer, SoXtExaminerViewer, SoXtFlyViewer
240
241
242
243
244                                                         SoXtWalkViewer(3IV)()
Impressum