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

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

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

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

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)

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

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

virtual void	actualOverlayRedraw (void)

virtual void	processEvent (XAnyEvent *event)

virtual void	initGraphic (void)

virtual void	initOverlayGraphic (void)

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

Widget	buildWidget (Widget parent)

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)

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)

void	setClassName (const char *const name)

void	setBaseWidget (Widget widget)

void	registerWidget (Widget widget)

void	unregisterWidget (Widget widget)

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)

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

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

Detailed Description

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

The SoXtFullViewer is an abstract viewer class which extends it's 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 popup 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 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 popup menu. (Activated with the right mousebutton.)
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

◆ 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.

◆ 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.

◆ 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 popup menu when in viewing mode.

See also: isPopupMenuEnabled()

This method sets whether the popup menu should be enabled or not.

◆ isPopupMenuEnabled()

SbBool SoXtFullViewer::isPopupMenuEnabled ( void ) const

Return TRUE if the popup preferences menu is enabled, otherwise FALSE.

See also: setPopupMenuEnabled()

This method returns whether the popup menu is enabled or not.

◆ 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.

◆ 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.

◆ 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

◆ removeAppPushButton()

void SoXtFullViewer::removeAppPushButton ( Widget button )

Remove one of the application specific buttons.

See also: addAppPushButton(), insertAppPushButton()

FIXME: write doc

◆ 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

◆ lengthAppPushButton()

int SoXtFullViewer::lengthAppPushButton ( void ) const

Return number of application specific buttons added.

See also: addAppPushButton(), insertAddAppPushButton()

FIXME: write doc

◆ getRenderAreaWidget()

Widget SoXtFullViewer::getRenderAreaWidget ( void ) const

Returns the render area OpenGL canvas widget.

FIXME: write doc

◆ 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 mouseclicks 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.

◆ 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.

◆ sizeChanged()

void SoXtFullViewer::sizeChanged ( const SbVec2s & size )

protectedvirtual

Called internally from within the SoXt library when the widget embedded in a component changes it 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.

◆ buildDecoration()

void SoXtFullViewer::buildDecoration ( Widget parent )

protectedvirtual

Build viewer decorations.

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.

◆ 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.

◆ 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.

◆ buildAppButtons()

Widget SoXtFullViewer::buildAppButtons ( Widget parent )

protected

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

◆ 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 it's 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 it's 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.

◆ buildPopupMenu()

void SoXtFullViewer::buildPopupMenu ( void )

protectedvirtual

Make a popup 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

◆ setPopupMenuString()

void SoXtFullViewer::setPopupMenuString ( const char * name )

protectedvirtual

Set title of popup menu.

◆ openPopupMenu()

void SoXtFullViewer::openPopupMenu ( const SbVec2s position )

protectedvirtual

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

FIXME: write doc

◆ leftWheelStart()

void SoXtFullViewer::leftWheelStart ( void )

protectedvirtual

Called when the user start 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.

◆ 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, SoXtPlaneViewer, and SoXtConstrainedViewer.

◆ 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.

◆ getLeftWheelValue()

float SoXtFullViewer::getLeftWheelValue ( void ) const

protected

Get current value of the left thumbwheel.

See also: leftWheelMotion()

◆ setLeftWheelValue()

void SoXtFullViewer::setLeftWheelValue ( const float value )

protected

Set a new value for the left thumbwheel.

◆ bottomWheelStart()

void SoXtFullViewer::bottomWheelStart ( void )

protectedvirtual

Called when the user start 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.

◆ 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, SoXtPlaneViewer, and SoXtConstrainedViewer.

◆ 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.

◆ getBottomWheelValue()

float SoXtFullViewer::getBottomWheelValue ( void ) const

protected

Get current value of the bottom thumbwheel.

See also: bottomWheelMotion()

◆ setBottomWheelValue()

void SoXtFullViewer::setBottomWheelValue ( const float value )

protected

Set a new value for the bottom thumbwheel.

◆ rightWheelStart()

void SoXtFullViewer::rightWheelStart ( void )

protectedvirtual

Called when the user start 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.

◆ 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, SoXtPlaneViewer, and SoXtFlyViewer.

◆ 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.

◆ getRightWheelValue()

float SoXtFullViewer::getRightWheelValue ( void ) const

protected

Get current value of the right thumbwheel.

See also: rightWheelMotion()

◆ setRightWheelValue()

void SoXtFullViewer::setRightWheelValue ( const float value )

protected

Set a new value for the right thumbwheel.

◆ setLeftWheelString()

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

protected

Set label of the left thumbwheel.

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

◆ getLeftWheelLabelWidget()

Widget SoXtFullViewer::getLeftWheelLabelWidget ( void ) const

protected

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

◆ 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 og the bottom decoration thumb wheel.

◆ getBottomWheelLabelWidget()

Widget SoXtFullViewer::getBottomWheelLabelWidget ( void ) const

protected

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

◆ setRightWheelString()

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

protected

Set label of the right thumbwheel.

This method sets the label text that is displayed under the right decoration thumb wheel.

◆ getRightWheelLabelWidget()

Widget SoXtFullViewer::getRightWheelLabelWidget ( void ) const

protected

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

◆ processSoEvent()

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

protectedvirtual

