The SoXtFullViewer class adds some user interface components to the viewer canvas. More...

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

Inheritance diagram for SoXtFullViewer:

Public Types
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 }

Public Member Functions
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)

virtual void	resetToHomePosition (void)

virtual void	saveHomePosition (void)

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	setCamera (SoCamera *camera)

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
	SoXtFullViewer (Widget parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)

	~SoXtFullViewer ()

virtual void	bottomWheelFinish (void)

virtual void	bottomWheelMotion (float)

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

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	changeCameraValues (SoCamera *camera)

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)

Protected Attributes
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

Additional Inherited Members
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 *)

Detailed Description

The SoXtFullViewer class adds some user interface components to the viewer canvas.

The SoXtFullViewer is an abstract viewer class which extends its superclass (the basic SoXtViewer class) with two major user interface additions:

decorations around the render canvas, with buttons and thumbwheels to control camera interaction and various other aspects of model / scene viewing
a pop-up menu, invoked with the right mouse button, which controls yet more aspects of the rendering and the viewer

The user interface features listed above are the common parts of the user interfaces of the SoXtFullViewer's non-abstract subclasses.

For "real" application programs, the viewers / components from this class onwards and further down in the inheritance hierarchy is usually not all that interesting, as they enforces too much extra user interface cruft not compatible with the look and feel of the other parts of the application user interface. So most "real" applications will use either the SoXtViewer or the SoXtRenderArea as their base-level component, and then inherit one of these down into one's own "proper" viewer classes.

The non-abstract subclasses of the SoXtFullViewer class are viewer components often used as a test-bed for prototyping / rapid application development when doing quick testing of scenes, stand-alone 3D-models, animation techniques, etc.

See also: SoXtConstrainedViewer, SoXtExaminerViewer, SoXtPlaneViewer

Member Enumeration Documentation

◆ BuildFlag

enum SoXtFullViewer::BuildFlag

Valid values for the constructor argument that decides how much of the user interface features to set up. The enum values are bitflags that can be OR'ed together.

Flags for building various parts of the viewer.

Enumerator
BUILD_NONE	Do not add any of the user interface components.
BUILD_DECORATION	Only build and set up the decorations around the OpenGL canvas.
BUILD_POPUP	Only build the pop-up menu. (Activated with the right mouse button.)
BUILD_ALL	Build all user interface components of the SoXtFullViewer.

Constructor & Destructor Documentation

◆ SoXtFullViewer()

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

protected

Constructor. See parent class for explanation of arguments.

Subclasses will probably usually call with the buildNow flag set to FALSE to be able to do delayed building of the OpenGL canvas after other setup tasks has been performed.

Constructor.

◆ ~SoXtFullViewer()

SoXtFullViewer::~SoXtFullViewer ( )

protected

Destructor.

The destructor.

Member Function Documentation

◆ addAppPushButton()

void SoXtFullViewer::addAppPushButton ( Widget button )

Add an application specific push button to the viewer decorations. Application buttons will be laid out in a vertical row from the upper left corner.

The button will be added bottom-most.

See also: insertAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

Not implemented.

Each button will be set to 30x30 pixels, and they will appear on the left viewer decoration.

◆ bottomWheelFinish()

void SoXtFullViewer::bottomWheelFinish ( void )

protectedvirtual

Called as the user let go of the thumbwheel in the bottom frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ bottomWheelMotion()

void SoXtFullViewer::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 in SoXtExaminerViewer, SoXtConstrainedViewer, and SoXtPlaneViewer.

◆ bottomWheelStart()

void SoXtFullViewer::bottomWheelStart ( void )

protectedvirtual

Called when the user starts to drag the thumbwheel in the bottom frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ buildAppButtons()

Widget SoXtFullViewer::buildAppButtons ( Widget parent )

protected

Build the application specified button row (if any buttons were set up).

◆ buildBottomTrim()

Widget SoXtFullViewer::buildBottomTrim ( Widget parent )

protectedvirtual

Build decorations on the bottom of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

This method created the bottom decoration form.

Return value is a Motif widget of the xmFormWidgetClass type. It is 30 pixels high.

◆ buildDecoration()

void SoXtFullViewer::buildDecoration ( Widget parent )

protectedvirtual

Build viewer decorations.

FIXME: write doc

◆ buildDrawStyleSubmenu()

Widget SoXtFullViewer::buildDrawStyleSubmenu ( Widget popup )

protected

FIXME: write doc

◆ buildFunctionsSubmenu()

Widget SoXtFullViewer::buildFunctionsSubmenu ( Widget popup )

protected

FIXME: write doc

◆ buildLeftTrim()

Widget SoXtFullViewer::buildLeftTrim ( Widget parent )

