SoXtWalkViewer(3IV)

SoXtWalkViewer (SoXtWalkVwr) - viewer component which moves the camera in a plane

Showing IRIX 6.5.30 (default release). Added in IRIX 6.5.22.

NAME
     SoXtWalkViewer (SoXtWalkVwr) - viewer component which moves the camera in
     a plane

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

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

     typedef SoXtWalkViewer  SoXtWalkVwr

                                  #define SoXtWalkVwrCreateStd(parent, name)
                                  SoXtWalkVwrCreate(parent, name, TRUE,
                                  SO_XT_FULL_VWR_BUILD_ALL, SO_XT_VWR_BROWSER)


          Functions from class SoXtWalkViewer:

     SoXtWalkViewer *    SoXtWalkVwrCreate(Widget parent = NULL, const char
                              *name = NULL, SbBool buildInsideParent = TRUE,
                              SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                              SoXtViewer::Type type = BROWSER)
     void                SoXtWalkVwrDelete(SoXtWalkVwr *this)

          Functions from class SoXtConstrainedViewer:

     void                SoXtWalkVwrSetUpDir(SoXtWalkVwr *this, const SbVec3f
                              *newUpDirection)
     SbVec3f             SoXtWalkVwrGetUpDir(SoXtWalkVwr *this)

          Functions from class SoXtFullViewer:

     void                SoXtWalkVwrSetDecor(SoXtWalkVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtWalkVwrIsDecor(SoXtWalkVwr *this)
     void                SoXtWalkVwrSetPopupEnabled(SoXtWalkVwr *this, SbBool
                              trueOrFalse)
     SbBool              SoXtWalkVwrIsPopupEnabled(SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetAppPushBtnParent(const SoXtWalkVwr
                              *this)
     void                SoXtWalkVwrAddAppPushBtn(SoXtWalkVwr *this, Widget
                              newButton)
     void                SoXtWalkVwrInsertAppPushBtn(SoXtWalkVwr *this, Widget
                              newButton, int index)
     void                SoXtWalkVwrRemoveAppPushBtn(SoXtWalkVwr *this, Widget
                              oldButton)
     int                 SoXtWalkVwrFindAppPushBtn(SoXtWalkVwr *this, Widget
                              oldButton)
     int                 SoXtWalkVwrLengthAppPushBtn(SoXtWalkVwr *this)

     Widget              SoXtWalkVwrGetRAWidget(SoXtWalkVwr *this)

          Functions from class SoXtViewer:

     void                    SoXtWalkVwrSetCam(SoXtWalkVwr *this, SoCamera
                                  *cam)
     SoCamera *              SoXtWalkVwrGetCam(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetCamType(SoXtWalkVwr *this, SoType
                                  type)
     SoType                  SoXtWalkVwrGetCamType(SoXtWalkVwr *this)
     void                    SoXtWalkVwrViewAll(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSaveHomePos(SoXtWalkVwr *this)
     void                    SoXtWalkVwrResetToHomePos(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetHeadlight(SoXtWalkVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtWalkVwrIsHeadlight(SoXtWalkVwr *this)
     SoDirectionalLight *    SoXtWalkVwrGetHeadlight(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetDStyle(SoXtWalkVwr *this,
                                  SoXtViewer::DrawType type,
                                  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtWalkVwrGetDStyle(SoXtWalkVwr *this,
                                  SoXtViewer::DrawType type)
     void                    SoXtWalkVwrSetBufType(SoXtWalkVwr *this,
                                  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtWalkVwrGetBufType(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetViewing(SoXtWalkVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtWalkVwrIsViewing(const SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetCursorEnabled(SoXtWalkVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtWalkVwrIsCursorEnabled(const SoXtWalkVwr
                                  *this)
     void                    SoXtWalkVwrSetAutoClip(SoXtWalkVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtWalkVwrIsAutoClip(const SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetStereoViewing(SoXtWalkVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtWalkVwrIsStereoViewing(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetStereoOffset(SoXtWalkVwr *this,
                                  float dist)
     float                   SoXtWalkVwrGetStereoOffset(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetDtlSeek(SoXtWalkVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtWalkVwrIsDtlSeek(SoXtWalkVwr *this)
     void                    SoXtWalkVwrSetSeekTime(SoXtWalkVwr *this, float
                                  seconds)
     float                   SoXtWalkVwrGetSeekTime(SoXtWalkVwr *this)
     void                    SoXtWalkVwrAddStartCB(SoXtWalkVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtWalkVwrAddFinishCB(SoXtWalkVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)

     void                    SoXtWalkVwrRemoveStartCB(SoXtWalkVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtWalkVwrRemoveFinishCB(SoXtWalkVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtWalkVwrCopyView(SoXtWalkVwr *this, Time
                                  eventTime)
     void                    SoXtWalkVwrPasteView(SoXtWalkVwr *this, Time
                                  eventTime)
     void                    SoXtWalkVwrRecompSceneSiz(SoXtWalkVwr *this)

          Functions from class SoXtRenderArea:

     void                      SoXtWalkVwrSetScene(SoXtWalkVwr *this, SoNode
                                    *newScene)
     SoNode *                  SoXtWalkVwrGetScene(SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetOverScene(SoXtWalkVwr *this,
                                    SoNode *newScene)
     SoNode *                  SoXtWalkVwrGetOverScene(SoXtWalkVwr *this)
     void                      SoXtWalkVwrRegisterDevice(SoXtWalkVwr *this,
                                    SoXtDevice *)
     void                      SoXtWalkVwrUnregisterDevice(SoXtWalkVwr *this,
                                    SoXtDevice *)
     void                      SoXtWalkVwrSetBkgCol(SoXtWalkVwr *this, const
                                    SbColor *c)
     const SbColor *           SoXtWalkVwrGetBkgCol(const SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetBkgInd(SoXtWalkVwr *this, int
                                    index)
     int                       SoXtWalkVwrGetBkgInd(const SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetOverBkgInd(SoXtWalkVwr *this, int
                                    index)
     int                       SoXtWalkVwrGetOverBkgInd(const SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrSetColMap(SoXtWalkVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtWalkVwrSetOverColMap(SoXtWalkVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtWalkVwrSetVPReg(SoXtWalkVwr *this, const
                                    SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtWalkVwrGetVPReg(const SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetTranspType(SoXtWalkVwr *this,
                                    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               SoXtWalkVwrGetTranspType(const SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrSetAntialiasing(SoXtWalkVwr *this,
                                    SbBool smoothing, int numPasses)
     void                      SoXtWalkVwrGetAntialiasing(const SoXtWalkVwr
                                    *this, SbBool *smoothing, int *numPasses)
     void                      SoXtWalkVwrSetClearBeforeRender(SoXtWalkVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtWalkVwrIsClearBeforeRender(const
                                    SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetClearBeforeOverRender(SoXtWalkVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtWalkVwrIsClearBeforeOverRender(const
                                    SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetAutoRedraw(SoXtWalkVwr *this,
                                    SbBool trueOrFalse)
     SbBool                    SoXtWalkVwrIsAutoRedraw(const SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrSetRedrawPriority(SoXtWalkVwr *this,
                                    uint32_t priority)
     uint32_t                  SoXtWalkVwrGetRedrawPriority(const SoXtWalkVwr
                                    *this)
     uint32_t                  SoXtWalkVwrGetDefaultRedrawPriority()
     void                      SoXtWalkVwrRender(SoXtWalkVwr *this)
     void                      SoXtWalkVwrRenderOverlay(SoXtWalkVwr *this)
     void                      SoXtWalkVwrScheduleRedraw(SoXtWalkVwr *this)
     void                      SoXtWalkVwrScheduleOverRedraw(SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrRedrawOnSelChange(SoXtWalkVwr *this,
                                    SoSelection *s)
     void                      SoXtWalkVwrRedrawOverOnSelChange(SoXtWalkVwr
                                    *this, SoSelection *s)
     void                      SoXtWalkVwrSetEvCB(SoXtWalkVwr *this,
                                    SoXtRenderAreaEventCB *fcn, void *userData
                                    = NULL)
     void                      SoXtWalkVwrSetGLRenderAct(SoXtWalkVwr *this,
                                    SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtWalkVwrGetGLRenderAct(const SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrSetOverGLRenderAct(SoXtWalkVwr
                                    *this, SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtWalkVwrGetOverGLRenderAct(const SoXtWalkVwr
                                    *this)
     void                      SoXtWalkVwrSetSceneMgr(SoXtWalkVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtWalkVwrGetSceneMgr(const SoXtWalkVwr *this)
     void                      SoXtWalkVwrSetOverSceneMgr(SoXtWalkVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtWalkVwrGetOverSceneMgr(const SoXtWalkVwr
                                    *this)

          Functions from class SoXtGLWidget:

     void                SoXtWalkVwrSetBorder(SoXtWalkVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtWalkVwrIsBorder(const SoXtWalkVwr *this)
     void                SoXtWalkVwrSetDblBuf(SoXtWalkVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtWalkVwrIsDblBuf(SoXtWalkVwr *this)

     Window              SoXtWalkVwrGetNormWin(SoXtWalkVwr *this)
     Window              SoXtWalkVwrGetOverWin(SoXtWalkVwr *this)
     GLXContext          SoXtWalkVwrGetNormCtx(SoXtWalkVwr *this)
     GLXContext          SoXtWalkVwrGetOverCtx(SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetNormWidget(SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetOverWidget(SoXtWalkVwr *this)
     void                SoXtWalkVwrSetNormVis(SoXtWalkVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtWalkVwrGetNormVis(SoXtWalkVwr *this)
     void                SoXtWalkVwrSetOverVis(SoXtWalkVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtWalkVwrGetOverVis(SoXtWalkVwr *this)
     void                SoXtWalkVwrSetDrwFrontBuf(SoXtWalkVwr *this, SbBool
                              enableFlag)
     SbBool              SoXtWalkVwrIsDrwFrontBuf(const SoXtWalkVwr *this)

          Functions from class SoXtComponent:

     void                SoXtWalkVwrShow(SoXtWalkVwr *this)
     void                SoXtWalkVwrHide(SoXtWalkVwr *this)
     SbBool              SoXtWalkVwrIsVisible(SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetWidget(const SoXtWalkVwr *this)
     SbBool              SoXtWalkVwrIsTopLevelShell(const SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetShellWidget(const SoXtWalkVwr *this)
     Widget              SoXtWalkVwrGetParentWidget(const SoXtWalkVwr *this)
     void                SoXtWalkVwrSetSize(SoXtWalkVwr *this, const SbVec2s
                              *size)
     SbVec2s             SoXtWalkVwrGetSize(SoXtWalkVwr *this)
     Display *           SoXtWalkVwrGetDisplay(SoXtWalkVwr *this)
     void                SoXtWalkVwrSetTitle(SoXtWalkVwr *this, const char
                              *newTitle)
     const char *        SoXtWalkVwrGetTitle(const SoXtWalkVwr *this)
     void                SoXtWalkVwrSetIconTitle(SoXtWalkVwr *this, const char
                              *newIconTitle)
     const char *        SoXtWalkVwrGetIconTitle(const SoXtWalkVwr *this)
     void                SoXtWalkVwrSetWinCloseCB(SoXtWalkVwr *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtWalkVwrGetComp(Widget w)
     const char *        SoXtWalkVwrGetWidgetName(const SoXtWalkVwr *this)
     const char *        SoXtWalkVwrGetClassName(const SoXtWalkVwr *this)


DESCRIPTION
     The paradigm for this viewer is a walkthrough of an architectural model.
     Its primary behavior is forward, backward, and left/right turning motion
     while maintaining a constant "eye level". It is also possible to stop and
     look around at the scene. The eye level plane can be disabled, allowing
     the viewer to proceed in the "look at" direction, as if on an escalator.
     The eye level plane can also be translated up and down - similar to an
     elevator.

FUNCTIONS
     SoXtWalkViewer *    SoXtWalkVwrCreate(Widget parent = NULL, const char
                              *name = NULL, SbBool buildInsideParent = TRUE,
                              SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                              SoXtViewer::Type type = BROWSER)
     void                SoXtWalkVwrDelete(SoXtWalkVwr *this)
          Constructor and destructor which specifies the viewer type. Please
          refer to the SoXtViewer man pages for a description of the viewer
          types. For a constructor short cut look at the SoXtWalkVwrCreateStd
          #define.


RESOURCES
          *SoXtWalkViewer.decoration: on (on | off)
          *SoXtWalkViewer.seekAnimationTime: 2.0 (float)
          *SoXtWalkViewer.seekTo: point (point | object)
          *SoXtWalkViewer.seekDistanceUsage: percentage (percentage | absolute)
          *SoXtWalkViewer.zoomMin: 1.0 (float)
          *SoXtWalkViewer.zoomMax: 179.0 (float)
          *SoXtWalkViewer.autoClipping: on (on | off)
          *SoXtWalkViewer.nearDistance: 2.4 (float, when autoClipping is off)
          *SoXtWalkViewer.farDistance: 2.8 (float, when autoClipping is off)
          *SoXtWalkViewer*BackgroundColor: black (color name or hex value)



USAGE
     Left Mouse: walk mode. Click down and move up/down for fowards/backwards
     motion. Move right and left for turning. Speed increases exponentially
     with the distance from the mouse-down origin.

     Middle Mouse - or

     Ctrl + Left Mouse: Translate up, down, left and right.

     Ctrl + Middle Mouse: tilt the camera up/down and right/left. This allows
     you to look around while stopped.

     <s> + click: Alternative to the Seek button. Press (but do not hold down)
     the <s> key, then click on a target object.

     <u> + click: Press (but do not hold down) the <u> key, then click on a
     target object to set the "up" direction to the surface normal. By default
     +y is the "up" direction.

     Right Mouse: Open the popup menu.

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