Toolkit-native events are attempted converted 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 it's subclasses to catch events of particular interest to the viewer classes, for instance.

Return TRUE iff 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.

◆ buildFunctionsSubmenu()

Widget SoXtFullViewer::buildFunctionsSubmenu ( Widget popup )

protected

FIXME: write doc

◆ buildDrawStyleSubmenu()

Widget SoXtFullViewer::buildDrawStyleSubmenu ( Widget popup )

protected

FIXME: write doc

Member Data Documentation

◆ leftWheel

Widget SoXtFullViewer::leftWheel

protected

The widget representing the thumbwheel left of the render canvas.

The widget for the left thumb wheel.

◆ rightWheel

Widget SoXtFullViewer::rightWheel

protected

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

The widget for the right thumb wheel.

◆ bottomWheel

Widget SoXtFullViewer::bottomWheel

protected

The widget representing the thumbwheel below the render canvas.

The widget for the bottom thumb wheel.

◆ leftDecoration

Widget SoXtFullViewer::leftDecoration

protected

The root widget for the left-side decorations.

◆ rightDecoration

Widget SoXtFullViewer::rightDecoration

protected

The root widget for the right-side decorations.

◆ bottomDecoration

Widget SoXtFullViewer::bottomDecoration

protected

The root widget for the bottom decorations.

◆ leftWheelLabel

Widget SoXtFullViewer::leftWheelLabel

protected

Label widget of left wheel.

The widget for the label below the left thumb wheel.

◆ leftWheelStr

char * SoXtFullViewer::leftWheelStr

protected

Text of left thumbwheel's label.

The string used in the label under the left thumb wheel.

◆ leftWheelVal

float SoXtFullViewer::leftWheelVal

protected

Current value of the left thumbwheel.

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

◆ rightWheelLabel

Widget SoXtFullViewer::rightWheelLabel

protected

Label widget of right wheel.

The widget for the label below the right thumb wheel.

◆ rightWheelStr

char * SoXtFullViewer::rightWheelStr

protected

Text of right thumbwheel's label.

The string used in the label below the right thumb wheel.

◆ rightWheelVal

float SoXtFullViewer::rightWheelVal

protected

Current value of the right-side thumbwheel.

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

◆ bottomWheelLabel

Widget SoXtFullViewer::bottomWheelLabel

protected

Label widget of bottom wheel.

The widget for the label besides the bottom thumb wheel.

◆ bottomWheelStr

char * SoXtFullViewer::bottomWheelStr

protected

Text of bottom thumbwheel's label.

The string used in the label besides the bottom thumb wheel.

◆ bottomWheelVal

float SoXtFullViewer::bottomWheelVal

protected

Current value of the bottom thumbwheel.

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

◆ prefmenu

SoXtPopupMenu * SoXtFullViewer::prefmenu

protected

Pointer to the popup menu instance.

The popup menu manager object.

◆ popupTitle

char * SoXtFullViewer::popupTitle

protected

The title for the popup menu,

◆ popupEnabled

SbBool SoXtFullViewer::popupEnabled

protected

Whether the popup menu is enabled or not.

◆ 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

◆ setDecoration()

◆ isDecoration()

◆ setPopupMenuEnabled()

◆ isPopupMenuEnabled()

◆ getAppPushButtonParent()

◆ addAppPushButton()

◆ insertAppPushButton()

◆ removeAppPushButton()

◆ findAppPushButton()

◆ lengthAppPushButton()

◆ getRenderAreaWidget()

◆ setViewing()

◆ setComponentCursor()

◆ sizeChanged()

◆ buildDecoration()

◆ buildLeftTrim()

◆ buildBottomTrim()

◆ buildRightTrim()

◆ buildAppButtons()

◆ buildViewerButtons()

◆ createViewerButtons()

◆ buildPopupMenu()

◆ setPopupMenuString()

◆ openPopupMenu()

◆ leftWheelStart()

◆ leftWheelMotion()

◆ leftWheelFinish()

◆ getLeftWheelValue()

◆ setLeftWheelValue()

◆ bottomWheelStart()

◆ bottomWheelMotion()

◆ bottomWheelFinish()

◆ getBottomWheelValue()

◆ setBottomWheelValue()

◆ rightWheelStart()

◆ rightWheelMotion()

◆ rightWheelFinish()

◆ getRightWheelValue()

◆ setRightWheelValue()

◆ setLeftWheelString()

◆ getLeftWheelLabelWidget()

◆ setBottomWheelString()

◆ getBottomWheelLabelWidget()

◆ setRightWheelString()

◆ getRightWheelLabelWidget()

◆ processSoEvent()

◆ buildFunctionsSubmenu()

◆ buildDrawStyleSubmenu()

Member Data Documentation

◆ leftWheel

◆ rightWheel

◆ bottomWheel

◆ leftDecoration

◆ rightDecoration

◆ bottomDecoration

◆ leftWheelLabel

◆ leftWheelStr

◆ leftWheelVal

◆ rightWheelLabel

◆ rightWheelStr

◆ rightWheelVal

◆ bottomWheelLabel

◆ bottomWheelStr

◆ bottomWheelVal

◆ prefmenu

◆ popupTitle

◆ popupEnabled

◆ viewerButtonWidgets