The SoXtConstrainedViewer class is the superclass for viewers with constrains on the viewpoint. More...

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

Inheritance diagram for SoXtConstrainedViewer:

Public Member Functions
const SbVec3f &	getUpDirection (void) const

virtual void	resetToHomePosition (void)

virtual void	saveHomePosition (void)

virtual void	setCamera (SoCamera *newcam)

void	setUpDirection (const SbVec3f &dir)

Public Member Functions inherited from SoXtFullViewer
void	addAppPushButton (Widget newButton)

int	findAppPushButton (Widget oldButton) const

Widget	getAppPushButtonParent (void) const

Widget	getRenderAreaWidget (void) const

void	insertAppPushButton (Widget newButton, int index)

SbBool	isDecoration (void) const

SbBool	isPopupMenuEnabled (void) const

int	lengthAppPushButton (void) const

void	removeAppPushButton (Widget oldButton)

virtual void	setComponentCursor (const SoXtCursor &cursor)

void	setDecoration (const SbBool on)

void	setPopupMenuEnabled (const SbBool on)

virtual void	setViewing (SbBool on)

Public Member Functions inherited from SoXtViewer
void	addFinishCallback (SoXtViewerCB func, void data=NULL)

void	addStartCallback (SoXtViewerCB func, void data=NULL)

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

SoXtViewer::BufferType	getBufferingType (void) const

SoCamera *	getCamera (void) const

SoType	getCameraType (void) const

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

SoDirectionalLight *	getHeadlight (void) const

virtual SoNode *	getSceneGraph (void)

float	getSeekTime (void) const

float	getStereoOffset (void) const

SoXtViewer::StereoType	getStereoType (void) const

const SbColor &	getWireframeOverlayColor (void) const

SbBool	isAutoClipping (void) const

SbBool	isCursorEnabled (void) const

SbBool	isDetailSeek (void) const

SbBool	isHeadlight (void) const

SbBool	isStereoViewing (void) const

SbBool	isViewing (void) const

void	removeFinishCallback (SoXtViewerCB func, void data=NULL)

void	removeStartCallback (SoXtViewerCB func, void data=NULL)

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

void	setAutoClipping (SbBool enable)

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

virtual void	setBufferingType (SoXtViewer::BufferType type)

virtual void	setCameraType (SoType type)

virtual void	setCursorEnabled (SbBool enable)

void	setDetailSeek (const SbBool enable)

virtual void	setDoubleBuffer (const SbBool enable)

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

virtual void	setHeadlight (SbBool enable)

virtual void	setSceneGraph (SoNode *root)

void	setSeekTime (const float seconds)

virtual void	setStereoOffset (const float dist)

SbBool	setStereoType (SoXtViewer::StereoType s)

virtual void	setStereoViewing (SbBool enable)

void	setWireframeOverlayColor (const SbColor &color)

virtual void	toggleCameraType (void)

virtual void	viewAll (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 ()

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

const SbColor &	getBackgroundColor (void) const

int	getBackgroundIndex (void) const

SoGLRenderAction *	getGLRenderAction (void) const

int	getOverlayBackgroundIndex (void) const

SoGLRenderAction *	getOverlayGLRenderAction (void) const

SoNode *	getOverlaySceneGraph (void)

SoSceneManager *	getOverlaySceneManager (void) const

uint32_t	getRedrawPriority (void) const

SoSceneManager *	getSceneManager (void) const

SoGLRenderAction::TransparencyType	getTransparencyType (void) const

const SbViewportRegion &	getViewportRegion (void) const

SbBool	isAutoRedraw (void) const

SbBool	isClearBeforeOverlayRender (void) const

SbBool	isClearBeforeRender (void) const

SbBool	isClearZBufferBeforeRender (void) const

void	redrawOnSelectionChange (SoSelection *selection)

void	redrawOverlayOnSelectionChange (SoSelection *selection)

void	registerDevice (SoXtDevice *device)

void	render (void)

void	renderOverlay (void)

void	scheduleOverlayRedraw (void)

void	scheduleRedraw (void)

SbBool	sendSoEvent (const SoEvent *event)

void	setAntialiasing (SbBool smoothing, int numPasses)

void	setAutoRedraw (SbBool enable)

void	setBackgroundColor (const SbColor &color)

void	setBackgroundIndex (int idx)

void	setClearBeforeOverlayRender (SbBool enable)

void	setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE)

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

