The SoXtExaminerViewer class is a 3D-model examination viewer. More...

#include <Inventor/Xt/viewers/SoXtExaminerViewer.h>

Inheritance diagram for SoXtExaminerViewer:

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

	~SoXtExaminerViewer ()

void	setAnimationEnabled (const SbBool enable)

SbBool	isAnimationEnabled (void) const

void	stopAnimating (void)

SbBool	isAnimating (void) const

void	setFeedbackVisibility (const SbBool enable)

SbBool	isFeedbackVisible (void) const

void	setFeedbackSize (const int size)

int	getFeedbackSize (void) const

virtual void	setViewing (SbBool enable)

virtual void	setCamera (SoCamera *camera)

virtual void	setCursorEnabled (SbBool enable)

Public Member Functions inherited from SoXtFullViewer
void	setDecoration (const SbBool on)

SbBool	isDecoration (void) const

void	setPopupMenuEnabled (const SbBool on)

SbBool	isPopupMenuEnabled (void) const

Widget	getAppPushButtonParent (void) const

void	addAppPushButton (Widget newButton)

void	insertAppPushButton (Widget newButton, int index)

void	removeAppPushButton (Widget oldButton)

int	findAppPushButton (Widget oldButton) const

int	lengthAppPushButton (void) const

Widget	getRenderAreaWidget (void) const

virtual void	setViewing (SbBool on)

virtual void	setComponentCursor (const SoXtCursor &cursor)

Public Member Functions inherited from SoXtViewer
virtual void	setCamera (SoCamera *camera)

SoCamera *	getCamera (void) const

virtual void	setCameraType (SoType type)

SoType	getCameraType (void) const

virtual void	toggleCameraType (void)

virtual void	viewAll (void)

virtual void	saveHomePosition (void)

virtual void	resetToHomePosition (void)

virtual void	setHeadlight (SbBool enable)

SbBool	isHeadlight (void) const

SoDirectionalLight *	getHeadlight (void) const

virtual void	setDrawStyle (SoXtViewer::DrawType type, SoXtViewer::DrawStyle style)

SoXtViewer::DrawStyle	getDrawStyle (const SoXtViewer::DrawType type) const

virtual void	setBufferingType (SoXtViewer::BufferType type)

SoXtViewer::BufferType	getBufferingType (void) const

virtual void	setViewing (SbBool enable)

SbBool	isViewing (void) const

virtual void	setCursorEnabled (SbBool enable)

SbBool	isCursorEnabled (void) const

void	setAutoClipping (SbBool enable)

SbBool	isAutoClipping (void) const

void	setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoXtAutoClippingCB cb=NULL, void cbuserdata=NULL)

virtual void	setStereoViewing (SbBool enable)

SbBool	isStereoViewing (void) const

virtual void	setStereoOffset (const float dist)

float	getStereoOffset (void) const

SbBool	setStereoType (SoXtViewer::StereoType s)

SoXtViewer::StereoType	getStereoType (void) const

void	setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3])

void	getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3])

void	setDetailSeek (const SbBool enable)

SbBool	isDetailSeek (void) const

void	setSeekTime (const float seconds)

float	getSeekTime (void) const

void	addStartCallback (SoXtViewerCB func, void data=NULL)

void	addFinishCallback (SoXtViewerCB func, void data=NULL)

void	removeStartCallback (SoXtViewerCB func, void data=NULL)

void	removeFinishCallback (SoXtViewerCB func, void data=NULL)

void	setWireframeOverlayColor (const SbColor &color)

const SbColor &	getWireframeOverlayColor (void) const

virtual void	setDoubleBuffer (const SbBool enable)

virtual void	setSceneGraph (SoNode *root)

virtual SoNode *	getSceneGraph (void)

Public Member Functions inherited from SoXtRenderArea
	SoXtRenderArea (Widget parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)

	~SoXtRenderArea ()

virtual void	setSceneGraph (SoNode *scene)

virtual SoNode *	getSceneGraph (void)

void	setOverlaySceneGraph (SoNode *scene)

SoNode *	getOverlaySceneGraph (void)

void	setBackgroundColor (const SbColor &color)

const SbColor &	getBackgroundColor (void) const

void	setBackgroundIndex (int idx)

int	getBackgroundIndex (void) const

void	setOverlayBackgroundIndex (int idx)

int	getOverlayBackgroundIndex (void) const

void	setColorMap (int start, int num, const SbColor *colors)

void	setOverlayColorMap (int start, int num, const SbColor *colors)

void	setViewportRegion (const SbViewportRegion &newRegion)

const SbViewportRegion &	getViewportRegion (void) const

void	setTransparencyType (SoGLRenderAction::TransparencyType type)

SoGLRenderAction::TransparencyType	getTransparencyType (void) const

void	setAntialiasing (SbBool smoothing, int numPasses)

void	getAntialiasing (SbBool &smoothing, int &numPasses) const

