SoXtExaminerViewer(3IV)

SoXtExaminerViewer (SoXtExamVwr) - viewer component which uses a virtual trackball to view the data

As shipped in IRIX 6.5.22. Added in IRIX 6.5.22.

NAME
     SoXtExaminerViewer (SoXtExamVwr) - viewer component which uses a virtual
     trackball to view the data

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

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

     typedef SoXtExaminerViewer  SoXtExamVwr

                                      #define SoXtExamVwrCreateStd(parent,
                                      name) SoXtExamVwrCreate(parent, name,
                                      TRUE, SO_XT_FULL_VWR_BUILD_ALL,
                                      SO_XT_VWR_BROWSER)


          Functions from class SoXtExaminerViewer:

     SoXtExaminerViewer *  SoXtExamVwrCreate(Widget parent = NULL, const char
                                *name = NULL, SbBool buildInsideParent = TRUE,
                                SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                                SoXtViewer::Type type = BROWSER)
     void                  SoXtExamVwrDelete(SoXtExamVwr *this)
     void                  SoXtExamVwrSetFeedbackVis(SoXtExamVwr *this, SbBool
                                onOrOff)
     SbBool                SoXtExamVwrIsFeedbackVis(const SoXtExamVwr *this)
     void                  SoXtExamVwrSetFeedbackSize(SoXtExamVwr *this, int
                                newSize)
     int                   SoXtExamVwrGetFeedbackSize(const SoXtExamVwr *this)
     void                  SoXtExamVwrSetAnimEnabled(SoXtExamVwr *this, SbBool
                                onOrOff)
     SbBool                SoXtExamVwrIsAnimEnabled(SoXtExamVwr *this)
     void                  SoXtExamVwrStopAnim(SoXtExamVwr *this)
     SbBool                SoXtExamVwrIsAnim(SoXtExamVwr *this)

          Functions from class SoXtFullViewer:

     void                SoXtExamVwrSetDecor(SoXtExamVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtExamVwrIsDecor(SoXtExamVwr *this)
     void                SoXtExamVwrSetPopupEnabled(SoXtExamVwr *this, SbBool
                              trueOrFalse)
     SbBool              SoXtExamVwrIsPopupEnabled(SoXtExamVwr *this)
     Widget              SoXtExamVwrGetAppPushBtnParent(const SoXtExamVwr
                              *this)
     void                SoXtExamVwrAddAppPushBtn(SoXtExamVwr *this, Widget
                              newButton)
     void                SoXtExamVwrInsertAppPushBtn(SoXtExamVwr *this, Widget
                              newButton, int index)
     void                SoXtExamVwrRemoveAppPushBtn(SoXtExamVwr *this, Widget
                              oldButton)
     int                 SoXtExamVwrFindAppPushBtn(SoXtExamVwr *this, Widget
                              oldButton)
     int                 SoXtExamVwrLengthAppPushBtn(SoXtExamVwr *this)
     Widget              SoXtExamVwrGetRAWidget(SoXtExamVwr *this)

          Functions from class SoXtViewer:

     void                    SoXtExamVwrSetCam(SoXtExamVwr *this, SoCamera
                                  *cam)
     SoCamera *              SoXtExamVwrGetCam(SoXtExamVwr *this)
     void                    SoXtExamVwrSetCamType(SoXtExamVwr *this, SoType
                                  type)
     SoType                  SoXtExamVwrGetCamType(SoXtExamVwr *this)
     void                    SoXtExamVwrViewAll(SoXtExamVwr *this)
     void                    SoXtExamVwrSaveHomePos(SoXtExamVwr *this)
     void                    SoXtExamVwrResetToHomePos(SoXtExamVwr *this)
     void                    SoXtExamVwrSetHeadlight(SoXtExamVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtExamVwrIsHeadlight(SoXtExamVwr *this)
     SoDirectionalLight *    SoXtExamVwrGetHeadlight(SoXtExamVwr *this)
     void                    SoXtExamVwrSetDStyle(SoXtExamVwr *this,
                                  SoXtViewer::DrawType type,
                                  SoXtViewer::DrawStyle style)
     SoXtViewer::DrawStyle   SoXtExamVwrGetDStyle(SoXtExamVwr *this,
                                  SoXtViewer::DrawType type)
     void                    SoXtExamVwrSetBufType(SoXtExamVwr *this,
                                  SoXtViewer::BufferType type)
     SoXtViewer::BufferType  SoXtExamVwrGetBufType(SoXtExamVwr *this)
     void                    SoXtExamVwrSetViewing(SoXtExamVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtExamVwrIsViewing(const SoXtExamVwr *this)
     void                    SoXtExamVwrSetCursorEnabled(SoXtExamVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtExamVwrIsCursorEnabled(const SoXtExamVwr
                                  *this)
     void                    SoXtExamVwrSetAutoClip(SoXtExamVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtExamVwrIsAutoClip(const SoXtExamVwr *this)
     void                    SoXtExamVwrSetStereoViewing(SoXtExamVwr *this,
                                  SbBool onOrOff)
     SbBool                  SoXtExamVwrIsStereoViewing(SoXtExamVwr *this)
     void                    SoXtExamVwrSetStereoOffset(SoXtExamVwr *this,
                                  float dist)
     float                   SoXtExamVwrGetStereoOffset(SoXtExamVwr *this)
     void                    SoXtExamVwrSetDtlSeek(SoXtExamVwr *this, SbBool
                                  onOrOff)
     SbBool                  SoXtExamVwrIsDtlSeek(SoXtExamVwr *this)
     void                    SoXtExamVwrSetSeekTime(SoXtExamVwr *this, float
                                  seconds)

     float                   SoXtExamVwrGetSeekTime(SoXtExamVwr *this)
     void                    SoXtExamVwrAddStartCB(SoXtExamVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtExamVwrAddFinishCB(SoXtExamVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtExamVwrRemoveStartCB(SoXtExamVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtExamVwrRemoveFinishCB(SoXtExamVwr *this,
                                  SoXtViewerCB *f, void *userData = NULL)
     void                    SoXtExamVwrCopyView(SoXtExamVwr *this, Time
                                  eventTime)
     void                    SoXtExamVwrPasteView(SoXtExamVwr *this, Time
                                  eventTime)
     void                    SoXtExamVwrRecompSceneSiz(SoXtExamVwr *this)

          Functions from class SoXtRenderArea:

     void                      SoXtExamVwrSetScene(SoXtExamVwr *this, SoNode
                                    *newScene)
     SoNode *                  SoXtExamVwrGetScene(SoXtExamVwr *this)
     void                      SoXtExamVwrSetOverScene(SoXtExamVwr *this,
                                    SoNode *newScene)
     SoNode *                  SoXtExamVwrGetOverScene(SoXtExamVwr *this)
     void                      SoXtExamVwrRegisterDevice(SoXtExamVwr *this,
                                    SoXtDevice *)
     void                      SoXtExamVwrUnregisterDevice(SoXtExamVwr *this,
                                    SoXtDevice *)
     void                      SoXtExamVwrSetBkgCol(SoXtExamVwr *this, const
                                    SbColor *c)
     const SbColor *           SoXtExamVwrGetBkgCol(const SoXtExamVwr *this)
     void                      SoXtExamVwrSetBkgInd(SoXtExamVwr *this, int
                                    index)
     int                       SoXtExamVwrGetBkgInd(const SoXtExamVwr *this)
     void                      SoXtExamVwrSetOverBkgInd(SoXtExamVwr *this, int
                                    index)
     int                       SoXtExamVwrGetOverBkgInd(const SoXtExamVwr
                                    *this)
     void                      SoXtExamVwrSetColMap(SoXtExamVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtExamVwrSetOverColMap(SoXtExamVwr *this, int
                                    startIndex, int num, const SbColor
                                    *colors)
     void                      SoXtExamVwrSetVPReg(SoXtExamVwr *this, const
                                    SbViewportRegion *newRegion)
     const SbViewportRegion *  SoXtExamVwrGetVPReg(const SoXtExamVwr *this)
     void                      SoXtExamVwrSetTranspType(SoXtExamVwr *this,
                                    SoGLRenderAction::TransparencyType type)
     SoGLRenderAction::TransparencyType
                               SoXtExamVwrGetTranspType(const SoXtExamVwr
                                    *this)

     void                      SoXtExamVwrSetAntialiasing(SoXtExamVwr *this,
                                    SbBool smoothing, int numPasses)
     void                      SoXtExamVwrGetAntialiasing(const SoXtExamVwr
                                    *this, SbBool *smoothing, int *numPasses)
     void                      SoXtExamVwrSetClearBeforeRender(SoXtExamVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtExamVwrIsClearBeforeRender(const
                                    SoXtExamVwr *this)
     void                      SoXtExamVwrSetClearBeforeOverRender(SoXtExamVwr
                                    *this, SbBool trueOrFalse)
     SbBool                    SoXtExamVwrIsClearBeforeOverRender(const
                                    SoXtExamVwr *this)
     void                      SoXtExamVwrSetAutoRedraw(SoXtExamVwr *this,
                                    SbBool trueOrFalse)
     SbBool                    SoXtExamVwrIsAutoRedraw(const SoXtExamVwr
                                    *this)
     void                      SoXtExamVwrSetRedrawPriority(SoXtExamVwr *this,
                                    uint32_t priority)
     uint32_t                  SoXtExamVwrGetRedrawPriority(const SoXtExamVwr
                                    *this)
     uint32_t                  SoXtExamVwrGetDefaultRedrawPriority()
     void                      SoXtExamVwrRender(SoXtExamVwr *this)
     void                      SoXtExamVwrRenderOverlay(SoXtExamVwr *this)
     void                      SoXtExamVwrScheduleRedraw(SoXtExamVwr *this)
     void                      SoXtExamVwrScheduleOverRedraw(SoXtExamVwr
                                    *this)
     void                      SoXtExamVwrRedrawOnSelChange(SoXtExamVwr *this,
                                    SoSelection *s)
     void                      SoXtExamVwrRedrawOverOnSelChange(SoXtExamVwr
                                    *this, SoSelection *s)
     void                      SoXtExamVwrSetEvCB(SoXtExamVwr *this,
                                    SoXtRenderAreaEventCB *fcn, void *userData
                                    = NULL)
     void                      SoXtExamVwrSetGLRenderAct(SoXtExamVwr *this,
                                    SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtExamVwrGetGLRenderAct(const SoXtExamVwr
                                    *this)
     void                      SoXtExamVwrSetOverGLRenderAct(SoXtExamVwr
                                    *this, SoGLRenderAction *ra)
     SoGLRenderAction *        SoXtExamVwrGetOverGLRenderAct(const SoXtExamVwr
                                    *this)
     void                      SoXtExamVwrSetSceneMgr(SoXtExamVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtExamVwrGetSceneMgr(const SoXtExamVwr *this)
     void                      SoXtExamVwrSetOverSceneMgr(SoXtExamVwr *this,
                                    SoSceneManager *sm)
     SoSceneManager *          SoXtExamVwrGetOverSceneMgr(const SoXtExamVwr
                                    *this)

          Functions from class SoXtGLWidget:

     void                SoXtExamVwrSetBorder(SoXtExamVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtExamVwrIsBorder(const SoXtExamVwr *this)
     void                SoXtExamVwrSetDblBuf(SoXtExamVwr *this, SbBool
                              onOrOff)
     SbBool              SoXtExamVwrIsDblBuf(SoXtExamVwr *this)
     Window              SoXtExamVwrGetNormWin(SoXtExamVwr *this)
     Window              SoXtExamVwrGetOverWin(SoXtExamVwr *this)
     GLXContext          SoXtExamVwrGetNormCtx(SoXtExamVwr *this)
     GLXContext          SoXtExamVwrGetOverCtx(SoXtExamVwr *this)
     Widget              SoXtExamVwrGetNormWidget(SoXtExamVwr *this)
     Widget              SoXtExamVwrGetOverWidget(SoXtExamVwr *this)
     void                SoXtExamVwrSetNormVis(SoXtExamVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtExamVwrGetNormVis(SoXtExamVwr *this)
     void                SoXtExamVwrSetOverVis(SoXtExamVwr *this, XVisualInfo
                              *vis)
     XVisualInfo *       SoXtExamVwrGetOverVis(SoXtExamVwr *this)
     void                SoXtExamVwrSetDrwFrontBuf(SoXtExamVwr *this, SbBool
                              enableFlag)
     SbBool              SoXtExamVwrIsDrwFrontBuf(const SoXtExamVwr *this)

          Functions from class SoXtComponent:

     void                SoXtExamVwrShow(SoXtExamVwr *this)
     void                SoXtExamVwrHide(SoXtExamVwr *this)
     SbBool              SoXtExamVwrIsVisible(SoXtExamVwr *this)
     Widget              SoXtExamVwrGetWidget(const SoXtExamVwr *this)
     SbBool              SoXtExamVwrIsTopLevelShell(const SoXtExamVwr *this)
     Widget              SoXtExamVwrGetShellWidget(const SoXtExamVwr *this)
     Widget              SoXtExamVwrGetParentWidget(const SoXtExamVwr *this)
     void                SoXtExamVwrSetSize(SoXtExamVwr *this, const SbVec2s
                              *size)
     SbVec2s             SoXtExamVwrGetSize(SoXtExamVwr *this)
     Display *           SoXtExamVwrGetDisplay(SoXtExamVwr *this)
     void                SoXtExamVwrSetTitle(SoXtExamVwr *this, const char
                              *newTitle)
     const char *        SoXtExamVwrGetTitle(const SoXtExamVwr *this)
     void                SoXtExamVwrSetIconTitle(SoXtExamVwr *this, const char
                              *newIconTitle)
     const char *        SoXtExamVwrGetIconTitle(const SoXtExamVwr *this)
     void                SoXtExamVwrSetWinCloseCB(SoXtExamVwr *this,
                              SoXtComponentCB *func, void *data = NULL)
     SoXtComponent *     SoXtExamVwrGetComp(Widget w)
     const char *        SoXtExamVwrGetWidgetName(const SoXtExamVwr *this)
     const char *        SoXtExamVwrGetClassName(const SoXtExamVwr *this)


DESCRIPTION
     The Examiner viewer component allows you to rotate the view around a
     point of interest using a virtual trackball. The viewer uses the camera
     focalDistance field to figure out the point of rotation, which is usually
     set to be at the center of the scene. In addition to allowing you to
     rotate the camera around the point of interest, this viewer also allows
     you to translate the camera in the viewer plane, as well as dolly (move
     forward and backward) to get closer to or further away from the point of
     interest. The viewer also supports seek to quickly move the camera to a
     desired object or point.

FUNCTIONS
     SoXtExaminerViewer *  SoXtExamVwrCreate(Widget parent = NULL, const char
                                *name = NULL, SbBool buildInsideParent = TRUE,
                                SoXtFullViewer::BuildFlag flag = BUILD_ALL,
                                SoXtViewer::Type type = BROWSER)
     void                  SoXtExamVwrDelete(SoXtExamVwr *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
          SoXtExamVwrCreateStd #define.

     void                  SoXtExamVwrSetFeedbackVis(SoXtExamVwr *this, SbBool
                                onOrOff)
     SbBool                SoXtExamVwrIsFeedbackVis(const SoXtExamVwr *this)
          Show/Hide the point of rotation feedback, which only appears while
          in viewing mode (default in off).

     void                  SoXtExamVwrSetFeedbackSize(SoXtExamVwr *this, int
                                newSize)
     int                   SoXtExamVwrGetFeedbackSize(const SoXtExamVwr *this)
          Set/get the point of rotation feedback size in pixels (default 20
          pix).

     void                  SoXtExamVwrSetAnimEnabled(SoXtExamVwr *this, SbBool
                                onOrOff)
     SbBool                SoXtExamVwrIsAnimEnabled(SoXtExamVwr *this)
          Enable/disable the spinning animation feature of the viewer (enabled
          by default).

     void                  SoXtExamVwrStopAnim(SoXtExamVwr *this)
     SbBool                SoXtExamVwrIsAnim(SoXtExamVwr *this)
          Stop animation, if it is occurring, and query if the viewer is
          currently animating.


RESOURCES
          *SoXtExaminerViewer.spinAnimation: on (on | off)
          *SoXtExaminerViewer.pointOfRotationAxes: off (on | off)
          *SoXtExaminerViewer.axesSize: 20 (short, pixels if axes is on)
          *SoXtExaminerViewer.decoration: on (on | off)
          *SoXtExaminerViewer.seekAnimationTime: 2.0 (float)
          *SoXtExaminerViewer.seekTo: point (point | object)
          *SoXtExaminerViewer.seekDistanceUsage: percentage (percentage | absolute)
          *SoXtExaminerViewer.zoomMin: 1.0 (float)
          *SoXtExaminerViewer.zoomMax: 179.0 (float)
          *SoXtExaminerViewer.autoClipping: on (on | off)
          *SoXtExaminerViewer.nearDistance: 2.4 (float, when autoClipping is off)
          *SoXtExaminerViewer.farDistance: 2.8 (float, when autoClipping is off)
          *SoXtExaminerViewer*BackgroundColor: black (color name or hex value)


USAGE
          Left Mouse: Rotate the virtual trackball.



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



          Ctrl + Middle Mouse:
          Left + Middle Mouse: Dolly in and out (gets closer to and further
          away from the object).



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



          Right Mouse: Open the popup menu.



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