SoXtFlyViewer(3IV)

SoXtFlyViewer (SoXtFlyVwr) - viewer component for flying through space, with a constant world up

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

NAME
     SoXtFlyViewer (SoXtFlyVwr) - viewer component for flying through space,
     with a constant world up

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

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

     typedef SoXtFlyViewer  SoXtFlyVwr

                                 #define SoXtFlyVwrCreateStd(parent, name)
                                 SoXtFlyVwrCreate(parent, name, TRUE,
                                 SO_XT_FULL_VWR_BUILD_ALL, SO_XT_VWR_BROWSER)


          Functions from class SoXtFlyViewer:

     SoXtFlyViewer *     SoXtFlyVwrCreate(Widget parent = NULL, const char
                              *name = NULL, SbBool buildInsideParent = TRUE,
                              SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                              SoXtViewer::Type type = BROWSER)
     void                SoXtFlyVwrDelete(SoXtFlyVwr *this)

          Functions from class SoXtConstrainedViewer:

     void                SoXtFlyVwrSetUpDir(SoXtFlyVwr *this, const SbVec3f
                              *newUpDirection)
     SbVec3f             SoXtFlyVwrGetUpDir(SoXtFlyVwr *this)

          Functions from class SoXtFullViewer:

     void                SoXtFlyVwrSetDecor(SoXtFlyVwr *this, SbBool onOrOff)
     SbBool              SoXtFlyVwrIsDecor(SoXtFlyVwr *this)
     void                SoXtFlyVwrSetPopupEnabled(SoXtFlyVwr *this, SbBool
                              trueOrFalse)
     SbBool              SoXtFlyVwrIsPopupEnabled(SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetAppPushBtnParent(const SoXtFlyVwr *this)
     void                SoXtFlyVwrAddAppPushBtn(SoXtFlyVwr *this, Widget
                              newButton)
     void                SoXtFlyVwrInsertAppPushBtn(SoXtFlyVwr *this, Widget
                              newButton, int index)
     void                SoXtFlyVwrRemoveAppPushBtn(SoXtFlyVwr *this, Widget
                              oldButton)
     int                 SoXtFlyVwrFindAppPushBtn(SoXtFlyVwr *this, Widget
                              oldButton)
     int                 SoXtFlyVwrLengthAppPushBtn(SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetRAWidget(SoXtFlyVwr *this)

          Functions from class SoXtViewer:
     void                    SoXtFlyVwrSetCam(SoXtFlyVwr *this, SoCamera *cam)
     SoCamera *              SoXtFlyVwrGetCam(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetCamType(SoXtFlyVwr *this, SoType
                                  type)
     SoType                  SoXtFlyVwrGetCamType(SoXtFlyVwr *this)
     void                    SoXtFlyVwrViewAll(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSaveHomePos(SoXtFlyVwr *this)
     void                    SoXtFlyVwrResetToHomePos(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetHeadlight(SoXtFlyVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFlyVwrIsHeadlight(SoXtFlyVwr *this)
     SoDirectionalLight *    SoXtFlyVwrGetHeadlight(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetDStyle(SoXtFlyVwr *this,
                                  SoXtViewer::DrawType type,
                                  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtFlyVwrGetDStyle(SoXtFlyVwr *this,
                                  SoXtViewer::DrawType type)
     void                    SoXtFlyVwrSetBufType(SoXtFlyVwr *this,
                                  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtFlyVwrGetBufType(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetViewing(SoXtFlyVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFlyVwrIsViewing(const SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetCursorEnabled(SoXtFlyVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtFlyVwrIsCursorEnabled(const SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetAutoClip(SoXtFlyVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFlyVwrIsAutoClip(const SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetStereoViewing(SoXtFlyVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtFlyVwrIsStereoViewing(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetStereoOffset(SoXtFlyVwr *this, float
                                  dist)
     float                   SoXtFlyVwrGetStereoOffset(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetDtlSeek(SoXtFlyVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtFlyVwrIsDtlSeek(SoXtFlyVwr *this)
     void                    SoXtFlyVwrSetSeekTime(SoXtFlyVwr *this, float
                                  seconds)
     float                   SoXtFlyVwrGetSeekTime(SoXtFlyVwr *this)
     void                    SoXtFlyVwrAddStartCB(SoXtFlyVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFlyVwrAddFinishCB(SoXtFlyVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFlyVwrRemoveStartCB(SoXtFlyVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFlyVwrRemoveFinishCB(SoXtFlyVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtFlyVwrCopyView(SoXtFlyVwr *this, Time
                                  eventTime)

     void                    SoXtFlyVwrPasteView(SoXtFlyVwr *this, Time
                                  eventTime)
     void                    SoXtFlyVwrRecompSceneSiz(SoXtFlyVwr *this)

          Functions from class SoXtRenderArea:

     void                      SoXtFlyVwrSetScene(SoXtFlyVwr *this, SoNode
                                    *newScene)
     SoNode *                  SoXtFlyVwrGetScene(SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetOverScene(SoXtFlyVwr *this, SoNode
                                    *newScene)
     SoNode *                  SoXtFlyVwrGetOverScene(SoXtFlyVwr *this)
     void                      SoXtFlyVwrRegisterDevice(SoXtFlyVwr *this,
                                    SoXtDevice *)
     void                      SoXtFlyVwrUnregisterDevice(SoXtFlyVwr *this,
                                    SoXtDevice *)
     void                      SoXtFlyVwrSetBkgCol(SoXtFlyVwr *this, const
                                    SbColor *c)
     const SbColor *           SoXtFlyVwrGetBkgCol(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetBkgInd(SoXtFlyVwr *this, int
                                    index)
     int                       SoXtFlyVwrGetBkgInd(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetOverBkgInd(SoXtFlyVwr *this, int
                                    index)
     int                       SoXtFlyVwrGetOverBkgInd(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetColMap(SoXtFlyVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtFlyVwrSetOverColMap(SoXtFlyVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtFlyVwrSetVPReg(SoXtFlyVwr *this, const
                                    SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtFlyVwrGetVPReg(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetTranspType(SoXtFlyVwr *this,
                                    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               SoXtFlyVwrGetTranspType(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetAntialiasing(SoXtFlyVwr *this,
                                    SbBool smoothing, int numPasses)
     void                      SoXtFlyVwrGetAntialiasing(const SoXtFlyVwr
                                    *this, SbBool *smoothing, int *numPasses)
     void                      SoXtFlyVwrSetClearBeforeRender(SoXtFlyVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtFlyVwrIsClearBeforeRender(const SoXtFlyVwr
                                    *this)
     void                      SoXtFlyVwrSetClearBeforeOverRender(SoXtFlyVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtFlyVwrIsClearBeforeOverRender(const
                                    SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetAutoRedraw(SoXtFlyVwr *this,
                                    SbBool trueOrFalse)
     SbBool                    SoXtFlyVwrIsAutoRedraw(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetRedrawPriority(SoXtFlyVwr *this,
                                    uint32_t priority)
     uint32_t                  SoXtFlyVwrGetRedrawPriority(const SoXtFlyVwr
                                    *this)
     uint32_t                  SoXtFlyVwrGetDefaultRedrawPriority()
     void                      SoXtFlyVwrRender(SoXtFlyVwr *this)
     void                      SoXtFlyVwrRenderOverlay(SoXtFlyVwr *this)
     void                      SoXtFlyVwrScheduleRedraw(SoXtFlyVwr *this)
     void                      SoXtFlyVwrScheduleOverRedraw(SoXtFlyVwr *this)
     void                      SoXtFlyVwrRedrawOnSelChange(SoXtFlyVwr *this,
                                    SoSelection *s)
     void                      SoXtFlyVwrRedrawOverOnSelChange(SoXtFlyVwr
                                    *this, SoSelection *s)
     void                      SoXtFlyVwrSetEvCB(SoXtFlyVwr *this,
                                    SoXtRenderAreaEventCB *fcn, void *userData
                                    = NULL)
     void                      SoXtFlyVwrSetGLRenderAct(SoXtFlyVwr *this,
                                    SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtFlyVwrGetGLRenderAct(const SoXtFlyVwr
                                    *this)
     void                      SoXtFlyVwrSetOverGLRenderAct(SoXtFlyVwr *this,
                                    SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtFlyVwrGetOverGLRenderAct(const SoXtFlyVwr
                                    *this)
     void                      SoXtFlyVwrSetSceneMgr(SoXtFlyVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtFlyVwrGetSceneMgr(const SoXtFlyVwr *this)
     void                      SoXtFlyVwrSetOverSceneMgr(SoXtFlyVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtFlyVwrGetOverSceneMgr(const SoXtFlyVwr
                                    *this)

          Functions from class SoXtGLWidget:

     void                SoXtFlyVwrSetBorder(SoXtFlyVwr *this, SbBool onOrOff)
     SbBool              SoXtFlyVwrIsBorder(const SoXtFlyVwr *this)
     void                SoXtFlyVwrSetDblBuf(SoXtFlyVwr *this, SbBool onOrOff)
     SbBool              SoXtFlyVwrIsDblBuf(SoXtFlyVwr *this)
     Window              SoXtFlyVwrGetNormWin(SoXtFlyVwr *this)
     Window              SoXtFlyVwrGetOverWin(SoXtFlyVwr *this)
     GLXContext          SoXtFlyVwrGetNormCtx(SoXtFlyVwr *this)
     GLXContext          SoXtFlyVwrGetOverCtx(SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetNormWidget(SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetOverWidget(SoXtFlyVwr *this)
     void                SoXtFlyVwrSetNormVis(SoXtFlyVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtFlyVwrGetNormVis(SoXtFlyVwr *this)
     void                SoXtFlyVwrSetOverVis(SoXtFlyVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtFlyVwrGetOverVis(SoXtFlyVwr *this)

     void                SoXtFlyVwrSetDrwFrontBuf(SoXtFlyVwr *this, SbBool
                              enableFlag)
     SbBool              SoXtFlyVwrIsDrwFrontBuf(const SoXtFlyVwr *this)

          Functions from class SoXtComponent:

     void                SoXtFlyVwrShow(SoXtFlyVwr *this)
     void                SoXtFlyVwrHide(SoXtFlyVwr *this)
     SbBool              SoXtFlyVwrIsVisible(SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetWidget(const SoXtFlyVwr *this)
     SbBool              SoXtFlyVwrIsTopLevelShell(const SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetShellWidget(const SoXtFlyVwr *this)
     Widget              SoXtFlyVwrGetParentWidget(const SoXtFlyVwr *this)
     void                SoXtFlyVwrSetSize(SoXtFlyVwr *this, const SbVec2s
                              *size)
     SbVec2s             SoXtFlyVwrGetSize(SoXtFlyVwr *this)
     Display *           SoXtFlyVwrGetDisplay(SoXtFlyVwr *this)
     void                SoXtFlyVwrSetTitle(SoXtFlyVwr *this, const char
                              *newTitle)
     const char *        SoXtFlyVwrGetTitle(const SoXtFlyVwr *this)
     void                SoXtFlyVwrSetIconTitle(SoXtFlyVwr *this, const char
                              *newIconTitle)
     const char *        SoXtFlyVwrGetIconTitle(const SoXtFlyVwr *this)
     void                SoXtFlyVwrSetWinCloseCB(SoXtFlyVwr *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtFlyVwrGetComp(Widget w)
     const char *        SoXtFlyVwrGetWidgetName(const SoXtFlyVwr *this)
     const char *        SoXtFlyVwrGetClassName(const SoXtFlyVwr *this)


DESCRIPTION
     Fly Viewer - this viewer is intended to simulate flight through space,
     with a constant world up direction. The viewer only constrains the camera
     to keep the user from flying upside down. No mouse buttons need to be
     pressed in order to fly. The mouse position is used only for steering,
     while mouse clicks are used to increase or decrease the viewer speed.

     The viewer allows you to tilt your head up/down/right/left and move in
     the direction you are looking (forward or backward). The viewer also
     supports seek to quickly move the camera to a desired object or point.

FUNCTIONS
     SoXtFlyViewer *     SoXtFlyVwrCreate(Widget parent = NULL, const char
                              *name = NULL, SbBool buildInsideParent = TRUE,
                              SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                              SoXtViewer::Type type = BROWSER)
     void                SoXtFlyVwrDelete(SoXtFlyVwr *this)
          Constructor and destructor which specifies the viewer type. Please
          refer to the SoXtViewer reference page for a description of the
          viewer types. For a constructor short cut look at the
          SoXtFlyVwrCreateStd #define.

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


USAGE
     Left Mouse: Click to increase speed.

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

     <u> + Left Mouse: 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.

     Middle Mouse: Click to decrease speed.

     Left and Middle Mouse: Click boths simultaneously to stop.

     Ctrl: Hold the key down to temporary stop and rotate the viewpoint.

     Right Mouse: Open the popup menu.

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