void	setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE)

SbBool	isClearBeforeRender (void) const

SbBool	isClearZBufferBeforeRender (void) const

void	setClearBeforeOverlayRender (SbBool enable)

SbBool	isClearBeforeOverlayRender (void) const

void	setAutoRedraw (SbBool enable)

SbBool	isAutoRedraw (void) const

void	setRedrawPriority (uint32_t priority)

uint32_t	getRedrawPriority (void) const

void	render (void)

void	renderOverlay (void)

void	scheduleRedraw (void)

void	scheduleOverlayRedraw (void)

void	redrawOnSelectionChange (SoSelection *selection)

void	redrawOverlayOnSelectionChange (SoSelection *selection)

void	setEventCallback (SoXtRenderAreaEventCB func, void user=NULL)

void	setSceneManager (SoSceneManager *manager)

SoSceneManager *	getSceneManager (void) const

void	setOverlaySceneManager (SoSceneManager *manager)

SoSceneManager *	getOverlaySceneManager (void) const

void	setGLRenderAction (SoGLRenderAction *action)

SoGLRenderAction *	getGLRenderAction (void) const

void	setOverlayGLRenderAction (SoGLRenderAction *action)

SoGLRenderAction *	getOverlayGLRenderAction (void) const

SbBool	sendSoEvent (const SoEvent *event)

void	registerDevice (SoXtDevice *device)

void	unregisterDevice (SoXtDevice *device)

Public Member Functions inherited from SoXtGLWidget
void	setBorder (const SbBool enable)

SbBool	isBorder (void) const

virtual void	setDoubleBuffer (const SbBool enable)

SbBool	isDoubleBuffer (void) const

void	setDrawToFrontBufferEnable (const SbBool enable)

SbBool	isDrawToFrontBufferEnable (void) const

void	setQuadBufferStereo (const SbBool enable)

SbBool	isQuadBufferStereo (void) const

void	setAccumulationBuffer (const SbBool enable)

SbBool	getAccumulationBuffer (void) const

void	setStencilBuffer (const SbBool enable)

SbBool	getStencilBuffer (void) const

void	setAlphaChannel (const SbBool enable)

SbBool	getAlphaChannel (void) const

void	setOverlayRender (const SbBool onoff)

SbBool	isOverlayRender (void) const

void	setSampleBuffers (const int numsamples)

int	getSampleBuffers (void) const

void	setStealFocus (SbBool enable)

SbBool	isStealFocus (void) const

Widget	getGLWidget (void) const

Widget	getNormalWidget (void) const

Widget	getOverlayWidget (void) const

SbBool	hasOverlayGLArea (void) const

SbBool	hasNormalGLArea (void) const

unsigned long	getOverlayTransparentPixel (void)

void	getPointSizeLimits (SbVec2f &range, float &granularity)

void	getLineWidthLimits (SbVec2f &range, float &granularity)

GLXContext	getNormalContext (void)

GLXContext	getOverlayContext (void)

Window	getNormalWindow (void)

Window	getOverlayWindow (void)

int	getOverlayColorMapSize (void)

int	getColorMapSize (void)

virtual void	setNormalVisual (XVisualInfo *visual)

XVisualInfo *	getNormalVisual (void)

virtual void	setOverlayVisual (XVisualInfo *visual)

XVisualInfo *	getOverlayVisual (void)

Public Member Functions inherited from SoXtComponent
virtual	~SoXtComponent ()

virtual void	show (void)

virtual void	hide (void)

virtual void	setComponentCursor (const SoXtCursor &cursor)

SbBool	isFullScreen (void) const

SbBool	setFullScreen (const SbBool onoff)

SbBool	isVisible (void)

SbBool	isTopLevelShell (void) const

Widget	getWidget (void) const

Widget	getBaseWidget (void) const

Widget	getShellWidget (void) const

Widget	getParentWidget (void) const

void	setSize (const SbVec2s size)

SbVec2s	getSize (void) const

void	setTitle (const char *const title)

const char *	getTitle (void) const

void	setIconTitle (const char *const title)

const char *	getIconTitle (void) const

const char *	getWidgetName (void) const

const char *	getClassName (void) const

void	setWindowCloseCallback (SoXtComponentCB const func, void const user=NULL)

Display *	getDisplay (void)

void	fitSize (const SbVec2s size)

void	addWindowCloseCallback (SoXtComponentCB callback, void closure=NULL)

void	removeWindowCloseCallback (SoXtComponentCB callback, void closure=NULL)

Public Member Functions inherited from SoXtObject
virtual SoType	getTypeId (void) const =0

SbBool	isOfType (SoType type) const

Protected Member Functions
	SoXtExaminerViewer (Widget parent, const char *name, SbBool embed, SoXtFullViewer::BuildFlag flag, SoXtViewer::Type type, SbBool build)

virtual void	leftWheelMotion (float val)