protectedvirtual

Build decorations on the left of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

The decoration will be 30 pixels wide.

This method creates the left decoration form.

Return value is a Motif widget of the xmFormWidgetClass type. The left decoration is 30 pixels wide.

◆ buildPopupMenu()

void SoXtFullViewer::buildPopupMenu ( void )

protectedvirtual

Make a pop-up menu with preferences settings.

One important note as for when you want to override this function in a subclass: be aware that it will usually be invoked (indirectly) from this class's constructor. That is before the table of virtual function pointers has been set up for the subclass, and because of this, the function will not be called in the subclass even though it is virtual.

To make the overriding actually be in effect, you need to delay building the widgets of this class. For information on how to do that, see the documentation of SoXtFullViewer::createViewerButtons().

FIXME: write doc

◆ buildRightTrim()

Widget SoXtFullViewer::buildRightTrim ( Widget parent )

protectedvirtual

Build decorations on the right side of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

This method creates the right decoration form.

Returned value is a Motif widget of the xmFormWidgetClass type. The form is 30 pixels wide.

◆ buildViewerButtons()

Widget SoXtFullViewer::buildViewerButtons ( Widget parent )

protected

Build and layout viewer specified button row.

FIXME: write doc

◆ createViewerButtons()

void SoXtFullViewer::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 in SoXtExaminerViewer, and SoXtPlaneViewer.

◆ findAppPushButton()

int SoXtFullViewer::findAppPushButton ( Widget button ) const

Return the index of a particular button that has been specified by the application, or -1 of the button has not been added.

See also: addAppPushButton()

FIXME: write doc

◆ getAppPushButtonParent()

Widget SoXtFullViewer::getAppPushButtonParent ( void ) const

Returns the widget which is used as the parent of application specified buttons. The row of application buttons (if any) will be placed in the upper left corner.

See also: addAppPushButton(), insertAppPushButton(), removeAppPushButton()

Return value is either NULL or a widget of type xmFormWidgetClass (Xm/Form.h)

AppPushButtons are on the left decoration.

◆ getBottomWheelLabelWidget()

Widget SoXtFullViewer::getBottomWheelLabelWidget ( void ) const

protected

This method returns the native widget for the label beside the bottom thumb wheel.

◆ getBottomWheelValue()

float SoXtFullViewer::getBottomWheelValue ( void ) const

protected

Get current value of the bottom thumbwheel.

See also: bottomWheelMotion()

◆ getLeftWheelLabelWidget()

Widget SoXtFullViewer::getLeftWheelLabelWidget ( void ) const

protected

This method returns the native widget for the label below the left thumb wheel.

◆ getLeftWheelValue()

float SoXtFullViewer::getLeftWheelValue ( void ) const

protected

Get current value of the left thumbwheel.

See also: leftWheelMotion()

◆ getRenderAreaWidget()

Widget SoXtFullViewer::getRenderAreaWidget ( void ) const

Returns the render area OpenGL canvas widget.

FIXME: write doc

◆ getRightWheelLabelWidget()

Widget SoXtFullViewer::getRightWheelLabelWidget ( void ) const

protected

This method returns the native widget for the label below the right thumb wheel.

◆ getRightWheelValue()

float SoXtFullViewer::getRightWheelValue ( void ) const

protected

Get current value of the right thumbwheel.

See also: rightWheelMotion()

◆ insertAppPushButton()

void SoXtFullViewer::insertAppPushButton	(	Widget	button,
		int	idx )

Insert an application specific push button to the viewer decorations at the given index.

See also: addAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

FIXME: write doc

◆ isDecoration()

SbBool SoXtFullViewer::isDecoration ( void ) const

Return TRUE if the viewer decorations are on, otherwise FALSE.

See also: setDecoration()

This method returns whether the decorations are shown or not.

◆ isPopupMenuEnabled()

SbBool SoXtFullViewer::isPopupMenuEnabled ( void ) const

Return TRUE if the pop-up preferences menu is enabled, otherwise FALSE.

See also: setPopupMenuEnabled()

This method returns whether the pop-up menu is enabled or not.

◆ leftWheelFinish()

void SoXtFullViewer::leftWheelFinish ( void )

protectedvirtual

Called as the user let go of the thumbwheel in the left frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ leftWheelMotion()

void SoXtFullViewer::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 in SoXtExaminerViewer, SoXtConstrainedViewer, and SoXtPlaneViewer.

◆ leftWheelStart()

void SoXtFullViewer::leftWheelStart ( void )

protectedvirtual

Called when the user starts to drag the thumbwheel in the left frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ lengthAppPushButton()

int SoXtFullViewer::lengthAppPushButton ( void ) const

