SoXtFullViewer(3IV)

NAME
     SoXtFullViewer (SoXtFullVwr) - base viewer class which adds a decoration
     around the rendering area

INHERITS FROM
     SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer >
     SoXtFullViewer

SYNOPSIS
     #include <Inventor_c/Xt/viewers/SoXtFullViewer.h>

     typedef SoXtFullViewer  SoXtFullVwr

     enum SoXtFullViewerBuildFlag {
          SO_XT_FULL_VWR_BUILD_NONE   doesn't build anything extra
          SO_XT_FULL_VWR_BUILD_DECORATION
                                      build the decoration only
          SO_XT_FULL_VWR_BUILD_POPUP  build the popup menu only
          SO_XT_FULL_VWR_BUILD_ALL    build everything by default
     }

          Functions from class SoXtFullViewer:

     void                SoXtFullVwrSetDecor(SoXtFullVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtFullVwrIsDecor(SoXtFullVwr *this)
     void                SoXtFullVwrSetPopupEnabled(SoXtFullVwr *this, SbBool
                              trueOrFalse)
     SbBool              SoXtFullVwrIsPopupEnabled(SoXtFullVwr *this)
     Widget              SoXtFullVwrGetAppPushBtnParent(const SoXtFullVwr
                              *this)
     void                SoXtFullVwrAddAppPushBtn(SoXtFullVwr *this, Widget
                              newButton)
     void                SoXtFullVwrInsertAppPushBtn(SoXtFullVwr *this, Widget
                              newButton, int index)
     void                SoXtFullVwrRemoveAppPushBtn(SoXtFullVwr *this, Widget
                              oldButton)
     int                 SoXtFullVwrFindAppPushBtn(SoXtFullVwr *this, Widget
                              oldButton)
     int                 SoXtFullVwrLengthAppPushBtn(SoXtFullVwr *this)
     Widget              SoXtFullVwrGetRAWidget(SoXtFullVwr *this)

          Functions from class SoXtViewer:

     void                    SoXtFullVwrSetCam(SoXtFullVwr *this, SoCamera
                                  *cam)
     SoCamera *              SoXtFullVwrGetCam(SoXtFullVwr *this)
     void                    SoXtFullVwrSetCamType(SoXtFullVwr *this, SoType
                                  type)
     SoType                  SoXtFullVwrGetCamType(SoXtFullVwr *this)
     void                    SoXtFullVwrViewAll(SoXtFullVwr *this)

     void                    SoXtFullVwrSaveHomePos(SoXtFullVwr *this)
     void                    SoXtFullVwrResetToHomePos(SoXtFullVwr *this)
     void                    SoXtFullVwrSetHeadlight(SoXtFullVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFullVwrIsHeadlight(SoXtFullVwr *this)
     SoDirectionalLight *    SoXtFullVwrGetHeadlight(SoXtFullVwr *this)
     void                    SoXtFullVwrSetDStyle(SoXtFullVwr *this,
                                  SoXtViewer::DrawType type,
                                  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtFullVwrGetDStyle(SoXtFullVwr *this,
                                  SoXtViewer::DrawType type)
     void                    SoXtFullVwrSetBufType(SoXtFullVwr *this,
                                  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtFullVwrGetBufType(SoXtFullVwr *this)
     void                    SoXtFullVwrSetViewing(SoXtFullVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFullVwrIsViewing(const SoXtFullVwr *this)
     void                    SoXtFullVwrSetCursorEnabled(SoXtFullVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtFullVwrIsCursorEnabled(const SoXtFullVwr
                                  *this)
     void                    SoXtFullVwrSetAutoClip(SoXtFullVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFullVwrIsAutoClip(const SoXtFullVwr *this)
     void                    SoXtFullVwrSetStereoViewing(SoXtFullVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtFullVwrIsStereoViewing(SoXtFullVwr *this)
     void                    SoXtFullVwrSetStereoOffset(SoXtFullVwr *this,
                                  float dist)
     float                   SoXtFullVwrGetStereoOffset(SoXtFullVwr *this)
     void                    SoXtFullVwrSetDtlSeek(SoXtFullVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFullVwrIsDtlSeek(SoXtFullVwr *this)
     void                    SoXtFullVwrSetSeekTime(SoXtFullVwr *this, float
                                  seconds)
     float                   SoXtFullVwrGetSeekTime(SoXtFullVwr *this)
     void                    SoXtFullVwrAddStartCB(SoXtFullVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFullVwrAddFinishCB(SoXtFullVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFullVwrRemoveStartCB(SoXtFullVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFullVwrRemoveFinishCB(SoXtFullVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFullVwrCopyView(SoXtFullVwr *this, Time
                                  eventTime)
     void                    SoXtFullVwrPasteView(SoXtFullVwr *this, Time
                                  eventTime)
     void                    SoXtFullVwrRecompSceneSiz(SoXtFullVwr *this)

          Functions from class SoXtRenderArea:

     void                      SoXtFullVwrDelete(SoXtFullVwr *this)
     void                      SoXtFullVwrSetScene(SoXtFullVwr *this, SoNode
                                    *newScene)
     SoNode *                  SoXtFullVwrGetScene(SoXtFullVwr *this)
     void                      SoXtFullVwrSetOverScene(SoXtFullVwr *this,
                                    SoNode *newScene)
     SoNode *                  SoXtFullVwrGetOverScene(SoXtFullVwr *this)
     void                      SoXtFullVwrRegisterDevice(SoXtFullVwr *this,
                                    SoXtDevice *)
     void                      SoXtFullVwrUnregisterDevice(SoXtFullVwr *this,
                                    SoXtDevice *)
     void                      SoXtFullVwrSetBkgCol(SoXtFullVwr *this, const
                                    SbColor *c)
     const SbColor *           SoXtFullVwrGetBkgCol(const SoXtFullVwr *this)
     void                      SoXtFullVwrSetBkgInd(SoXtFullVwr *this, int
                                    index)
     int                       SoXtFullVwrGetBkgInd(const SoXtFullVwr *this)
     void                      SoXtFullVwrSetOverBkgInd(SoXtFullVwr *this, int
                                    index)
     int                       SoXtFullVwrGetOverBkgInd(const SoXtFullVwr
                                    *this)
     void                      SoXtFullVwrSetColMap(SoXtFullVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtFullVwrSetOverColMap(SoXtFullVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtFullVwrSetVPReg(SoXtFullVwr *this, const
                                    SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtFullVwrGetVPReg(const SoXtFullVwr *this)
     void                      SoXtFullVwrSetTranspType(SoXtFullVwr *this,
                                    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               SoXtFullVwrGetTranspType(const SoXtFullVwr
                                    *this)
     void                      SoXtFullVwrSetAntialiasing(SoXtFullVwr *this,
                                    SbBool smoothing, int numPasses)
     void                      SoXtFullVwrGetAntialiasing(const SoXtFullVwr
                                    *this, SbBool *smoothing, int *numPasses)
     void                      SoXtFullVwrSetClearBeforeRender(SoXtFullVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtFullVwrIsClearBeforeRender(const
                                    SoXtFullVwr *this)
     void                      SoXtFullVwrSetClearBeforeOverRender(SoXtFullVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtFullVwrIsClearBeforeOverRender(const
                                    SoXtFullVwr *this)
     void                      SoXtFullVwrSetAutoRedraw(SoXtFullVwr *this,
                                    SbBool trueOrFalse)
     SbBool                    SoXtFullVwrIsAutoRedraw(const SoXtFullVwr
                                    *this)

     void                      SoXtFullVwrSetRedrawPriority(SoXtFullVwr *this,
                                    uint32_t priority)
     uint32_t                  SoXtFullVwrGetRedrawPriority(const SoXtFullVwr
                                    *this)
     uint32_t                  SoXtFullVwrGetDefaultRedrawPriority()
     void                      SoXtFullVwrRender(SoXtFullVwr *this)
     void                      SoXtFullVwrRenderOverlay(SoXtFullVwr *this)
     void                      SoXtFullVwrScheduleRedraw(SoXtFullVwr *this)
     void                      SoXtFullVwrScheduleOverRedraw(SoXtFullVwr
                                    *this)
     void                      SoXtFullVwrRedrawOnSelChange(SoXtFullVwr *this,
                                    SoSelection *s)
     void                      SoXtFullVwrRedrawOverOnSelChange(SoXtFullVwr
                                    *this, SoSelection *s)
     void                      SoXtFullVwrSetEvCB(SoXtFullVwr *this,
                                    SoXtRenderAreaEventCB *fcn, void *userData
                                    = NULL)
     void                      SoXtFullVwrSetGLRenderAct(SoXtFullVwr *this,
                                    SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtFullVwrGetGLRenderAct(const SoXtFullVwr
                                    *this)
     void                      SoXtFullVwrSetOverGLRenderAct(SoXtFullVwr
                                    *this, SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtFullVwrGetOverGLRenderAct(const SoXtFullVwr
                                    *this)
     void                      SoXtFullVwrSetSceneMgr(SoXtFullVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtFullVwrGetSceneMgr(const SoXtFullVwr *this)
     void                      SoXtFullVwrSetOverSceneMgr(SoXtFullVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtFullVwrGetOverSceneMgr(const SoXtFullVwr
                                    *this)

          Functions from class SoXtGLWidget:

     void                SoXtFullVwrSetBorder(SoXtFullVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtFullVwrIsBorder(const SoXtFullVwr *this)
     void                SoXtFullVwrSetDblBuf(SoXtFullVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtFullVwrIsDblBuf(SoXtFullVwr *this)
     Window              SoXtFullVwrGetNormWin(SoXtFullVwr *this)
     Window              SoXtFullVwrGetOverWin(SoXtFullVwr *this)
     GLXContext          SoXtFullVwrGetNormCtx(SoXtFullVwr *this)
     GLXContext          SoXtFullVwrGetOverCtx(SoXtFullVwr *this)
     Widget              SoXtFullVwrGetNormWidget(SoXtFullVwr *this)
     Widget              SoXtFullVwrGetOverWidget(SoXtFullVwr *this)
     void                SoXtFullVwrSetNormVis(SoXtFullVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtFullVwrGetNormVis(SoXtFullVwr *this)
     void                SoXtFullVwrSetOverVis(SoXtFullVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtFullVwrGetOverVis(SoXtFullVwr *this)
     void                SoXtFullVwrSetDrwFrontBuf(SoXtFullVwr *this, SbBool
                              enableFlag)
     SbBool              SoXtFullVwrIsDrwFrontBuf(const SoXtFullVwr *this)

          Functions from class SoXtComponent:

     void                SoXtFullVwrShow(SoXtFullVwr *this)
     void                SoXtFullVwrHide(SoXtFullVwr *this)
     SbBool              SoXtFullVwrIsVisible(SoXtFullVwr *this)
     Widget              SoXtFullVwrGetWidget(const SoXtFullVwr *this)
     SbBool              SoXtFullVwrIsTopLevelShell(const SoXtFullVwr *this)
     Widget              SoXtFullVwrGetShellWidget(const SoXtFullVwr *this)
     Widget              SoXtFullVwrGetParentWidget(const SoXtFullVwr *this)
     void                SoXtFullVwrSetSize(SoXtFullVwr *this, const SbVec2s
                              *size)
     SbVec2s             SoXtFullVwrGetSize(SoXtFullVwr *this)
     Display *           SoXtFullVwrGetDisplay(SoXtFullVwr *this)
     void                SoXtFullVwrSetTitle(SoXtFullVwr *this, const char
                              *newTitle)
     const char *        SoXtFullVwrGetTitle(const SoXtFullVwr *this)
     void                SoXtFullVwrSetIconTitle(SoXtFullVwr *this, const char
                              *newIconTitle)
     const char *        SoXtFullVwrGetIconTitle(const SoXtFullVwr *this)
     void                SoXtFullVwrSetWinCloseCB(SoXtFullVwr *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtFullVwrGetComp(Widget w)
     const char *        SoXtFullVwrGetWidgetName(const SoXtFullVwr *this)
     const char *        SoXtFullVwrGetClassName(const SoXtFullVwr *this)


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.

FUNCTIONS
     void                SoXtFullVwrSetDecor(SoXtFullVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtFullVwrIsDecor(SoXtFullVwr *this)
          Show/hide the viewer component trim (default on). See the viewer
          constructor to prevent the decoration from being built.

     void                SoXtFullVwrSetPopupEnabled(SoXtFullVwr *this, SbBool
                              trueOrFalse)
     SbBool              SoXtFullVwrIsPopupEnabled(SoXtFullVwr *this)
          Enable/disable the viewer popup menu (default enabled). See the
          viewer constructor to prevent the popup menu from being built.

     Widget              SoXtFullVwrGetAppPushBtnParent(const SoXtFullVwr
                              *this)
          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                SoXtFullVwrAddAppPushBtn(SoXtFullVwr *this, Widget
                              newButton)
     void                SoXtFullVwrInsertAppPushBtn(SoXtFullVwr *this, Widget
                              newButton, int index)
     void                SoXtFullVwrRemoveAppPushBtn(SoXtFullVwr *this, Widget
                              oldButton)
     int                 SoXtFullVwrFindAppPushBtn(SoXtFullVwr *this, Widget
                              oldButton)
     int                 SoXtFullVwrLengthAppPushBtn(SoXtFullVwr *this)
          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              SoXtFullVwrGetRAWidget(SoXtFullVwr *this)
          Returns the render area widget.


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