virtual void	bottomWheelMotion (float val)

virtual void	rightWheelMotion (float val)

virtual void	createViewerButtons (Widget parent, SbPList *buttonlist)

virtual const char *	getDefaultWidgetName (void) const

virtual const char *	getDefaultTitle (void) const

virtual const char *	getDefaultIconTitle (void) const

virtual SbBool	processSoEvent (const SoEvent *const event)

virtual void	setSeekMode (SbBool enable)

virtual void	actualRedraw (void)

virtual void	afterRealizeHook (void)

Protected Member Functions inherited from SoXtFullViewer
	SoXtFullViewer (Widget parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)

	~SoXtFullViewer ()

virtual void	sizeChanged (const SbVec2s &size)

Widget	buildWidget (Widget parent)

virtual void	buildDecoration (Widget parent)

virtual Widget	buildLeftTrim (Widget parent)

virtual Widget	buildBottomTrim (Widget parent)

virtual Widget	buildRightTrim (Widget parent)

Widget	buildAppButtons (Widget parent)

Widget	buildViewerButtons (Widget parent)

virtual void	createViewerButtons (Widget parent, SbPList *buttonlist)

virtual void	buildPopupMenu (void)

virtual void	setPopupMenuString (const char *title)

virtual void	openPopupMenu (const SbVec2s position)

virtual void	leftWheelStart (void)

virtual void	leftWheelMotion (float)

virtual void	leftWheelFinish (void)

float	getLeftWheelValue (void) const

void	setLeftWheelValue (const float value)

virtual void	bottomWheelStart (void)

virtual void	bottomWheelMotion (float)

virtual void	bottomWheelFinish (void)

float	getBottomWheelValue (void) const

void	setBottomWheelValue (const float value)

virtual void	rightWheelStart (void)

virtual void	rightWheelMotion (float)

virtual void	rightWheelFinish (void)

float	getRightWheelValue (void) const

void	setRightWheelValue (const float value)

void	setLeftWheelString (const char *const name)

Widget	getLeftWheelLabelWidget (void) const

void	setBottomWheelString (const char *const name)

Widget	getBottomWheelLabelWidget (void) const

void	setRightWheelString (const char *const name)

const char *	getRightWheelString () const

Widget	getRightWheelLabelWidget (void) const

virtual SbBool	processSoEvent (const SoEvent *const event)

Widget	buildFunctionsSubmenu (Widget popup)

Widget	buildDrawStyleSubmenu (Widget popup)

Protected Member Functions inherited from SoXtViewer
	SoXtViewer (Widget parent, const char *name, SbBool embed, Type type, SbBool build)

	~SoXtViewer ()

virtual void	sizeChanged (const SbVec2s &size)

virtual void	setSeekMode (SbBool enable)

SbBool	isSeekMode (void) const

SbBool	seekToPoint (const SbVec2s screenpos)

void	seekToPoint (const SbVec3f &scenepos)

virtual void	computeSeekFinalOrientation (void)

virtual void	actualRedraw (void)

virtual SbBool	processSoEvent (const SoEvent *const event)

void	interactiveCountInc (void)

void	interactiveCountDec (void)

int	getInteractiveCount (void) const

void	setSeekDistance (const float distance)

float	getSeekDistance (void) const

void	setSeekValueAsPercentage (const SbBool on)

SbBool	isSeekValuePercentage (void) const

virtual void	changeCameraValues (SoCamera *camera)

void	addSuperimposition (SoNode *scene)

void	removeSuperimposition (SoNode *scene)

void	setSuperimpositionEnabled (SoNode *scene, const SbBool enable)

SbBool	getSuperimpositionEnabled (SoNode *scene) const

Protected Member Functions inherited from SoXtRenderArea
	SoXtRenderArea (Widget parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build)

virtual void	redraw (void)

virtual void	actualRedraw (void)

virtual void	redrawOverlay (void)

virtual void	actualOverlayRedraw (void)

virtual SbBool	processSoEvent (const SoEvent *const event)

virtual void	processEvent (XAnyEvent *event)

virtual void	initGraphic (void)

virtual void	initOverlayGraphic (void)

virtual void	sizeChanged (const SbVec2s &size)

virtual void	widgetChanged (Widget widget)

virtual void	afterRealizeHook (void)

Widget	buildWidget (Widget parent)

virtual const char *	getDefaultWidgetName (void) const

virtual const char *	getDefaultTitle (void) const

virtual const char *	getDefaultIconTitle (void) const

virtual SbBool	glScheduleRedraw (void)

Protected Member Functions inherited from SoXtGLWidget
	SoXtGLWidget (Widget const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)

	~SoXtGLWidget ()

virtual void	processEvent (XAnyEvent *event)

Widget	buildWidget (Widget parent)

virtual void	redraw (void)=0

virtual void	redrawOverlay (void)

virtual void	initGraphic (void)

