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

NAME

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

INHERITS FROM

SoXtComponent > SoXtGLWidget > SoXtRenderArea > SoXtViewer > SoXtFullViewer > SoXtExaminerViewer

SYNOPSIS

#include <Inventor/Xt/viewers/SoXtExaminerViewer.h> Methods from class SoXtExaminerViewer: c } c } SoXtExaminerViewer(Widget parent = NULL, const char *name = NULL, SbBool buildInsideParent = TRUE, SoXtFullViewer::BuildFlag flag = BUILD_ALL, SoXtViewer::Type type = BROWSER)

c } c } ~SoXtExaminerViewer()

c } c } setFeedbackVisibility(SbBool onOrOff)

c } c } isFeedbackVisible() const

c } c } setFeedbackSize(int newSize)

c } c } getFeedbackSize() const

c } c } setAnimationEnabled(SbBool onOrOff)

c } c } isAnimationEnabled()

c } c } stopAnimating()

c } c } isAnimating() Methods from class SoXtFullViewer: c } c } setDecoration(SbBool onOrOff)

c } c } isDecoration()

c } c } setPopupMenuEnabled(SbBool trueOrFalse)

c } c } isPopupMenuEnabled()

c } c } getAppPushButtonParent() const

c } c } addAppPushButton(Widget newButton)

c } c } insertAppPushButton(Widget newButton, int index)

c } c } removeAppPushButton(Widget oldButton)

c } c } findAppPushButton(Widget oldButton)

c } c } lengthAppPushButton()

c } c } getRenderAreaWidget() Methods from class SoXtViewer: c } c } setCamera(SoCamera *cam)

c } c } getCamera()

c } c } setCameraType(SoType type)

c } c } getCameraType()

c } c } viewAll()

c } c } saveHomePosition()

c } c } resetToHomePosition()

c } c } setHeadlight(SbBool onOrOff)

c } c } isHeadlight()

c } c } getHeadlight()

c } c } setDrawStyle(SoXtViewer::DrawType type, SoXtViewer::DrawStyle style)

c } c } getDrawStyle(SoXtViewer::DrawType type)

c } c } setBufferingType(SoXtViewer::BufferType type)

c } c } getBufferingType()

c } c } setViewing(SbBool onOrOff)

c } c } isViewing() const

c } c } setCursorEnabled(SbBool onOrOff)

c } c } isCursorEnabled() const

c } c } setAutoClipping(SbBool onOrOff)

c } c } isAutoClipping() const

c } c } setStereoViewing(SbBool onOrOff)

c } c } isStereoViewing()

c } c } setStereoOffset(float dist)

c } c } getStereoOffset()

c } c } setDetailSeek(SbBool onOrOff)

c } c } isDetailSeek()

c } c } setSeekTime(float seconds)

c } c } getSeekTime()

c } c } addStartCallback(SoXtViewerCB *f, void *userData = NULL)

c } c } addFinishCallback(SoXtViewerCB *f, void *userData = NULL)

c } c } removeStartCallback(SoXtViewerCB *f, void *userData = NULL)

c } c } removeFinishCallback(SoXtViewerCB *f, void *userData = NULL)

c } c } copyView(Time eventTime)

c } c } pasteView(Time eventTime)

c } c } recomputeSceneSize() Methods from class SoXtRenderArea: c } c } setSceneGraph(SoNode *newScene)

c } c } getSceneGraph()

c } c } setOverlaySceneGraph(SoNode *newScene)

c } c } getOverlaySceneGraph()

c } c } registerDevice(SoXtDevice *)

c } c } unregisterDevice(SoXtDevice *)

c } c } setBackgroundColor(const SbColor &c)

c } c } getBackgroundColor() const

c } c } setBackgroundIndex(int index)

c } c } getBackgroundIndex() const

c } c } setOverlayBackgroundIndex(int index)

c } c } getOverlayBackgroundIndex() const

c } c } setColorMap(int startIndex, int num, const SbColor *colors)

c } c } setOverlayColorMap(int startIndex, int num, const SbColor *colors)

