1SoXtFlyViewer(3IV)()                                      SoXtFlyViewer(3IV)()
2
3
4

NAME

6       SoXtFlyViewer  — viewer component for flying through space, with a con‐
7       stant world up
8

INHERITS FROM

10       SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer  >  SoXtFul‐
11       lViewer > SoXtConstrainedViewer > SoXtFlyViewer
12

SYNOPSIS

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

DESCRIPTION

184       Fly  Viewer — this viewer is intended to simulate flight through space,
185       with a constant world up direction. The viewer only constrains the cam‐
186       era  to keep the user from flying upside down. No mouse buttons need to
187       be pressed in order to fly. The mouse position is used only for  steer‐
188       ing,  while  mouse  clicks  are used to increase or decrease the viewer
189       speed.
190
191       The viewer allows you to tilt your head up/down/right/left and move  in
192       the  direction  you  are looking (forward or backward). The viewer also
193       supports seek to quickly move the camera to a desired object or point.
194

METHODS

196                         SoXtFlyViewer(Widget parent = NULL, const char  *name
197                              =  NULL,  SbBool buildInsideParent = TRUE, SoXt‐
198                              FullViewer::BuildFlag    flag    =    BUILD_ALL,
199                              SoXtViewer::Type type = BROWSER)
200                         ~SoXtFlyViewer()
201          Constructor  and  destructor which specifies the viewer type. Please
202          refer to the SoXtViewer reference page  for  a  description  of  the
203          viewer types.
204
205

RESOURCES

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

USAGE

220       Left Mouse: Click to increase speed.
221
222       <s>  +  Left  Mouse:  Alternative to the Seek button. Press (but do not
223       hold down) the <s> key, then click on a target object.
224
225       <u> + Left Mouse: Press (but do not hold down) the <u> key, then  click
226       on  a target object to set the "up" direction to the surface normal. By
227       default +y is the "up" direction.
228
229       Middle Mouse: Click to decrease speed.
230
231       Left and Middle Mouse: Click boths simultaneously to stop.
232
233       Ctrl: Hold the key down to temporary stop and rotate the viewpoint.
234
235       Right Mouse: Open the popup menu.
236

SEE ALSO

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