SoXtConstrainedViewer(3IV)

SoXtConstrainedViewer (SoXtConstrVwr) - base viewer class which adds camera constraints given a world up direction

As shipped in IRIX 6.5.30. Added in IRIX 6.5.22.

NAME
     SoXtConstrainedViewer (SoXtConstrVwr) - base viewer class which adds
     camera constraints given a world up direction

INHERITS FROM
     SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer >
     SoXtFullViewer > SoXtConstrainedViewer

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

     typedef SoXtConstrainedViewer
                         SoXtConstrVwr

          Functions from class SoXtConstrainedViewer:

     void                SoXtConstrVwrSetUpDir(SoXtConstrVwr *this, const
                              SbVec3f *newUpDirection)
     SbVec3f             SoXtConstrVwrGetUpDir(SoXtConstrVwr *this)

          Functions from class SoXtFullViewer:

     void                SoXtConstrVwrSetDecor(SoXtConstrVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtConstrVwrIsDecor(SoXtConstrVwr *this)
     void                SoXtConstrVwrSetPopupEnabled(SoXtConstrVwr *this,
                              SbBool trueOrFalse)
     SbBool              SoXtConstrVwrIsPopupEnabled(SoXtConstrVwr *this)
     Widget              SoXtConstrVwrGetAppPushBtnParent(const SoXtConstrVwr
                              *this)
     void                SoXtConstrVwrAddAppPushBtn(SoXtConstrVwr *this,
                              Widget newButton)
     void                SoXtConstrVwrInsertAppPushBtn(SoXtConstrVwr *this,
                              Widget newButton, int index)
     void                SoXtConstrVwrRemoveAppPushBtn(SoXtConstrVwr *this,
                              Widget oldButton)
     int                 SoXtConstrVwrFindAppPushBtn(SoXtConstrVwr *this,
                              Widget oldButton)
     int                 SoXtConstrVwrLengthAppPushBtn(SoXtConstrVwr *this)
     Widget              SoXtConstrVwrGetRAWidget(SoXtConstrVwr *this)

          Functions from class SoXtViewer:

     void                    SoXtConstrVwrSetCam(SoXtConstrVwr *this, SoCamera
                                  *cam)
     SoCamera *              SoXtConstrVwrGetCam(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetCamType(SoXtConstrVwr *this,
                                  SoType type)
     SoType                  SoXtConstrVwrGetCamType(SoXtConstrVwr *this)
     void                    SoXtConstrVwrViewAll(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSaveHomePos(SoXtConstrVwr *this)
     void                    SoXtConstrVwrResetToHomePos(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetHeadlight(SoXtConstrVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsHeadlight(SoXtConstrVwr *this)
     SoDirectionalLight *    SoXtConstrVwrGetHeadlight(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetDStyle(SoXtConstrVwr *this,
                                  SoXtViewer::DrawType type,
                                  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtConstrVwrGetDStyle(SoXtConstrVwr *this,
                                  SoXtViewer::DrawType type)
     void                    SoXtConstrVwrSetBufType(SoXtConstrVwr *this,
                                  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtConstrVwrGetBufType(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetViewing(SoXtConstrVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsViewing(const SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetCursorEnabled(SoXtConstrVwr
                                  *this, SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsCursorEnabled(const SoXtConstrVwr
                                  *this)
     void                    SoXtConstrVwrSetAutoClip(SoXtConstrVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsAutoClip(const SoXtConstrVwr
                                  *this)
     void                    SoXtConstrVwrSetStereoViewing(SoXtConstrVwr
                                  *this, SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsStereoViewing(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetStereoOffset(SoXtConstrVwr *this,
                                  float dist)
     float                   SoXtConstrVwrGetStereoOffset(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetDtlSeek(SoXtConstrVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtConstrVwrIsDtlSeek(SoXtConstrVwr *this)
     void                    SoXtConstrVwrSetSeekTime(SoXtConstrVwr *this,
                                  float seconds)
     float                   SoXtConstrVwrGetSeekTime(SoXtConstrVwr *this)
     void                    SoXtConstrVwrAddStartCB(SoXtConstrVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtConstrVwrAddFinishCB(SoXtConstrVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtConstrVwrRemoveStartCB(SoXtConstrVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtConstrVwrRemoveFinishCB(SoXtConstrVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtConstrVwrCopyView(SoXtConstrVwr *this, Time
                                  eventTime)
     void                    SoXtConstrVwrPasteView(SoXtConstrVwr *this, Time
                                  eventTime)
     void                    SoXtConstrVwrRecompSceneSiz(SoXtConstrVwr *this)

          Functions from class SoXtRenderArea:
     void                      SoXtConstrVwrDelete(SoXtConstrVwr *this)
     void                      SoXtConstrVwrSetScene(SoXtConstrVwr *this,
                                    SoNode *newScene)
     SoNode *                  SoXtConstrVwrGetScene(SoXtConstrVwr *this)
     void                      SoXtConstrVwrSetOverScene(SoXtConstrVwr *this,
                                    SoNode *newScene)
     SoNode *                  SoXtConstrVwrGetOverScene(SoXtConstrVwr *this)
     void                      SoXtConstrVwrRegisterDevice(SoXtConstrVwr
                                    *this, SoXtDevice *)
     void                      SoXtConstrVwrUnregisterDevice(SoXtConstrVwr
                                    *this, SoXtDevice *)
     void                      SoXtConstrVwrSetBkgCol(SoXtConstrVwr *this,
                                    const SbColor *c)
     const SbColor *           SoXtConstrVwrGetBkgCol(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetBkgInd(SoXtConstrVwr *this, int
                                    index)
     int                       SoXtConstrVwrGetBkgInd(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetOverBkgInd(SoXtConstrVwr *this,
                                    int index)
     int                       SoXtConstrVwrGetOverBkgInd(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetColMap(SoXtConstrVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtConstrVwrSetOverColMap(SoXtConstrVwr *this,
                                    int startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtConstrVwrSetVPReg(SoXtConstrVwr *this,
                                    const SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtConstrVwrGetVPReg(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetTranspType(SoXtConstrVwr *this,
                                    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               SoXtConstrVwrGetTranspType(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetAntialiasing(SoXtConstrVwr
                                    *this, SbBool smoothing, int numPasses)
     void                      SoXtConstrVwrGetAntialiasing(const
                                    SoXtConstrVwr *this, SbBool *smoothing,
                                    int *numPasses)
     void                      SoXtConstrVwrSetClearBeforeRender(SoXtConstrVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtConstrVwrIsClearBeforeRender(const
                                    SoXtConstrVwr *this)
     void                      SoXtConstrVwrSetClearBeforeOverRender(SoXtConstrVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtConstrVwrIsClearBeforeOverRender(const
                                    SoXtConstrVwr *this)
     void                      SoXtConstrVwrSetAutoRedraw(SoXtConstrVwr *this,
                                    SbBool trueOrFalse)
     SbBool                    SoXtConstrVwrIsAutoRedraw(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetRedrawPriority(SoXtConstrVwr
                                    *this, uint32_t priority)
     uint32_t                  SoXtConstrVwrGetRedrawPriority(const
                                    SoXtConstrVwr *this)
     uint32_t                  SoXtConstrVwrGetDefaultRedrawPriority()
     void                      SoXtConstrVwrRender(SoXtConstrVwr *this)
     void                      SoXtConstrVwrRenderOverlay(SoXtConstrVwr *this)
     void                      SoXtConstrVwrScheduleRedraw(SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrScheduleOverRedraw(SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrRedrawOnSelChange(SoXtConstrVwr
                                    *this, SoSelection *s)
     void                      SoXtConstrVwrRedrawOverOnSelChange(SoXtConstrVwr
                                    *this, SoSelection *s)
     void                      SoXtConstrVwrSetEvCB(SoXtConstrVwr *this,
                                    SoXtRenderAreaEventCB *fcn, void *userData
                                    = NULL)
     void                      SoXtConstrVwrSetGLRenderAct(SoXtConstrVwr
                                    *this, SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtConstrVwrGetGLRenderAct(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetOverGLRenderAct(SoXtConstrVwr
                                    *this, SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtConstrVwrGetOverGLRenderAct(const
                                    SoXtConstrVwr *this)
     void                      SoXtConstrVwrSetSceneMgr(SoXtConstrVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtConstrVwrGetSceneMgr(const SoXtConstrVwr
                                    *this)
     void                      SoXtConstrVwrSetOverSceneMgr(SoXtConstrVwr
                                    *this, SoSceneManager *sm)
     SoSceneManager *          SoXtConstrVwrGetOverSceneMgr(const
                                    SoXtConstrVwr *this)

          Functions from class SoXtGLWidget:

     void                SoXtConstrVwrSetBorder(SoXtConstrVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtConstrVwrIsBorder(const SoXtConstrVwr *this)
     void                SoXtConstrVwrSetDblBuf(SoXtConstrVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtConstrVwrIsDblBuf(SoXtConstrVwr *this)
     Window              SoXtConstrVwrGetNormWin(SoXtConstrVwr *this)
     Window              SoXtConstrVwrGetOverWin(SoXtConstrVwr *this)
     GLXContext          SoXtConstrVwrGetNormCtx(SoXtConstrVwr *this)
     GLXContext          SoXtConstrVwrGetOverCtx(SoXtConstrVwr *this)
     Widget              SoXtConstrVwrGetNormWidget(SoXtConstrVwr *this)
     Widget              SoXtConstrVwrGetOverWidget(SoXtConstrVwr *this)
     void                SoXtConstrVwrSetNormVis(SoXtConstrVwr *this,
                              XVisualInfo *vis)
     XVisualInfo *       SoXtConstrVwrGetNormVis(SoXtConstrVwr *this)
     void                SoXtConstrVwrSetOverVis(SoXtConstrVwr *this,
                              XVisualInfo *vis)
     XVisualInfo *       SoXtConstrVwrGetOverVis(SoXtConstrVwr *this)
     void                SoXtConstrVwrSetDrwFrontBuf(SoXtConstrVwr *this,
                              SbBool enableFlag)
     SbBool              SoXtConstrVwrIsDrwFrontBuf(const SoXtConstrVwr *this)

          Functions from class SoXtComponent:

     void                SoXtConstrVwrShow(SoXtConstrVwr *this)
     void                SoXtConstrVwrHide(SoXtConstrVwr *this)
     SbBool              SoXtConstrVwrIsVisible(SoXtConstrVwr *this)
     Widget              SoXtConstrVwrGetWidget(const SoXtConstrVwr *this)
     SbBool              SoXtConstrVwrIsTopLevelShell(const SoXtConstrVwr
                              *this)
     Widget              SoXtConstrVwrGetShellWidget(const SoXtConstrVwr
                              *this)
     Widget              SoXtConstrVwrGetParentWidget(const SoXtConstrVwr
                              *this)
     void                SoXtConstrVwrSetSize(SoXtConstrVwr *this, const
                              SbVec2s *size)
     SbVec2s             SoXtConstrVwrGetSize(SoXtConstrVwr *this)
     Display *           SoXtConstrVwrGetDisplay(SoXtConstrVwr *this)
     void                SoXtConstrVwrSetTitle(SoXtConstrVwr *this, const char
                              *newTitle)
     const char *        SoXtConstrVwrGetTitle(const SoXtConstrVwr *this)
     void                SoXtConstrVwrSetIconTitle(SoXtConstrVwr *this, const
                              char *newIconTitle)
     const char *        SoXtConstrVwrGetIconTitle(const SoXtConstrVwr *this)
     void                SoXtConstrVwrSetWinCloseCB(SoXtConstrVwr *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtConstrVwrGetComp(Widget w)
     const char *        SoXtConstrVwrGetWidgetName(const SoXtConstrVwr *this)
     const char *        SoXtConstrVwrGetClassName(const SoXtConstrVwr *this)


DESCRIPTION
     This is a base class for the SoXtWalkViewer and SoXtFlyViewer component
     viewers. This class adds methods and convenience routines available to
     subclasses to constrain the camera given a world up direction. This
     prevents the camera from looking upside down. By default the +Y direction
     is used.

FUNCTIONS
     void                SoXtConstrVwrSetUpDir(SoXtConstrVwr *this, const
                              SbVec3f *newUpDirection)
     SbVec3f             SoXtConstrVwrGetUpDir(SoXtConstrVwr *this)
          Specifies the upward direction of the viewer. This up direction is
          used by the viewers to constrain the camera when tilting up/down,
          and also used when rotating the camera right/left. The default is
          the +Y (0,1,0) direction.


SEE ALSO
     SoXtFullViewer, SoXtViewer, SoXtComponent, SoXtRenderArea,
     SoXtWalkViewer, SoXtFlyViewer