virtual void	initOverlayGraphic (void)

virtual void	sizeChanged (const SbVec2s &size)

virtual void	widgetChanged (Widget w)

void	setGLSize (const SbVec2s size)

SbVec2s	getGLSize (void) const

float	getGLAspectRatio (void) const

void	setGlxSize (const SbVec2s size)

SbVec2s	getGlxSize (void) const

float	getGlxAspectRatio (void) const

void	setStereoBuffer (SbBool flag)

SbBool	isStereoBuffer (void) const

SbBool	isRGBMode (void)

void	glLockNormal (void)

void	glUnlockNormal (void)

void	glLockOverlay (void)

void	glUnlockOverlay (void)

void	glSwapBuffers (void)

void	glFlushBuffer (void)

virtual SbBool	glScheduleRedraw (void)

int	getDisplayListShareGroup (GLXContext context)

Widget	getGlxMgrWidget (void)

Protected Member Functions inherited from SoXtComponent
	SoXtComponent (Widget const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)

virtual void	afterRealizeHook (void)

void	setClassName (const char *const name)

void	setBaseWidget (Widget widget)

void	registerWidget (Widget widget)

void	unregisterWidget (Widget widget)

virtual const char *	getDefaultWidgetName (void) const

virtual const char *	getDefaultTitle (void) const

virtual const char *	getDefaultIconTitle (void) const

virtual void	sizeChanged (const SbVec2s &size)

void	addVisibilityChangeCallback (SoXtComponentVisibilityCB const func, void const user=NULL)

void	removeVisibilityChangeCallback (SoXtComponentVisibilityCB const func, void const user=NULL)

void	invokeVisibilityChangeCallbacks (const SbBool enable) const

void	invokeWindowCloseCallbacks (void) const

virtual void	windowCloseAction (void)

Additional Inherited Members
Public Types inherited from SoXtFullViewer
enum	BuildFlag { BUILD_NONE = 0x00 , BUILD_DECORATION = 0x01 , BUILD_POPUP = 0x02 , BUILD_ALL = (BUILD_DECORATION \| BUILD_POPUP) }

Public Types inherited from SoXtViewer
enum	Type { BROWSER , EDITOR }

enum	DrawStyle { VIEW_AS_IS , VIEW_HIDDEN_LINE , VIEW_NO_TEXTURE , VIEW_LOW_COMPLEXITY , VIEW_LINE , VIEW_POINT , VIEW_BBOX , VIEW_LOW_RES_LINE , VIEW_LOW_RES_POINT , VIEW_SAME_AS_STILL , VIEW_WIREFRAME_OVERLAY }

enum	DrawType { STILL = 0 , INTERACTIVE }

enum	BufferType { BUFFER_SINGLE , BUFFER_DOUBLE , BUFFER_INTERACTIVE }

enum	AutoClippingStrategy { VARIABLE_NEAR_PLANE , CONSTANT_NEAR_PLANE }

enum	StereoType { STEREO_NONE , STEREO_ANAGLYPH , STEREO_QUADBUFFER , STEREO_INTERLEAVED_ROWS , STEREO_INTERLEAVED_COLUMNS }

Static Public Member Functions inherited from SoXtRenderArea
static uint32_t	getDefaultRedrawPriority (void)

Static Public Member Functions inherited from SoXtComponent
static void	setWidgetCursor (Widget w, const SoXtCursor &cursor)

static SoXtComponent *	getComponent (Widget widget)

static void	initClasses (void)

Static Public Member Functions inherited from SoXtObject
static void	initClass (void)

static SoType	getClassTypeId (void)

static void	init (void)

Static Protected Member Functions inherited from SoXtGLWidget
static void	eventHandler (Widget, SoXtGLWidget , XAnyEvent , Boolean *)

Protected Attributes inherited from SoXtFullViewer
Widget	leftWheel

Widget	rightWheel

Widget	bottomWheel

Widget	leftDecoration

Widget	rightDecoration

Widget	bottomDecoration

Widget	leftWheelLabel

char *	leftWheelStr

float	leftWheelVal

Widget	rightWheelLabel

char *	rightWheelStr

float	rightWheelVal

Widget	bottomWheelLabel

char *	bottomWheelStr

float	bottomWheelVal

SoXtPopupMenu *	prefmenu

char *	popupTitle

SbBool	popupEnabled

SbPList *	viewerButtonWidgets

Protected Attributes inherited from SoXtGLWidget
SbBool	waitForExpose

SbBool	drawToFrontBuffer

Protected Attributes inherited from SoXtComponent
SbBool	firstRealize

Detailed Description

The SoXtExaminerViewer class is a 3D-model examination viewer.

This class is the viewer considered to be the most "general purpose" viewer, and it is often used in rapid prototyping to examine simple models as well as complete scenes (although for the latter, you might be better off with one of the other viewer classes).

