Provided by: inventor-doc_2.1.5-10+dfsg-1_all bug

NAME

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

INHERITS FROM

       SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer > SoXtFullViewer

SYNOPSIS

       #include <Inventor/Xt/viewers/SoXtFullViewer.h>

     enum BuildFlag {
          SoXtFullViewer::BUILD_NONE   doesn't build anything extra
          SoXtFullViewer::BUILD_DECORATION
                                       build the decoration only
          SoXtFullViewer::BUILD_POPUP  build the popup menu only
          SoXtFullViewer::BUILD_ALL    build everything by default
     }

          Methods from class SoXtFullViewer:

     void                setDecoration(SbBool onOrOff)
     SbBool              isDecoration()
     void                setPopupMenuEnabled(SbBool trueOrFalse)
     SbBool              isPopupMenuEnabled()
     Widget              getAppPushButtonParent() const
     void                addAppPushButton(Widget newButton)
     void                insertAppPushButton(Widget newButton, int index)
     void                removeAppPushButton(Widget oldButton)
     int                 findAppPushButton(Widget oldButton)
     int                 lengthAppPushButton()
     Widget              getRenderAreaWidget()

          Methods from class SoXtViewer:

     virtual void            setCamera(SoCamera *cam)
     SoCamera *              getCamera()
     virtual void            setCameraType(SoType type)
     SoType                  getCameraType()
     virtual void            viewAll()
     virtual void            saveHomePosition()
     virtual void            resetToHomePosition()
     virtual void            setHeadlight(SbBool onOrOff)
     SbBool                  isHeadlight()
     SoDirectionalLight *    getHeadlight()
     virtual void            setDrawStyle(SoXtViewer::DrawType type, SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   getDrawStyle(SoXtViewer::DrawType type)
     virtual void            setBufferingType(SoXtViewer::BufferType type)
     SoXtViewer::BufferType  getBufferingType()
     virtual void            setViewing(SbBool onOrOff)
     SbBool                  isViewing() const
     virtual void            setCursorEnabled(SbBool onOrOff)
     SbBool                  isCursorEnabled() const
     void                    setAutoClipping(SbBool onOrOff)
     SbBool                  isAutoClipping() const
     virtual void            setStereoViewing(SbBool onOrOff)
     virtual SbBool          isStereoViewing()
     void                    setStereoOffset(float dist)
     float                   getStereoOffset()
     void                    setDetailSeek(SbBool onOrOff)
     SbBool                  isDetailSeek()
     void                    setSeekTime(float seconds)
     float                   getSeekTime()
     void                    addStartCallback(SoXtViewerCB *f, void *userData = NULL)
     void                    addFinishCallback(SoXtViewerCB *f, void *userData = NULL)
     void                    removeStartCallback(SoXtViewerCB *f, void *userData = NULL)
     void                    removeFinishCallback(SoXtViewerCB *f, void *userData = NULL)
     void                    copyView(Time eventTime)
     void                    pasteView(Time eventTime)
     virtual void            recomputeSceneSize()

          Methods from class SoXtRenderArea:

     virtual void              setSceneGraph(SoNode *newScene)
     virtual SoNode *          getSceneGraph()
     void                      setOverlaySceneGraph(SoNode *newScene)
     SoNode *                  getOverlaySceneGraph()
     void                      registerDevice(SoXtDevice *)
     void                      unregisterDevice(SoXtDevice *)
     void                      setBackgroundColor(const SbColor &c)
     const SbColor &           getBackgroundColor() const
     void                      setBackgroundIndex(int index)
     int                       getBackgroundIndex() const
     void                      setOverlayBackgroundIndex(int index)
     int                       getOverlayBackgroundIndex() const
     void                      setColorMap(int startIndex, int num, const SbColor *colors)
     void                      setOverlayColorMap(int startIndex, int num, const SbColor *colors)
     void                      setViewportRegion(const SbViewportRegion &newRegion)
     const SbViewportRegion &  getViewportRegion() const
     void                      setTransparencyType(SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               getTransparencyType() const
     void                      setAntialiasing(SbBool smoothing, int numPasses)
     void                      getAntialiasing(SbBool &smoothing, int &numPasses) const
     void                      setClearBeforeRender(SbBool trueOrFalse)
     SbBool                    isClearBeforeRender() const
     void                      setClearBeforeOverlayRender(SbBool trueOrFalse)
     SbBool                    isClearBeforeOverlayRender() const
     void                      setAutoRedraw(SbBool trueOrFalse)
     SbBool                    isAutoRedraw() const
     void                      setRedrawPriority(uint32_t priority)
     uint32_t                  getRedrawPriority() const
     static uint32_t           getDefaultRedrawPriority()
     void                      render()
     void                      renderOverlay()
     void                      scheduleRedraw()
     void                      scheduleOverlayRedraw()
     void                      redrawOnSelectionChange(SoSelection *s)
     void                      redrawOverlayOnSelectionChange(SoSelection *s)
     void                      setEventCallback(SoXtRenderAreaEventCB   *fcn,  void  *userData  =
                                    NULL)
     void                      setGLRenderAction(SoGLRenderAction *ra)
     SoGLRenderAction *        getGLRenderAction() const
     void                      setOverlayGLRenderAction(SoGLRenderAction *ra)
     SoGLRenderAction *        getOverlayGLRenderAction() const
     void                      setSceneManager(SoSceneManager *sm)
     SoSceneManager *          getSceneManager() const
     void                      setOverlaySceneManager(SoSceneManager *sm)
     SoSceneManager *          getOverlaySceneManager() const

          Methods from class SoXtGLWidget:

     void                setBorder(SbBool onOrOff)
     SbBool              isBorder() const
     virtual void        setDoubleBuffer(SbBool onOrOff)
     SbBool              isDoubleBuffer()
     Window              getNormalWindow()
     Window              getOverlayWindow()
     GLXContext          getNormalContext()
     GLXContext          getOverlayContext()
     Widget              getNormalWidget()
     Widget              getOverlayWidget()
     virtual void        setNormalVisual(XVisualInfo *vis)
     XVisualInfo *       getNormalVisual()
     virtual void        setOverlayVisual(XVisualInfo *vis)
     XVisualInfo *       getOverlayVisual()
     void                setDrawToFrontBufferEnable(SbBool enableFlag)
     SbBool              isDrawToFrontBufferEnable() const

          Methods from class SoXtComponent:

     virtual void            show()
     virtual void            hide()
     SbBool                  isVisible()
     Widget                  getWidget() const
     SbBool                  isTopLevelShell() const
     Widget                  getShellWidget() const
     Widget                  getParentWidget() const
     void                    setSize(const SbVec2s &size)
     SbVec2s                 getSize()
     Display *               getDisplay()
     void                    setTitle(const char *newTitle)
     const char *            getTitle() const
     void                    setIconTitle(const char *newIconTitle)
     const char *            getIconTitle() const
     void                    setWindowCloseCallback(SoXtComponentCB *func, void *data = NULL)
     static SoXtComponent *  getComponent(Widget w)
     const char *            getWidgetName() const
     const char *            getClassName() const

DESCRIPTION

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

METHODS

     void                setDecoration(SbBool onOrOff)
     SbBool              isDecoration()
          Show/hide the viewer component trim (default on). See the viewer constructor to prevent
          the decoration from being built.

     void                setPopupMenuEnabled(SbBool trueOrFalse)
     SbBool              isPopupMenuEnabled()
          Enable/disable  the  viewer popup menu (default enabled). See the viewer constructor to
          prevent the popup menu from being built.

     Widget              getAppPushButtonParent() const
          Returns the parent widget, which is needed when creating new buttons. Note: that if the
          decoration is not created in the constructor, this will be NULL until the decoration is
          shown.

     void                addAppPushButton(Widget newButton)
     void                insertAppPushButton(Widget newButton, int index)
     void                removeAppPushButton(Widget oldButton)
     int                 findAppPushButton(Widget oldButton)
     int                 lengthAppPushButton()
          Add/remove push buttons for the application, which will be placed in the left hand side
          decoration  trim.  Adding  buttons appends them to the end of the list, while inserting
          them places them at the desired index.

          Note: the button pixmaps should  be  24-by-24  pixels  size  to  nicely  fit  into  the
          decoration trim like the other viewer buttons.

     Widget              getRenderAreaWidget()
          Returns the render area widget.

SEE ALSO

       SoXtViewer,    SoXtComponent,    SoXtRenderArea,    SoXtExaminerViewer,    SoXtWalkViewer,
       SoXtFlyViewer, SoXtPlaneViewer

                                                                            SoXtFullViewer(3IV)()