SoXtExaminerViewer(3IV)

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:

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

~SoXtExaminerViewer()
void
setFeedbackVisibility(SbBool onOrOff)
SbBool
isFeedbackVisible() const
void
setFeedbackSize(int newSize)
int
getFeedbackSize() const
void
setAnimationEnabled(SbBool onOrOff)
SbBool
isAnimationEnabled()
void
stopAnimating()
SbBool
isAnimating()

Methods from class SoXtFullViewer:

void
setDecoration(SbBool onOrOff)
SbBool
isDecoration()
void
setPopupMenuEnabled(SbBool trueOrFalse)
SbBool
isPopupMenuEnabled()
Widget
getAppPushButtonParent() const
void
addAppPushButton(Widget newButton)
void
insertAppPushButton(Widget newButton, int index)
void
removeAppPushButton(Widget oldButton)
int
findAppPushButton(Widget oldButton)
int
lengthAppPushButton()
Widget
getRenderAreaWidget()

Methods from class SoXtViewer:

virtual void
setCamera(SoCamera *cam)
SoCamera *
getCamera()
virtual void
setCameraType(SoType type)
SoType
getCameraType()
virtual void
viewAll()
virtual void
saveHomePosition()
virtual void
resetToHomePosition()
virtual void
setHeadlight(SbBool onOrOff)
SbBool
isHeadlight()
SoDirectionalLight *
getHeadlight()
virtual void
setDrawStyle(SoXtViewer::DrawType type, SoXtViewer::DrawStyle style)
SoXtViewer::DrawStyle
getDrawStyle(SoXtViewer::DrawType type)
virtual void
setBufferingType(SoXtViewer::BufferType type)
SoXtViewer::BufferType
getBufferingType()
virtual void
setViewing(SbBool onOrOff)
SbBool
isViewing() const
virtual void
setCursorEnabled(SbBool onOrOff)
SbBool
isCursorEnabled() const
void
setAutoClipping(SbBool onOrOff)
SbBool
isAutoClipping() const
virtual void
setStereoViewing(SbBool onOrOff)
virtual SbBool
isStereoViewing()
void
setStereoOffset(float dist)
float
getStereoOffset()
void
setDetailSeek(SbBool onOrOff)
SbBool
isDetailSeek()
void
setSeekTime(float seconds)
float
getSeekTime()
void
addStartCallback(SoXtViewerCB *f, void *userData = NULL)
void
addFinishCallback(SoXtViewerCB *f, void *userData = NULL)
void
removeStartCallback(SoXtViewerCB *f, void *userData = NULL)
void
removeFinishCallback(SoXtViewerCB *f, void *userData = NULL)
void
copyView(Time eventTime)
void
pasteView(Time eventTime)
virtual void
recomputeSceneSize()

Methods from class SoXtRenderArea:

virtual void
setSceneGraph(SoNode *newScene)
virtual SoNode *
getSceneGraph()
void
setOverlaySceneGraph(SoNode *newScene)
SoNode *
getOverlaySceneGraph()
void
registerDevice(SoXtDevice *)
void
unregisterDevice(SoXtDevice *)
void
setBackgroundColor(const SbColor &c)
const SbColor &
getBackgroundColor() const
void
setBackgroundIndex(int index)
int
getBackgroundIndex() const
void
setOverlayBackgroundIndex(int index)
int
getOverlayBackgroundIndex() const
void
setColorMap(int startIndex, int num, const SbColor *colors)
void
setOverlayColorMap(int startIndex, int num, const SbColor *colors)
void
setViewportRegion(const SbViewportRegion &newRegion)
const SbViewportRegion &
getViewportRegion() const
void
setTransparencyType(SoGLRenderAction::TransparencyType type)
SoGLRenderAction::TransparencyType
getTransparencyType() const
void
setAntialiasing(SbBool smoothing, int numPasses)
void
getAntialiasing(SbBool &smoothing, int &numPasses) const
void
setClearBeforeRender(SbBool trueOrFalse)
SbBool
isClearBeforeRender() const
void
setClearBeforeOverlayRender(SbBool trueOrFalse)
SbBool
isClearBeforeOverlayRender() const
void
setAutoRedraw(SbBool trueOrFalse)
SbBool
isAutoRedraw() const
void
setRedrawPriority(uint32_t priority)
uint32_t
getRedrawPriority() const
static uint32_t
getDefaultRedrawPriority()
void
render()
void
renderOverlay()
void
scheduleRedraw()
void
scheduleOverlayRedraw()
void
redrawOnSelectionChange(SoSelection *s)
void
redrawOverlayOnSelectionChange(SoSelection *s)
void
setEventCallback(SoXtRenderAreaEventCB *fcn, void *userData = NULL)
void
setGLRenderAction(SoGLRenderAction *ra)
SoGLRenderAction *
getGLRenderAction() const
void
setOverlayGLRenderAction(SoGLRenderAction *ra)
SoGLRenderAction *
getOverlayGLRenderAction() const
void
setSceneManager(SoSceneManager *sm)
SoSceneManager *
getSceneManager() const
void
setOverlaySceneManager(SoSceneManager *sm)
SoSceneManager *
getOverlaySceneManager() const

Methods from class SoXtGLWidget:

void
setBorder(SbBool onOrOff)
SbBool
isBorder() const
virtual void
setDoubleBuffer(SbBool onOrOff)
SbBool
isDoubleBuffer()
Window
getNormalWindow()
Window
getOverlayWindow()
GLXContext
getNormalContext()
GLXContext
getOverlayContext()
Widget
getNormalWidget()
Widget
getOverlayWidget()
virtual void
setNormalVisual(XVisualInfo *vis)
XVisualInfo *
getNormalVisual()
virtual void
setOverlayVisual(XVisualInfo *vis)
XVisualInfo *
getOverlayVisual()
void
setDrawToFrontBufferEnable(SbBool enableFlag)
SbBool
isDrawToFrontBufferEnable() const

Methods from class SoXtComponent:

virtual void
show()
virtual void
hide()
SbBool
isVisible()
Widget
getWidget() const
SbBool
isTopLevelShell() const
Widget
getShellWidget() const
Widget
getParentWidget() const
void
setSize(const SbVec2s &size)
SbVec2s
getSize()
Display *
getDisplay()
void
setTitle(const char *newTitle)
const char *
getTitle() const
void
setIconTitle(const char *newIconTitle)
const char *
getIconTitle() const
void
setWindowCloseCallback(SoXtComponentCB *func, void *data = NULL)
static SoXtComponent *
getComponent(Widget w)
const char *
getWidgetName() const
const char *
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

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

~SoXtExaminerViewer()
Constructor and destructor which specifies the viewer type. Please refer to the SoXtViewer reference page for a description of the viewer types.

void
setFeedbackVisibility(SbBool onOrOff)
SbBool
isFeedbackVisible() const
Show/Hide the point of rotation feedback, which only appears while in viewing mode (default in off).

void
setFeedbackSize(int newSize)
int
getFeedbackSize() const
Set/get the point of rotation feedback size in pixels (default 20 pix).

void
setAnimationEnabled(SbBool onOrOff)
SbBool
isAnimationEnabled()
Enable/disable the spinning animation feature of the viewer (enabled by default).

void
stopAnimating()
SbBool
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