void	setEventCallback (SoXtRenderAreaEventCB func, void user=NULL)

void	setGLRenderAction (SoGLRenderAction *action)

void	setOverlayBackgroundIndex (int idx)

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

void	setOverlayGLRenderAction (SoGLRenderAction *action)

void	setOverlaySceneGraph (SoNode *scene)

void	setOverlaySceneManager (SoSceneManager *manager)

void	setRedrawPriority (uint32_t priority)

void	setSceneManager (SoSceneManager *manager)

void	setTransparencyType (SoGLRenderAction::TransparencyType type)

void	setViewportRegion (const SbViewportRegion &newRegion)

void	unregisterDevice (SoXtDevice *device)

Public Member Functions inherited from SoXtGLWidget
SbBool	getAccumulationBuffer (void) const

SbBool	getAlphaChannel (void) const

int	getColorMapSize (void)

Widget	getGLWidget (void) const

void	getLineWidthLimits (SbVec2f &range, float &granularity)

GLXContext	getNormalContext (void)

XVisualInfo *	getNormalVisual (void)

Widget	getNormalWidget (void) const

Window	getNormalWindow (void)

int	getOverlayColorMapSize (void)

GLXContext	getOverlayContext (void)

unsigned long	getOverlayTransparentPixel (void)

XVisualInfo *	getOverlayVisual (void)

Widget	getOverlayWidget (void) const

Window	getOverlayWindow (void)

void	getPointSizeLimits (SbVec2f &range, float &granularity)

int	getSampleBuffers (void) const

SbBool	getStencilBuffer (void) const

SbBool	hasNormalGLArea (void) const

SbBool	hasOverlayGLArea (void) const

SbBool	isBorder (void) const

SbBool	isDoubleBuffer (void) const

SbBool	isDrawToFrontBufferEnable (void) const

SbBool	isOverlayRender (void) const

SbBool	isQuadBufferStereo (void) const

SbBool	isStealFocus (void) const

void	setAccumulationBuffer (const SbBool enable)

void	setAlphaChannel (const SbBool enable)

void	setBorder (const SbBool enable)

void	setDrawToFrontBufferEnable (const SbBool enable)

virtual void	setNormalVisual (XVisualInfo *visual)

void	setOverlayRender (const SbBool onoff)

virtual void	setOverlayVisual (XVisualInfo *visual)

void	setQuadBufferStereo (const SbBool enable)

void	setSampleBuffers (const int numsamples)

void	setStealFocus (SbBool enable)

void	setStencilBuffer (const SbBool enable)

Public Member Functions inherited from SoXtComponent
virtual	~SoXtComponent ()

void	addWindowCloseCallback (SoXtComponentCB callback, void closure=NULL)

void	fitSize (const SbVec2s size)

Widget	getBaseWidget (void) const

const char *	getClassName (void) const

Display *	getDisplay (void)

const char *	getIconTitle (void) const

Widget	getParentWidget (void) const

Widget	getShellWidget (void) const

SbVec2s	getSize (void) const

const char *	getTitle (void) const

Widget	getWidget (void) const

const char *	getWidgetName (void) const

virtual void	hide (void)

SbBool	isFullScreen (void) const

SbBool	isTopLevelShell (void) const

SbBool	isVisible (void)

void	removeWindowCloseCallback (SoXtComponentCB callback, void closure=NULL)

SbBool	setFullScreen (const SbBool onoff)

void	setIconTitle (const char *const title)

void	setSize (const SbVec2s size)

void	setTitle (const char *const title)

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

virtual void	show (void)

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

SbBool	isOfType (SoType type) const

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

	~SoXtConstrainedViewer ()

virtual void	bottomWheelMotion (float value)

virtual void	changeCameraValues (SoCamera *camera)

void	checkForCameraUpConstrain (void)

void	findUpDirection (SbVec2s mouselocation)

virtual void	leftWheelMotion (float value)

virtual void	tiltCamera (float delta)

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

	~SoXtFullViewer ()

virtual void	bottomWheelFinish (void)

virtual void	bottomWheelStart (void)

Widget	buildAppButtons (Widget parent)

virtual Widget	buildBottomTrim (Widget parent)

virtual void	buildDecoration (Widget parent)

Widget	buildDrawStyleSubmenu (Widget popup)

Widget	buildFunctionsSubmenu (Widget popup)