c } c } setViewportRegion(const SbViewportRegion &newRegion)

c } c } getViewportRegion() const

c } c } setTransparencyType(SoGLRenderAction::TransparencyType type)

c } c } getTransparencyType() const

c } c } setAntialiasing(SbBool smoothing, int numPasses)

c } c } getAntialiasing(SbBool &smoothing, int &numPasses) const

c } c } setClearBeforeRender(SbBool trueOrFalse)

c } c } isClearBeforeRender() const

c } c } setClearBeforeOverlayRender(SbBool trueOrFalse)

c } c } isClearBeforeOverlayRender() const

c } c } setAutoRedraw(SbBool trueOrFalse)

c } c } isAutoRedraw() const

c } c } setRedrawPriority(uint32_t priority)

c } c } getRedrawPriority() const

c } c } getDefaultRedrawPriority()

c } c } render()

c } c } renderOverlay()

c } c } scheduleRedraw()

c } c } scheduleOverlayRedraw()

c } c } redrawOnSelectionChange(SoSelection *s)

c } c } redrawOverlayOnSelectionChange(SoSelection *s)

c } c } setEventCallback(SoXtRenderAreaEventCB *fcn, void *userData = NULL)

c } c } setGLRenderAction(SoGLRenderAction *ra)

c } c } getGLRenderAction() const

c } c } setOverlayGLRenderAction(SoGLRenderAction *ra)

c } c } getOverlayGLRenderAction() const

c } c } setSceneManager(SoSceneManager *sm)

c } c } getSceneManager() const

c } c } setOverlaySceneManager(SoSceneManager *sm)

c } c } getOverlaySceneManager() const Methods from class SoXtGLWidget: c } c } setBorder(SbBool onOrOff)

c } c } isBorder() const

c } c } setDoubleBuffer(SbBool onOrOff)

c } c } isDoubleBuffer()

c } c } getNormalWindow()

c } c } getOverlayWindow()

c } c } getNormalContext()

c } c } getOverlayContext()

c } c } getNormalWidget()

c } c } getOverlayWidget()

c } c } setNormalVisual(XVisualInfo *vis)

c } c } getNormalVisual()

c } c } setOverlayVisual(XVisualInfo *vis)

c } c } getOverlayVisual()

c } c } setDrawToFrontBufferEnable(SbBool enableFlag)

c } c } isDrawToFrontBufferEnable() const Methods from class SoXtComponent: c } c } show()

c } c } hide()

c } c } isVisible()

c } c } getWidget() const

c } c } isTopLevelShell() const

c } c } getShellWidget() const

c } c } getParentWidget() const

c } c } setSize(const SbVec2s &size)

c } c } getSize()

c } c } getDisplay()

c } c } setTitle(const char *newTitle)

c } c } getTitle() const

c } c } setIconTitle(const char *newIconTitle)

c } c } getIconTitle() const

c } c } setWindowCloseCallback(SoXtComponentCB *func, void *data = NULL)

c } c } getComponent(Widget w)

c } c } getWidgetName() const

c } c } getClassName() const

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.

METHODS

c } c } SoXtExaminerViewer(Widget parent = NULL, const char *name = NULL, SbBool buildInsideParent = TRUE, SoXtFullViewer::BuildFlag flag = BUILD_ALL, SoXtViewer::Type type = BROWSER)

c } c } ~SoXtExaminerViewer()

Constructor and destructor which specifies the viewer type. Please refer to the SoXtViewer reference page for a description of the viewer types. c } c } setFeedbackVisibility(SbBool onOrOff)

c } c } isFeedbackVisible() const

Show/Hide the point of rotation feedback, which only appears while in viewing mode (default in off). c } c } setFeedbackSize(int newSize)

c } c } getFeedbackSize() const

Set/get the point of rotation feedback size in pixels (default 20 pix). c } c } setAnimationEnabled(SbBool onOrOff)

c } c } isAnimationEnabled()

Enable/disable the spinning animation feature of the viewer (enabled by default). c } c } stopAnimating()

c } c } isAnimating()

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