1SoXtExaminerViewer(3IV)()                            SoXtExaminerViewer(3IV)()
2
3
4

NAME

6       SoXtExaminerViewer — viewer component which uses a virtual trackball to
7       view the data
8

INHERITS FROM

10       SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer  >  SoXtFul‐
11       lViewer > SoXtExaminerViewer
12

SYNOPSIS

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

DESCRIPTION

187       The  Examiner  viewer  component allows you to rotate the view around a
188       point of interest using a virtual trackball. The viewer uses the camera
189       focalDistance  field to figure out the point of rotation, which is usu‐
190       ally set to be at the center of the scene. In addition to allowing  you
191       to  rotate  the  camera  around the point of interest, this viewer also
192       allows you to translate the camera in the  viewer  plane,  as  well  as
193       dolly (move forward and backward) to get closer to or further away from
194       the point of interest. The viewer also supports seek  to  quickly  move
195       the camera to a desired object or point.
196

METHODS

198                         SoXtExaminerViewer(Widget  parent  = NULL, const char
199                              *name = NULL, SbBool buildInsideParent  =  TRUE,
200                              SoXtFullViewer::BuildFlag   flag   =  BUILD_ALL,
201                              SoXtViewer::Type type = BROWSER)
202                         ~SoXtExaminerViewer()
203          Constructor and destructor which specifies the viewer  type.  Please
204          refer  to  the  SoXtViewer  reference  page for a description of the
205          viewer types.
206
207     void                setFeedbackVisibility(SbBool onOrOff)
208     SbBool              isFeedbackVisible() const
209          Show/Hide the point of rotation feedback, which only  appears  while
210          in viewing mode (default in off).
211
212     void                setFeedbackSize(int newSize)
213     int                 getFeedbackSize() const
214          Set/get  the  point  of rotation feedback size in pixels (default 20
215          pix).
216
217     void                setAnimationEnabled(SbBool onOrOff)
218     SbBool              isAnimationEnabled()
219          Enable/disable the spinning animation feature of the viewer (enabled
220          by default).
221
222     void                stopAnimating()
223     SbBool              isAnimating()
224          Stop  animation, if it is occurring, and query if the viewer is cur‐
225          rently animating.
226
227

RESOURCES

229          *SoXtExaminerViewer.spinAnimation: on (on | off)
230          *SoXtExaminerViewer.pointOfRotationAxes: off (on | off)
231          *SoXtExaminerViewer.axesSize: 20 (short, pixels if axes is on)
232          *SoXtExaminerViewer.decoration: on (on | off)
233          *SoXtExaminerViewer.seekAnimationTime: 2.0 (float)
234          *SoXtExaminerViewer.seekTo: point (point | object)
235          *SoXtExaminerViewer.seekDistanceUsage: percentage (percentage | absolute)
236          *SoXtExaminerViewer.zoomMin: 1.0 (float)
237          *SoXtExaminerViewer.zoomMax: 179.0 (float)
238          *SoXtExaminerViewer.autoClipping: on (on | off)
239          *SoXtExaminerViewer.nearDistance: 2.4 (float, when autoClipping is off)
240          *SoXtExaminerViewer.farDistance: 2.8 (float, when autoClipping is off)
241          *SoXtExaminerViewer*BackgroundColor: black (color name or hex value)
242
243

USAGE

245          Left Mouse: Rotate the virtual trackball.
246
247
248
249          Middle Mouse:
250          Ctrl + Left Mouse: Translate up, down, left and right.
251
252
253
254          Ctrl + Middle Mouse:
255          Left + Middle Mouse: Dolly in and out (gets closer to and further
256          away from the object).
257
258
259
260          <s> + click: Alternative to the Seek button. Press (but do not
261          hold down) the <s> key, then click on a target object.
262
263
264
265          Right Mouse: Open the popup menu.
266
267
268

SEE ALSO

270       SoXtFullViewer,     SoXtViewer,     SoXtComponent,      SoXtRenderArea,
271       SoXtWalkViewer, SoXtFlyViewer, SoXtPlaneViewer
272
273
274
275
276                                                     SoXtExaminerViewer(3IV)()
Impressum