virtual Widget	buildLeftTrim (Widget parent)

virtual void	buildPopupMenu (void)

virtual Widget	buildRightTrim (Widget parent)

Widget	buildViewerButtons (Widget parent)

Widget	buildWidget (Widget parent)

virtual void	createViewerButtons (Widget parent, SbPList *buttonlist)

Widget	getBottomWheelLabelWidget (void) const

float	getBottomWheelValue (void) const

Widget	getLeftWheelLabelWidget (void) const

float	getLeftWheelValue (void) const

Widget	getRightWheelLabelWidget (void) const

const char *	getRightWheelString () const

float	getRightWheelValue (void) const

virtual void	leftWheelFinish (void)

virtual void	leftWheelStart (void)

virtual void	openPopupMenu (const SbVec2s position)

virtual SbBool	processSoEvent (const SoEvent *const event)

virtual void	rightWheelFinish (void)

virtual void	rightWheelMotion (float)

virtual void	rightWheelStart (void)

void	setBottomWheelString (const char *const name)

void	setBottomWheelValue (const float value)

void	setLeftWheelString (const char *const name)

void	setLeftWheelValue (const float value)

virtual void	setPopupMenuString (const char *title)

void	setRightWheelString (const char *const name)

void	setRightWheelValue (const float value)

virtual void	sizeChanged (const SbVec2s &size)

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

	~SoXtViewer ()

virtual void	actualRedraw (void)

void	addSuperimposition (SoNode *scene)

virtual void	computeSeekFinalOrientation (void)

int	getInteractiveCount (void) const

float	getSeekDistance (void) const

SbBool	getSuperimpositionEnabled (SoNode *scene) const

void	interactiveCountDec (void)

void	interactiveCountInc (void)

SbBool	isSeekMode (void) const

SbBool	isSeekValuePercentage (void) const

void	removeSuperimposition (SoNode *scene)

SbBool	seekToPoint (const SbVec2s screenpos)

void	seekToPoint (const SbVec3f &scenepos)

void	setSeekDistance (const float distance)

virtual void	setSeekMode (SbBool enable)

void	setSeekValueAsPercentage (const SbBool on)

void	setSuperimpositionEnabled (SoNode *scene, const SbBool enable)

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

virtual void	actualOverlayRedraw (void)

virtual void	afterRealizeHook (void)

Widget	buildWidget (Widget parent)

virtual const char *	getDefaultIconTitle (void) const

virtual const char *	getDefaultTitle (void) const

virtual const char *	getDefaultWidgetName (void) const

virtual SbBool	glScheduleRedraw (void)

virtual void	initGraphic (void)

virtual void	initOverlayGraphic (void)

virtual void	processEvent (XAnyEvent *event)

virtual void	redraw (void)

virtual void	redrawOverlay (void)

virtual void	widgetChanged (Widget widget)

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 ()

Widget	buildWidget (Widget parent)

int	getDisplayListShareGroup (GLXContext context)

float	getGLAspectRatio (void) const

SbVec2s	getGLSize (void) const

float	getGlxAspectRatio (void) const

Widget	getGlxMgrWidget (void)

SbVec2s	getGlxSize (void) const

void	glFlushBuffer (void)

void	glLockNormal (void)

void	glLockOverlay (void)

void	glSwapBuffers (void)

void	glUnlockNormal (void)

void	glUnlockOverlay (void)

SbBool	isRGBMode (void)

SbBool	isStereoBuffer (void) const

void	setGLSize (const SbVec2s size)

void	setGlxSize (const SbVec2s size)

void	setStereoBuffer (SbBool flag)

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

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

void	invokeVisibilityChangeCallbacks (const SbBool enable) const

void	invokeWindowCloseCallbacks (void) const

void	registerWidget (Widget widget)

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

void	setBaseWidget (Widget widget)

void	setClassName (const char *const name)

void	unregisterWidget (Widget widget)

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	AutoClippingStrategy { VARIABLE_NEAR_PLANE , CONSTANT_NEAR_PLANE }

enum	BufferType { BUFFER_SINGLE , BUFFER_DOUBLE , BUFFER_INTERACTIVE }

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	StereoType { STEREO_NONE , STEREO_ANAGLYPH , STEREO_QUADBUFFER , STEREO_INTERLEAVED_ROWS , STEREO_INTERLEAVED_COLUMNS }

