1SoXtPlaneViewer(3IV)()                                  SoXtPlaneViewer(3IV)()
2
3
4

NAME

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

INHERITS FROM

9       SoXtComponent  >  SoXtGLWidget > SoXtRenderArea > SoXtViewer > SoXtFul‐
10       lViewer > SoXtPlaneViewer
11

SYNOPSIS

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

DESCRIPTION

178       The Plane viewer component allows the user to translate the  camera  in
179       the  viewing plane, as well as dolly (move foward/backward) and zoom in
180       and out. The viewer also allows the user to  roll  the  camera  (rotate
181       around  the forward direction) and seek to objects which will specify a
182       new viewing plane. This viewer could be used for modeling, in drafting,
183       and  architectural  work.  The  camera  can be aligned to the X, Y or Z
184       axes.
185

METHODS

187                         SoXtPlaneViewer(Widget  parent  =  NULL,  const  char
188                              *name  =  NULL, SbBool buildInsideParent = TRUE,
189                              SoXtFullViewer::BuildFlag  flag   =   BUILD_ALL,
190                              SoXtViewer::Type type = BROWSER)
191                         ~SoXtPlaneViewer()
192          Constructor  and  destructor which specifies the viewer type. Please
193          refer to the SoXtViewer man pages for a description  of  the  viewer
194          types.
195
196

RESOURCES

198          *SoXtPlaneViewer.decoration: on (on | off)
199          *SoXtPlaneViewer.seekAnimationTime: 2.0 (float)
200          *SoXtPlaneViewer.seekTo: point (point | object)
201          *SoXtPlaneViewer.seekDistanceUsage: percentage (percentage | absolute)
202          *SoXtPlaneViewer.zoomMin: 1.0 (float)
203          *SoXtPlaneViewer.zoomMax: 179.0 (float)
204          *SoXtPlaneViewer.autoClipping: on (on | off)
205          *SoXtPlaneViewer.nearDistance: 2.4 (float, when autoClipping is off)
206          *SoXtPlaneViewer.farDistance: 2.8 (float, when autoClipping is off)
207          *SoXtPlaneViewer*BackgroundColor: black (color name or hex value)
208
209
210

USAGE

212          Left Mouse:
213          Left + Middle Mouse: Dolly in and out (gets closer to and further
214          away from the object).
215
216
217
218          Middle Mouse:
219          Ctrl + Left Mouse: Translate up, down, left and right.
220
221
222
223          Ctrl + Middle Mouse: Used for roll action (rotates around the viewer
224          forward direction).
225
226
227
228          <s> + click: Alternative to the Seek button. Press (but do not
229          hold down) the <s> key, then click on a target object.
230
231
232
233          Right Mouse: Open the popup menu.
234
235
236

SEE ALSO

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