1SoXtFullViewer(3IV)()                                    SoXtFullViewer(3IV)()
2
3
4

NAME

6       SoXtFullViewer  —  base viewer class which adds a decoration around the
7       rendering area
8

INHERITS FROM

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

SYNOPSIS

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

DESCRIPTION

179       This is a base class used by all viewer components. The  class  adds  a
180       decoration  around  the  rendering  area which includes thumb wheels, a
181       zoom slider and push buttons. This base class also  includes  a  viewer
182       popup  menu  and a preference sheet with generic viewing functions. The
183       constructors for the various subclasses  of  SoXtFullViewer  provide  a
184       flag  for  specifying  whether the decoration and popup menus should be
185       built.
186

METHODS

188     void                setDecoration(SbBool onOrOff)
189     SbBool              isDecoration()
190          Show/hide the viewer component trim (default  on).  See  the  viewer
191          constructor to prevent the decoration from being built.
192
193     void                setPopupMenuEnabled(SbBool trueOrFalse)
194     SbBool              isPopupMenuEnabled()
195          Enable/disable  the  viewer  popup  menu  (default enabled). See the
196          viewer constructor to prevent the popup menu from being built.
197
198     Widget              getAppPushButtonParent() const
199          Returns the parent widget, which is needed when  creating  new  but‐
200          tons.  Note:  that if the decoration is not created in the construc‐
201          tor, this will be NULL until the decoration is shown.
202
203     void                addAppPushButton(Widget newButton)
204     void                insertAppPushButton(Widget newButton, int index)
205     void                removeAppPushButton(Widget oldButton)
206     int                 findAppPushButton(Widget oldButton)
207     int                 lengthAppPushButton()
208          Add/remove push buttons for the application, which will be placed in
209          the  left  hand side decoration trim. Adding buttons appends them to
210          the end of the list, while inserting them places them at the desired
211          index.
212
213          Note:  the  button  pixmaps should be 24-by-24 pixels size to nicely
214          fit into the decoration trim like the other viewer buttons.
215
216     Widget              getRenderAreaWidget()
217          Returns the render area widget.
218
219

SEE ALSO

221       SoXtViewer,    SoXtComponent,    SoXtRenderArea,    SoXtExaminerViewer,
222       SoXtWalkViewer, SoXtFlyViewer, SoXtPlaneViewer
223
224
225
226
227                                                         SoXtFullViewer(3IV)()
Impressum