enum	Type { BROWSER , EDITOR }

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

Static Public Member Functions inherited from SoXtComponent
static SoXtComponent *	getComponent (Widget widget)

static void	initClasses (void)

static void	setWidgetCursor (Widget w, const SoXtCursor &cursor)

Static Public Member Functions inherited from SoXtObject
static SoType	getClassTypeId (void)

static void	init (void)

static void	initClass (void)

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

Protected Attributes inherited from SoXtFullViewer
Widget	bottomDecoration

Widget	bottomWheel

Widget	bottomWheelLabel

char *	bottomWheelStr

float	bottomWheelVal

Widget	leftDecoration

Widget	leftWheel

Widget	leftWheelLabel

char *	leftWheelStr

float	leftWheelVal

SbBool	popupEnabled

char *	popupTitle

SoXtPopupMenu *	prefmenu

Widget	rightDecoration

Widget	rightWheel

Widget	rightWheelLabel

char *	rightWheelStr

float	rightWheelVal

SbPList *	viewerButtonWidgets

Protected Attributes inherited from SoXtGLWidget
SbBool	drawToFrontBuffer

SbBool	waitForExpose

Protected Attributes inherited from SoXtComponent
SbBool	firstRealize

Detailed Description

The SoXtConstrainedViewer class is the superclass for viewers with constrains on the viewpoint.

This abstract viewer class adds new methods to keep the camera in an upright position according to some arbitrary up-direction. The up-direction can be decided by either the application programmer (by using SoXtConstrainedViewer::setUpDirection()) or the end-user, through interaction mechanisms defined by the subclasses.

Constructor & Destructor Documentation

◆ SoXtConstrainedViewer()

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

protected

Constructor.

◆ ~SoXtConstrainedViewer()

SoXtConstrainedViewer::~SoXtConstrainedViewer ( )

protected

Virtual destructor.

Member Function Documentation

◆ bottomWheelMotion()

void SoXtConstrainedViewer::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.

◆ changeCameraValues()

void SoXtConstrainedViewer::changeCameraValues ( SoCamera * camera )

protectedvirtual

Copies the settings of camera into our current camera. Cameras must be of the same class type.

Reimplemented from SoXtViewer.

◆ checkForCameraUpConstrain()

void SoXtConstrainedViewer::checkForCameraUpConstrain ( void )

protected

If necessary, "tilts" the camera sideways so the up-direction is heeded.

◆ findUpDirection()

void SoXtConstrainedViewer::findUpDirection ( SbVec2s mouselocation )

protected

Executes a ray pick at the given mouse pointer location and sets the viewer's camera up-vector direction to the normal vector of the picked geometry.

◆ getUpDirection()

const SbVec3f & SoXtConstrainedViewer::getUpDirection ( void ) const

Return up-direction vector for the camera viewpoint.

◆ leftWheelMotion()

void SoXtConstrainedViewer::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.

◆ resetToHomePosition()

void SoXtConstrainedViewer::resetToHomePosition ( void )

virtual

Restore the saved camera settings.

See also: saveHomePosition()

Reimplemented from SoXtViewer.

Reimplemented in SoXtFlyViewer.

◆ saveHomePosition()

void SoXtConstrainedViewer::saveHomePosition ( void )

virtual

Store the current camera settings for later retrieval with resetToHomePosition().

See also: resetToHomePosition()

Reimplemented from SoXtViewer.

◆ setCamera()

void SoXtConstrainedViewer::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.

Reimplemented in SoXtFlyViewer.

◆ setUpDirection()

void SoXtConstrainedViewer::setUpDirection ( const SbVec3f & dir )

Set up-direction vector for the camera viewpoint.

◆ tiltCamera()

void SoXtConstrainedViewer::tiltCamera ( float delta )

protectedvirtual

This method tilts the camera delta degrees closer to the up direction.

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

SoXtConstrainedViewer.h
SoXtConstrainedViewer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoXtConstrainedViewer()

◆ ~SoXtConstrainedViewer()

Member Function Documentation

◆ bottomWheelMotion()

◆ changeCameraValues()

◆ checkForCameraUpConstrain()

◆ findUpDirection()

◆ getUpDirection()

◆ leftWheelMotion()

◆ resetToHomePosition()

◆ saveHomePosition()

◆ setCamera()

◆ setUpDirection()

◆ tiltCamera()