Here is a complete, stand-alone example that shows how to set up an SoXtExaminerViewer as a model viewer that loads Inventor and VRML files from disk and places them inside the viewer for the end-user to examine:

#include <Inventor/Xt/SoXt.h>
#include <Inventor/Xt/viewers/SoXtExaminerViewer.h>
#include <Inventor/nodes/SoBaseColor.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/nodes/SoSeparator.h>
 
int
main(int argc, char ** argv)
{
  if (argc < 2) {
    (void)fprintf(stderr, "\n\n\tUsage: %s <modelfilename>\n\n",
                  argc > 0 ? argv[0] : "viewerapp");
    exit(1);
  }
 
  // Initialize SoXt and Inventor API libraries. This returns a main
  // window to use.
  Widget mainwin = SoXt::init(argc, argv, argv[0]);
 
  // Open the argument file..
  SoInput in;
  SbBool ok = in.openFile(argv[1]);
  if (!ok) { exit(1); }
 
  // ..and import it.
  SoSeparator * root = SoDB::readAll(&in);
  if (root == NULL) { exit(1); }
  root->ref();
 
  // Use the ExaminerViewer, for a nice interface for 3D model
  // inspection.
  SoXtExaminerViewer * viewer = new SoXtExaminerViewer(mainwin);
  viewer->setSceneGraph(root);
  viewer->show();
 
  // Pop up the main window.
  SoXt::show(mainwin);
  // Loop until exit.
  SoXt::mainLoop();
 
  // Clean up resources.
  delete viewer;
  root->unref();
 
  return 0;
}

SoXtExaminerViewer has a convenient interface for repositioning and reorientation of the camera, by panning, rotating and zooming its position. The following controls can be used:

hold down left mouse button and move mouse pointer to rotate the camera around its current focal point (the focal point can be changed by doing a seek operation)
hold middle mouse button to pan (or a CTRL-key plus left mouse button, or a SHIFT-key plus left mouse button)
hold down left + middle mouse button to zoom / dolly, or CTRL + middle mouse button, or CTRL + SHIFT + the left mouse button
click 's', then pick with the left mouse button to seek
right mouse button opens the pop-up menu
click 'ESC' key to switch to and from 'camera interaction' mode and 'scene graph interaction' mode (see setViewing() documentation)
hold down the 'ALT' key to temporary toggle from camera-interaction mode to scene graph-interaction mode

The SoXtExaminerViewer provides a user decoration's button for toggling between orthographic or perspective camera view volumes and projection methods. This is the bottom-most click button on the right decoration border.

It also inherits the decoration buttons from the SoXtFullViewer: the arrow for switching to "scene graph interaction" mode, the hand for setting back to "camera interaction" mode, the house for "reset camera to home position", the blueprint house for "set new camera home position", the eye for "zoom camera out to view full scene" and the flashlight for setting "click to seek" mode.

Note that a common faulty assumption about all the viewer-classes is that user interaction (in the "examine"-mode, not the scene graph-interaction mode) influences the model or 3D-scene in the view. This is not correct, as it is always the viewer's camera that is translated and rotated.

The initial position of the camera is placed such that all of the scene graph's geometry fits within its view.

See also: SoXtFlyViewer, SoXtPlaneViewer

Constructor & Destructor Documentation

◆ SoXtExaminerViewer() [1/2]

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

Constructor. See parent class for explanation of arguments. Calling this constructor will make sure the examiner viewer widget will be built immediately.

Public constructor.

◆ ~SoXtExaminerViewer()

SoXtExaminerViewer::~SoXtExaminerViewer ( )

The destructor.

◆ SoXtExaminerViewer() [2/2]

SoXtExaminerViewer::SoXtExaminerViewer	(	Widget	parent,
		const char *	name,
		SbBool	embed,
		SoXtFullViewer::BuildFlag	flag,
		SoXtViewer::Type	type,
		SbBool	build
	)

protected

Constructor. See parent class for explanation of arguments.

Protected constructor for derived viewers.

Member Function Documentation

◆ setAnimationEnabled()

void SoXtExaminerViewer::setAnimationEnabled ( const SbBool enable )

Decide if it should be possible to start a spin animation of the model in the viewer by releasing the mouse button while dragging.

If the enable flag is FALSE and we're currently animating, the spin will be stopped.

See also: isAnimationEnabled

◆ isAnimationEnabled()

SbBool SoXtExaminerViewer::isAnimationEnabled ( void ) const

Query whether or not it is possible to start a spinning animation by releasing the left mouse button while dragging the mouse.

See also: setAnimationEnabled

◆ stopAnimating()

void SoXtExaminerViewer::stopAnimating ( void )

Stop the model from spinning.

◆ isAnimating()

SbBool SoXtExaminerViewer::isAnimating ( void ) const

Query if the model in the viewer is currently in spinning mode after a user drag.

◆ setFeedbackVisibility()

void SoXtExaminerViewer::setFeedbackVisibility ( const SbBool enable )