Return number of application specific buttons added.

See also: addAppPushButton(), insertAddAppPushButton()

FIXME: write doc

◆ openPopupMenu()

void SoXtFullViewer::openPopupMenu ( const SbVec2s position )

protectedvirtual

NOTE: This method is not part of the original InventorXt API.

FIXME: write doc

◆ processSoEvent()

SbBool SoXtFullViewer::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 SoXtViewer.

Reimplemented in SoXtExaminerViewer, SoXtFlyViewer, and SoXtPlaneViewer.

◆ removeAppPushButton()

void SoXtFullViewer::removeAppPushButton ( Widget button )

Remove one of the application specific buttons.

See also: addAppPushButton(), insertAppPushButton()

FIXME: write doc

◆ rightWheelFinish()

void SoXtFullViewer::rightWheelFinish ( void )

protectedvirtual

Called as the user let go of the thumbwheel in the right frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ rightWheelMotion()

void SoXtFullViewer::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 in SoXtExaminerViewer, SoXtFlyViewer, and SoXtPlaneViewer.

◆ rightWheelStart()

void SoXtFullViewer::rightWheelStart ( void )

protectedvirtual

Called when the user starts to drag the thumbwheel in the right frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

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

Reimplemented in SoXtPlaneViewer.

◆ setBottomWheelString()

void SoXtFullViewer::setBottomWheelString ( const char *const string )

protected

Set label of the bottom thumbwheel.

This method sets the label text that is displayed to the left of the bottom decoration thumbwheel.

◆ setBottomWheelValue()

void SoXtFullViewer::setBottomWheelValue ( const float value )

protected

Set a new value for the bottom thumbwheel.

◆ setComponentCursor()

void SoXtFullViewer::setComponentCursor ( const SoXtCursor & cursor )

virtual

Sets the cursor for this component.

Note: not part of the original SGI InventorXt API.

Sets the cursor for this component.

Reimplemented from SoXtComponent.

◆ setDecoration()

void SoXtFullViewer::setDecoration ( const SbBool enable )

Turn the viewer decorations on or off.

See also: isDecoration()

This method sets whether the decorations should be shown or not.

◆ setLeftWheelString()

void SoXtFullViewer::setLeftWheelString ( const char *const string )

protected

Set label of the left thumbwheel.

This method sets the label text displayed below the thumbwheel on the left decoration.

◆ setLeftWheelValue()

void SoXtFullViewer::setLeftWheelValue ( const float value )

protected

Set a new value for the left thumbwheel.

◆ setPopupMenuEnabled()

void SoXtFullViewer::setPopupMenuEnabled ( const SbBool enable )

Decide whether or not if clicking with the right mouse button on the OpenGL canvas should reveal a preferences pop-up menu when in viewing mode.

See also: isPopupMenuEnabled()

This method sets whether the pop-up menu should be enabled or not.

◆ setPopupMenuString()

void SoXtFullViewer::setPopupMenuString ( const char * name )

protectedvirtual

Set title of pop-up menu.

◆ setRightWheelString()

void SoXtFullViewer::setRightWheelString ( const char *const string )

protected

Set label of the right thumbwheel.

This method sets the label text that is displayed below the right decoration thumbwheel.

◆ setRightWheelValue()

void SoXtFullViewer::setRightWheelValue ( const float value )

protected

Set a new value for the right thumbwheel.

◆ setViewing()

void SoXtFullViewer::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 SoXtViewer.

Reimplemented in SoXtExaminerViewer, SoXtFlyViewer, and SoXtPlaneViewer.

◆ sizeChanged()

void SoXtFullViewer::sizeChanged ( const SbVec2s & size )

protectedvirtual

Called internally from within the SoXt library when the widget embedded in a component changes its size, which is usually triggered by end-user interaction.

This method is then invoked to notify the component that the size has changed. It is called from the top and all the way down to the bottom, the size being adjusted to take into account extra decorations having been added at each level in the component class hierarchy.

Reimplemented from SoXtViewer.

Member Data Documentation

◆ bottomDecoration

Widget SoXtFullViewer::bottomDecoration

protected

The root widget for the bottom decorations.

◆ bottomWheel

Widget SoXtFullViewer::bottomWheel

protected

The widget representing the thumbwheel below the render canvas.

The widget for the bottom thumbwheel.

◆ bottomWheelLabel

Widget SoXtFullViewer::bottomWheelLabel

protected

Label widget of bottom wheel.

The widget for the label besides the bottom thumbwheel.

◆ bottomWheelStr

char * SoXtFullViewer::bottomWheelStr

protected

Text of bottom thumbwheel's label.

The string used in the label besides the bottom thumbwheel.

◆ bottomWheelVal