Set the flag deciding whether or not to show the axis cross.

See also: isFeedbackVisible, getFeedbackSize, setFeedbackSize

◆ isFeedbackVisible()

SbBool SoXtExaminerViewer::isFeedbackVisible ( void ) const

Check if the feedback axis cross is visible.

See also: setFeedbackVisibility, getFeedbackSize, setFeedbackSize

◆ setFeedbackSize()

void SoXtExaminerViewer::setFeedbackSize ( const int size )

Set the size of the feedback axis cross. The value is interpreted as an approximate percentage chunk of the dimensions of the total canvas.

See also: getFeedbackSize, isFeedbackVisible, setFeedbackVisibility

◆ getFeedbackSize()

int SoXtExaminerViewer::getFeedbackSize ( void ) const

Return the size of the feedback axis cross. Default is 25.

See also: setFeedbackSize, isFeedbackVisible, setFeedbackVisibility

◆ setViewing()

void SoXtExaminerViewer::setViewing ( SbBool enable )

virtual

Set view mode.

If the view mode is on, user events will be caught and used to influence the camera position / orientation. If view mode is off, all events in the viewer canvas (like for instance keypresses or mouse clicks and -movements) will be passed along to the scene graph.

Default is to have the view mode active.

See also: isViewing()

Reimplemented from SoXtFullViewer.

◆ setCamera()

void SoXtExaminerViewer::setCamera ( SoCamera * cam )

virtual

Set the camera we want the viewer to manipulate when interacting with the viewer controls.

The camera passed in as an argument to this method must already be part of the viewer's scene graph. You do not inject viewpoint cameras to the viewer with this method.

You should rather insert a camera into the scene graph first (if necessary, often one will be present already), then register it as the camera used by the viewer controls with this method.

If the application code doesn't explicitly set up a camera through this method, the viewer will automatically scan through the scene graph to find a camera to use. If no camera is available in the scene graph at all, it will set up its own camera.

See also: getCamera()

Reimplemented from SoXtViewer.

◆ setCursorEnabled()

void SoXtExaminerViewer::setCursorEnabled ( SbBool enable )

virtual

Decide whether or not the mouse pointer cursor should be visible in the rendering canvas.

Reimplemented from SoXtViewer.

◆ leftWheelMotion()

void SoXtExaminerViewer::leftWheelMotion ( float value )

protectedvirtual

Called repeatedly as the user drags the thumbwheel in the left frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: leftWheelStart(), leftWheelFinish(); bottomWheelStart(), rightWheelStart()

Reimplemented from SoXtFullViewer.

◆ bottomWheelMotion()

void SoXtExaminerViewer::bottomWheelMotion ( float value )

protectedvirtual

Called repeatedly as the user drags the thumbwheel in the bottom frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: bottomWheelStart(), bottomWheelFinish(); leftWheelStart(), rightWheelStart()

Reimplemented from SoXtFullViewer.

◆ rightWheelMotion()

void SoXtExaminerViewer::rightWheelMotion ( float value )

protectedvirtual

Called repeatedly as the user drags the thumbwheel in the right frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: rightWheelStart(), rightWheelFinish(); leftWheelStart(), bottomWheelStart()

Reimplemented from SoXtFullViewer.

◆ createViewerButtons()

void SoXtExaminerViewer::createViewerButtons	(	Widget	parent,
		SbPList *	buttonlist
	)

protectedvirtual

Set up the viewer buttons with pixmaps and event connections.

One important note if you want to override this method to add your own buttons to the list (in the explanation below, it is assumed that you know how virtual function table pointers are handled by C++):

createViewerButtons() is called (indirectly) from the constructors of the viewer classes. This means that you need to delay its invocation until your own subclass's constructor is run, because otherwise your re-implementation won't have been added to the internal virtual function table yet.

Delaying a superclass viewer from building its decorations is done by passing build==FALSE as the last argument of the protected constructors. You will then have to explicitly trigger the building in your own constructor.

Here's a minimal example that shows the steps needed to be able to override createViewerButtons() from SoXtExaminerViewer:

class MyExaminerViewer : public SoXtExaminerViewer {
 
public:
  MyExaminerViewer(Widget parent);
 
protected:
  virtual void createViewerButtons(Widget parent, SbPList * buttonlist);
};
 
MyExaminerViewer::MyExaminerViewer(Widget parent)
  : SoXtExaminerViewer(parent, NULL, TRUE,
                          SoXtFullViewer::BUILD_ALL, SoXtFullViewer::BROWSER,
                          // build == FALSE, to delay creation of decorations
                          FALSE)
{
  // Explicitly trigger the construction of viewer decorations.
  Widget widget = this->buildWidget(this->getParentWidget());
  this->setBaseWidget(widget);
}
 
void
MyExaminerViewer::createViewerButtons(Widget parent, SbPList * buttonlist)
{
  SoXtExaminerViewer::createViewerButtons(parent, buttonlist);
  // [now add your own button(s) to the buttonlist]
}

Reimplemented from SoXtFullViewer.

◆ getDefaultWidgetName()

const char * SoXtExaminerViewer::getDefaultWidgetName ( void ) const

protectedvirtual

This method returns the default name of a component widget class.

It should be overridden by derived non-abstract classes for the topmost widget in the component to have a proper name.

Reimplemented from SoXtRenderArea.

◆ getDefaultTitle()

const char * SoXtExaminerViewer::getDefaultTitle ( void ) const

protectedvirtual

This method returns the default window caption string of the component.

It should be overridden by derived non-abstract classes so the window and pop-up menu will get a proper title.

Reimplemented from SoXtRenderArea.

◆ getDefaultIconTitle()

const char * SoXtExaminerViewer::getDefaultIconTitle ( void ) const

protectedvirtual

This method returns the default icon title of the component.

It should be overridden by derived non-abstract classes so icons will get proper titles.

Reimplemented from SoXtRenderArea.

◆ processSoEvent()

SbBool SoXtExaminerViewer::processSoEvent ( const SoEvent *const event )

protectedvirtual

Toolkit-native events are tried to convert to Coin-generic events in the SoXtRenderArea::processEvent() method. If this succeeds, they are forwarded to this method.

This is a virtual method, and is overridden in its subclasses to catch events of particular interest to the viewer classes, for instance.

Return TRUE if the event was processed. If not it should be passed on further up in the inheritance hierarchy by the caller. This last point is extremely important to take note of if you are expanding the toolkit with your own viewer class.

This method is not part of the original SGI InventorXt API. Note that you can still override the toolkit-native processEvent() method instead of this "generic" method.

Reimplemented from SoXtFullViewer.

◆ setSeekMode()

void SoXtExaminerViewer::setSeekMode ( SbBool enable )

protectedvirtual

Put the viewer in or out of "waiting-to-seek" mode.

If the user performs a mouse button click when the viewer is in "waiting-to-seek" mode, the camera will be repositioned so the camera focal point lies on the point of the geometry under the mouse cursor.

See also: isSeekMode(), setDetailSeek()

Reimplemented from SoXtViewer.

◆ actualRedraw()

void SoXtExaminerViewer::actualRedraw ( void )

protectedvirtual

This method instantly redraws the normal (non-overlay) scene graph by calling SoSceneManager::render().

Subclasses may override this method to add their own rendering before or after Coin renders its scene graph.

The following is a complete example that demonstrates one way of adding both a background image and foreground (overlay) geometry to the "normal" rendering:

// This example shows how to put a permanent background image on
// your viewer canvas, below the 3D graphics, plus overlay
// foreground geometry.  Written by mortene.
// Copyright Kongsberg Oil & Gas Technologies 2002.
 
// *************************************************************************
 
#include <Inventor/Xt/SoXt.h>
#include <Inventor/Xt/viewers/SoXtExaminerViewer.h>
#include <Inventor/nodes/SoBaseColor.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/nodes/SoCube.h>
#include <Inventor/nodes/SoImage.h>
#include <Inventor/nodes/SoLightModel.h>
#include <Inventor/nodes/SoOrthographicCamera.h>
#include <Inventor/nodes/SoRotationXYZ.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoTranslation.h>
 
#include <GL/gl.h>
 
// *************************************************************************
 
class MyExaminerViewer : public SoXtExaminerViewer {
 
public:
  MyExaminerViewer(Widget parent, const char * filename);
  ~MyExaminerViewer();
 
protected:
  virtual void actualRedraw(void);
 
private:
  SoSeparator * bckgroundroot;
  SoSeparator * foregroundroot;
  SoRotationXYZ * arrowrotation;
};
 