float SoXtFullViewer::bottomWheelVal

protected

Current value of the bottom thumbwheel.

The value of the bottom thumbwheel. Do not set directly, use access method.

◆ leftDecoration

Widget SoXtFullViewer::leftDecoration

protected

The root widget for the left-side decorations.

◆ leftWheel

Widget SoXtFullViewer::leftWheel

protected

The widget representing the thumbwheel left of the render canvas.

The widget for the left thumbwheel.

◆ leftWheelLabel

Widget SoXtFullViewer::leftWheelLabel

protected

Label widget of left wheel.

The widget for the label below the left thumbwheel.

◆ leftWheelStr

char * SoXtFullViewer::leftWheelStr

protected

Text of left thumbwheel's label.

The string used in the label below the left thumbwheel.

◆ leftWheelVal

float SoXtFullViewer::leftWheelVal

protected

Current value of the left thumbwheel.

The value of the left thumbwheel. Do not set directly, use access method.

◆ popupEnabled

SbBool SoXtFullViewer::popupEnabled

protected

Whether the pop-up menu is enabled or not.

◆ popupTitle

char * SoXtFullViewer::popupTitle

protected

The title for the pop-up menu.

◆ prefmenu

SoXtPopupMenu * SoXtFullViewer::prefmenu

protected

Pointer to the pop-up menu instance.

The pop-up menu manager object.

◆ rightDecoration

Widget SoXtFullViewer::rightDecoration

protected

The root widget for the right-side decorations.

◆ rightWheel

Widget SoXtFullViewer::rightWheel

protected

The widget representing the thumbwheel on the right side of the render canvas.

The widget for the right thumbwheel.

◆ rightWheelLabel

Widget SoXtFullViewer::rightWheelLabel

protected

Label widget of right wheel.

The widget for the label below the right thumbwheel.

◆ rightWheelStr

char * SoXtFullViewer::rightWheelStr

protected

Text of right thumbwheel's label.

The string used in the label below the right thumbwheel.

◆ rightWheelVal

float SoXtFullViewer::rightWheelVal

protected

Current value of the right-side thumbwheel.

The value of the right thumbwheel. Do not set directly, use access method.

◆ viewerButtonWidgets

SbPList * SoXtFullViewer::viewerButtonWidgets

protected

The list of button widgets for the right viewer decoration.

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

SoXtFullViewer.h
SoXtFullViewer.cpp
FullViewer.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ BuildFlag

Constructor & Destructor Documentation

◆ SoXtFullViewer()

◆ ~SoXtFullViewer()

Member Function Documentation

◆ addAppPushButton()

◆ bottomWheelFinish()

◆ bottomWheelMotion()

◆ bottomWheelStart()

◆ buildAppButtons()

◆ buildBottomTrim()

◆ buildDecoration()

◆ buildDrawStyleSubmenu()

◆ buildFunctionsSubmenu()

◆ buildLeftTrim()

◆ buildPopupMenu()

◆ buildRightTrim()

◆ buildViewerButtons()

◆ createViewerButtons()

◆ findAppPushButton()

◆ getAppPushButtonParent()

◆ getBottomWheelLabelWidget()

◆ getBottomWheelValue()

◆ getLeftWheelLabelWidget()

◆ getLeftWheelValue()

◆ getRenderAreaWidget()

◆ getRightWheelLabelWidget()

◆ getRightWheelValue()

◆ insertAppPushButton()

◆ isDecoration()

◆ isPopupMenuEnabled()

◆ leftWheelFinish()

◆ leftWheelMotion()

◆ leftWheelStart()

◆ lengthAppPushButton()

◆ openPopupMenu()

◆ processSoEvent()

◆ removeAppPushButton()

◆ rightWheelFinish()

◆ rightWheelMotion()

◆ rightWheelStart()

◆ setBottomWheelString()

◆ setBottomWheelValue()

◆ setComponentCursor()

◆ setDecoration()

◆ setLeftWheelString()

◆ setLeftWheelValue()

◆ setPopupMenuEnabled()

◆ setPopupMenuString()

◆ setRightWheelString()

◆ setRightWheelValue()

◆ setViewing()

◆ sizeChanged()

Member Data Documentation

◆ bottomDecoration

◆ bottomWheel

◆ bottomWheelLabel

◆ bottomWheelStr

◆ bottomWheelVal

◆ leftDecoration

◆ leftWheel

◆ leftWheelLabel

◆ leftWheelStr

◆ leftWheelVal

◆ popupEnabled

◆ popupTitle

◆ prefmenu

◆ rightDecoration

◆ rightWheel

◆ rightWheelLabel

◆ rightWheelStr

◆ rightWheelVal

◆ viewerButtonWidgets