MyExaminerViewer::MyExaminerViewer(Widget parent, const char * filename)
  : SoXtExaminerViewer(parent)
{
  // Coin should not clear the pixel-buffer, so the background image
  // is not removed.
  this->setClearBeforeRender(FALSE, TRUE);
 
 
  // Set up background scene graph with image in it.
 
  this->bckgroundroot = new SoSeparator;
  this->bckgroundroot->ref();
 
  SoOrthographicCamera * cam = new SoOrthographicCamera;
  cam->position = SbVec3f(0, 0, 1);
  cam->height = 1;
  // SoImage will be at z==0.0.
  cam->nearDistance = 0.5;
  cam->farDistance = 1.5;
 
  SoImage * img = new SoImage;
  img->vertAlignment = SoImage::HALF;
  img->horAlignment = SoImage::CENTER;
  img->filename = filename;
 
  this->bckgroundroot->addChild(cam);
  this->bckgroundroot->addChild(img);
 
  // Set up foreground, overlaid scene graph.
 
  this->foregroundroot = new SoSeparator;
  this->foregroundroot->ref();
 
  SoLightModel * lm = new SoLightModel;
  lm->model = SoLightModel::BASE_COLOR;
 
  SoBaseColor * bc = new SoBaseColor;
  bc->rgb = SbColor(1, 1, 0);
 
  cam = new SoOrthographicCamera;
  cam->position = SbVec3f(0, 0, 5);
  cam->height = 10;
  cam->nearDistance = 0;
  cam->farDistance = 10;
 
  const double ARROWSIZE = 2.0;
 
  SoTranslation * posit = new SoTranslation;
  posit->translation = SbVec3f(-2.5 * ARROWSIZE, 1.5 * ARROWSIZE, 0);
 
  arrowrotation = new SoRotationXYZ;
  arrowrotation->axis = SoRotationXYZ::Z;
 
  SoTranslation * offset = new SoTranslation;
  offset->translation = SbVec3f(ARROWSIZE/2.0, 0, 0);
 
  SoCube * cube = new SoCube;
  cube->width = ARROWSIZE;
  cube->height = ARROWSIZE/15.0;
 
  this->foregroundroot->addChild(cam);
  this->foregroundroot->addChild(lm);
  this->foregroundroot->addChild(bc);
  this->foregroundroot->addChild(posit);
  this->foregroundroot->addChild(arrowrotation);
  this->foregroundroot->addChild(offset);
  this->foregroundroot->addChild(cube);
}
 
MyExaminerViewer::~MyExaminerViewer()
{
  this->bckgroundroot->unref();
  this->foregroundroot->unref();
}
 
void
MyExaminerViewer::actualRedraw(void)
{
  // Must set up the OpenGL viewport manually, as upon resize
  // operations, Coin won't set it up until the SoGLRenderAction is
  // applied again. And since we need to do glClear() before applying
  // the action..
  const SbViewportRegion vp = this->getViewportRegion();
  SbVec2s origin = vp.getViewportOriginPixels();
  SbVec2s size = vp.getViewportSizePixels();
  glViewport(origin[0], origin[1], size[0], size[1]);
 
  const SbColor col = this->getBackgroundColor();
  glClearColor(col[0], col[1], col[2], 0.0f);
  glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
 
  // Render our scene graph with the image.
  SoGLRenderAction * glra = this->getGLRenderAction();
  glra->apply(this->bckgroundroot);
 
 
  // Render normal scene graph.
  SoXtExaminerViewer::actualRedraw();
 
 
  // Increase arrow angle with 1/1000 degrees every frame.
  arrowrotation->angle = arrowrotation->angle.getValue() + (0.001 / M_PI * 180);
  // Render overlay front scene graph.
  glClear(GL_DEPTH_BUFFER_BIT);
  glra->apply(this->foregroundroot);
}
 
// *************************************************************************
 
int
main(int argc, char ** argv)
{
  if (argc != 2) {
    (void)fprintf(stderr, "\n\n\tUsage: %s <image-filename>\n\n", argv[0]);
    exit(1);
  }
 
  Widget window = SoXt::init(argv[0]);
 
  MyExaminerViewer * viewer = new MyExaminerViewer(window, argv[1]);
 
  viewer->setSceneGraph(new SoCone);
  viewer->show();
 
  SoXt::show(window);
  SoXt::mainLoop();
 
  delete viewer;
  return 0;
}
 
// *************************************************************************

Reimplemented from SoXtViewer.

◆ afterRealizeHook()

void SoXtExaminerViewer::afterRealizeHook ( void )

protectedvirtual

A function "hook" / callback invoked just after the window for the component has been realized.

Override this if you need specific initialization for your own component or viewer class to happen right after it has been made visible, but remember to call upwards in the inheritance hierarchy:

void
MyLittleViewer::afterRealizeHook(void)
{
  <superclass>::afterRealizeHook();
  // [own initialization here]
}

Reimplemented from SoXtRenderArea.

The documentation for this class was generated from the following files:

SoXtExaminerViewer.h
SoXtExaminerViewer.cpp
ExaminerViewer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoXtExaminerViewer() [1/2]

◆ ~SoXtExaminerViewer()

◆ SoXtExaminerViewer() [2/2]

Member Function Documentation

◆ setAnimationEnabled()

◆ isAnimationEnabled()

◆ stopAnimating()

◆ isAnimating()

◆ setFeedbackVisibility()

◆ isFeedbackVisible()

◆ setFeedbackSize()

◆ getFeedbackSize()

◆ setViewing()

◆ setCamera()

◆ setCursorEnabled()

◆ leftWheelMotion()

◆ bottomWheelMotion()

◆ rightWheelMotion()

◆ createViewerButtons()

◆ getDefaultWidgetName()

◆ getDefaultTitle()

◆ getDefaultIconTitle()

◆ processSoEvent()

◆ setSeekMode()

◆ actualRedraw()

◆ afterRealizeHook()