SoGtkFullViewer Class Reference

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

#include <Inventor/Gtk/viewers/SoGtkFullViewer.h>

Inheritance diagram for SoGtkFullViewer:

Public Types
enum	BuildFlag { BUILD_NONE = 0x00 , BUILD_DECORATION = 0x01 , BUILD_POPUP = 0x02 , BUILD_ALL = (BUILD_DECORATION | BUILD_POPUP) }
Public Types inherited from SoGtkViewer
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 (GtkWidget *newButton)
int	findAppPushButton (GtkWidget *oldButton) const
GtkWidget *	getAppPushButtonParent (void) const
GtkWidget *	getRenderAreaWidget (void) const
void	insertAppPushButton (GtkWidget *newButton, int index)
SbBool	isDecoration (void) const
SbBool	isPopupMenuEnabled (void) const
int	lengthAppPushButton (void) const
void	removeAppPushButton (GtkWidget *oldButton)
virtual void	setComponentCursor (const SoGtkCursor &cursor)
void	setDecoration (const SbBool on)
void	setPopupMenuEnabled (const SbBool on)
virtual void	setViewing (SbBool on)
Public Member Functions inherited from SoGtkViewer
void	addFinishCallback (SoGtkViewerCB *func, void *data=NULL)
void	addStartCallback (SoGtkViewerCB *func, void *data=NULL)
void	getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3])
SoGtkViewer::BufferType	getBufferingType (void) const
SoCamera *	getCamera (void) const
SoType	getCameraType (void) const
SoGtkViewer::DrawStyle	getDrawStyle (const SoGtkViewer::DrawType type) const
SoDirectionalLight *	getHeadlight (void) const
virtual SoNode *	getSceneGraph (void)
float	getSeekTime (void) const
float	getStereoOffset (void) const
SoGtkViewer::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 (SoGtkViewerCB *func, void *data=NULL)
void	removeStartCallback (SoGtkViewerCB *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, SoGtkAutoClippingCB *cb=NULL, void *cbuserdata=NULL)
virtual void	setBufferingType (SoGtkViewer::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 (SoGtkViewer::DrawType type, SoGtkViewer::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 (SoGtkViewer::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 SoGtkRenderArea
	SoGtkRenderArea (GtkWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)
	~SoGtkRenderArea ()
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 (SoGtkDevice *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 (SoGtkRenderAreaEventCB *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 (SoGtkDevice *device)
Public Member Functions inherited from SoGtkGLWidget
SbBool	getAccumulationBuffer (void) const
SbBool	getAlphaChannel (void) const
GtkWidget *	getGLWidget (void) const
void	getLineWidthLimits (SbVec2f &range, float &granularity)
GtkWidget *	getNormalWidget (void) const
unsigned long	getOverlayTransparentPixel (void)
GtkWidget *	getOverlayWidget (void) const
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)
void	setOverlayRender (const SbBool onoff)
void	setQuadBufferStereo (const SbBool enable)
void	setSampleBuffers (const int numsamples)
void	setStealFocus (SbBool enable)
void	setStencilBuffer (const SbBool enable)
Public Member Functions inherited from SoGtkComponent
virtual	~SoGtkComponent ()
GtkWidget *	getBaseWidget (void) const
const char *	getClassName (void) const
const char *	getIconTitle (void) const
GtkWidget *	getParentWidget (void) const
GtkWidget *	getShellWidget (void) const
SbVec2s	getSize (void) const
const char *	getTitle (void) const
GtkWidget *	getWidget (void) const
const char *	getWidgetName (void) const
virtual void	hide (void)
SbBool	isFullScreen (void) const
SbBool	isTopLevelShell (void) const
SbBool	isVisible (void)
SbBool	setFullScreen (const SbBool onoff)
void	setIconTitle (const char *const title)
void	setSize (const SbVec2s size)
void	setTitle (const char *const title)
void	setWindowCloseCallback (SoGtkComponentCB *const func, void *const user=NULL)
virtual void	show (void)
Public Member Functions inherited from SoGtkObject
virtual SoType	getTypeId (void) const =0
SbBool	isOfType (SoType type) const

Protected Member Functions
	SoGtkFullViewer (GtkWidget *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)
	~SoGtkFullViewer ()
virtual void	bottomWheelFinish (void)
virtual void	bottomWheelMotion (float)
virtual void	bottomWheelStart (void)
GtkWidget *	buildAppButtons (GtkWidget *parent)
virtual GtkWidget *	buildBottomTrim (GtkWidget *parent)
virtual void	buildDecoration (GtkWidget *parent)
virtual GtkWidget *	buildLeftTrim (GtkWidget *parent)
virtual void	buildPopupMenu (void)
virtual GtkWidget *	buildRightTrim (GtkWidget *parent)
GtkWidget *	buildViewerButtons (GtkWidget *parent)
GtkWidget *	buildWidget (GtkWidget *parent)
virtual void	createViewerButtons (GtkWidget *parent, SbPList *buttonlist)
GtkWidget *	getBottomWheelLabelWidget (void) const
float	getBottomWheelValue (void) const
GtkWidget *	getLeftWheelLabelWidget (void) const
float	getLeftWheelValue (void) const
GtkWidget *	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 SoGtkViewer
	SoGtkViewer (GtkWidget *parent, const char *name, SbBool embed, Type type, SbBool build)
	~SoGtkViewer ()
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 SoGtkRenderArea
	SoGtkRenderArea (GtkWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build)
virtual void	actualOverlayRedraw (void)
virtual void	afterRealizeHook (void)
GtkWidget *	buildWidget (GtkWidget *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 (GdkEvent *event)
virtual void	redraw (void)
virtual void	redrawOverlay (void)
virtual void	widgetChanged (GtkWidget *widget)
Protected Member Functions inherited from SoGtkGLWidget
	SoGtkGLWidget (GtkWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)
	~SoGtkGLWidget ()
GtkWidget *	buildWidget (GtkWidget *parent)
virtual SbBool	eventFilter (GtkWidget *object, GdkEvent *event)
float	getGLAspectRatio (void) const
SbVec2s	getGLSize (void) const
float	getGlxAspectRatio (void) const
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 SoGtkComponent
	SoGtkComponent (GtkWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
void	addVisibilityChangeCallback (SoGtkComponentVisibilityCB *const func, void *const user=NULL)
void	registerWidget (GtkWidget *widget)
void	removeVisibilityChangeCallback (SoGtkComponentVisibilityCB *const func, void *const user=NULL)
void	setBaseWidget (GtkWidget *widget)
void	setClassName (const char *const name)
void	unregisterWidget (GtkWidget *widget)

Protected Attributes
GtkWidget *	bottomDecoration
GtkWidget *	bottomWheel
GtkWidget *	bottomWheelLabel
char *	bottomWheelStr
float	bottomWheelVal
GtkWidget *	leftDecoration
GtkWidget *	leftWheel
GtkWidget *	leftWheelLabel
char *	leftWheelStr
float	leftWheelVal
SoGtkPopupMenu *	prefmenu
GtkWidget *	rightDecoration
GtkWidget *	rightWheel
GtkWidget *	rightWheelLabel
char *	rightWheelStr
float	rightWheelVal
Protected Attributes inherited from SoGtkGLWidget
SbBool	drawToFrontBuffer
SbBool	waitForExpose
Protected Attributes inherited from SoGtkComponent
SbBool	firstRealize

Additional Inherited Members
Static Public Member Functions inherited from SoGtkRenderArea
static uint32_t	getDefaultRedrawPriority (void)
Static Public Member Functions inherited from SoGtkComponent
static SoGtkComponent *	getComponent (GtkWidget *widget)
static void	initClasses (void)
static void	setWidgetCursor (GtkWidget *w, const SoGtkCursor &cursor)
Static Public Member Functions inherited from SoGtkObject
static SoType	getClassTypeId (void)
static void	init (void)
static void	initClass (void)

Detailed Description

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

The SoGtkFullViewer is an abstract viewer class which extends its superclass (the basic SoGtkViewer 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 SoGtkFullViewer'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 SoGtkViewer or the SoGtkRenderArea 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 SoGtkFullViewer 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

SoGtkConstrainedViewer, SoGtkExaminerViewer, SoGtkPlaneViewer

Member Enumeration Documentation

BuildFlag

enum SoGtkFullViewer::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.

FIXME: write documentation for enum

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

Constructor & Destructor Documentation

SoGtkFullViewer()

SoGtkFullViewer::SoGtkFullViewer ( GtkWidget * parent, const char * name, SbBool embed, SoGtkFullViewer::BuildFlag buildFlag, SoGtkViewer::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. See parent class for explanation of arguments.

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

~SoGtkFullViewer()

SoGtkFullViewer::~SoGtkFullViewer ( )

protected

Destructor.

Member Function Documentation

addAppPushButton()

void SoGtkFullViewer::addAppPushButton

(

GtkWidget *

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

bottomWheelFinish()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

bottomWheelMotion()

void SoGtkFullViewer::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 SoGtkExaminerViewer, SoGtkConstrainedViewer, and SoGtkPlaneViewer.

bottomWheelStart()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

buildAppButtons()

GtkWidget * SoGtkFullViewer::buildAppButtons ( GtkWidget * parent )

protected

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

buildBottomTrim()

GtkWidget * SoGtkFullViewer::buildBottomTrim ( GtkWidget * 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.

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

buildDecoration()

void SoGtkFullViewer::buildDecoration ( GtkWidget * parent )

protectedvirtual

Build viewer decorations.

buildLeftTrim()

GtkWidget * SoGtkFullViewer::buildLeftTrim ( GtkWidget * 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.

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

buildPopupMenu()

void SoGtkFullViewer::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 SoGtkFullViewer::createViewerButtons().

Make a pop-up menu with preferences settings.

buildRightTrim()

GtkWidget * SoGtkFullViewer::buildRightTrim ( GtkWidget * 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.

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

buildViewerButtons()

GtkWidget * SoGtkFullViewer::buildViewerButtons ( GtkWidget * parent )

protected

Build and layout viewer specified button row.

createViewerButtons()

void SoGtkFullViewer::createViewerButtons ( GtkWidget * 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 SoGtkExaminerViewer:

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

Reimplemented in SoGtkExaminerViewer, and SoGtkPlaneViewer.

findAppPushButton()

int SoGtkFullViewer::findAppPushButton

(

GtkWidget *

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

getAppPushButtonParent()

GtkWidget * SoGtkFullViewer::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()

getBottomWheelLabelWidget()

GtkWidget * SoGtkFullViewer::getBottomWheelLabelWidget ( void ) const

protected

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

getBottomWheelValue()

float SoGtkFullViewer::getBottomWheelValue ( void ) const

protected

Get current value of the bottom thumbwheel.

See also

bottomWheelMotion()

getLeftWheelLabelWidget()

GtkWidget * SoGtkFullViewer::getLeftWheelLabelWidget ( void ) const

protected

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

getLeftWheelValue()

float SoGtkFullViewer::getLeftWheelValue ( void ) const

protected

Get current value of the left thumbwheel.

See also

leftWheelMotion()

getRenderAreaWidget()

GtkWidget * SoGtkFullViewer::getRenderAreaWidget

(

void

)

const

Returns the render area OpenGL canvas widget.

Returns the parent widget of the render area OpenGL canvas widget.

See also

getGLWidget()

getRightWheelLabelWidget()

GtkWidget * SoGtkFullViewer::getRightWheelLabelWidget ( void ) const

protected

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

getRightWheelValue()

float SoGtkFullViewer::getRightWheelValue ( void ) const

protected

Get current value of the right thumbwheel.

See also

rightWheelMotion()

insertAppPushButton()

void SoGtkFullViewer::insertAppPushButton	(	GtkWidget *	newButton,
		int	index )

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

See also

addAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

isDecoration()

SbBool SoGtkFullViewer::isDecoration

(

void

)

const

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

See also

setDecoration()

isPopupMenuEnabled()

SbBool SoGtkFullViewer::isPopupMenuEnabled

(

void

)

const

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

See also

setPopupMenuEnabled()

leftWheelFinish()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

leftWheelMotion()

void SoGtkFullViewer::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 SoGtkExaminerViewer, SoGtkConstrainedViewer, and SoGtkPlaneViewer.

leftWheelStart()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

lengthAppPushButton()

int SoGtkFullViewer::lengthAppPushButton

(

void

)

const

Return number of application specific buttons added.

See also

addAppPushButton(), insertAddAppPushButton()

openPopupMenu()

void SoGtkFullViewer::openPopupMenu ( const SbVec2s position )

protectedvirtual

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

FIXME: write doc

processSoEvent()

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

protectedvirtual

Toolkit-native events are tried to convert to Coin-generic events in the SoGtkRenderArea::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 SoGtkViewer.

Reimplemented in SoGtkExaminerViewer, SoGtkFlyViewer, and SoGtkPlaneViewer.

removeAppPushButton()

void SoGtkFullViewer::removeAppPushButton

(

GtkWidget *

oldButton

)

Remove one of the application specific buttons.

See also

addAppPushButton(), insertAppPushButton()

rightWheelFinish()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

rightWheelMotion()

void SoGtkFullViewer::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 SoGtkExaminerViewer, SoGtkFlyViewer, and SoGtkPlaneViewer.

rightWheelStart()

void SoGtkFullViewer::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 SoGtkPlaneViewer.

setBottomWheelString()

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

protected

Set label of the bottom thumbwheel.

setBottomWheelValue()

void SoGtkFullViewer::setBottomWheelValue ( const float value )

protected

Set a new value for the bottom thumbwheel.

setComponentCursor()

void SoGtkFullViewer::setComponentCursor ( const SoGtkCursor & 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 SoGtkComponent.

setDecoration()

void SoGtkFullViewer::setDecoration

(

const SbBool

enable

)

Turn the viewer decorations on or off.

See also

isDecoration()

setLeftWheelString()

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

protected

Set label of the left thumbwheel.

Set label for the left thumbwheel.

setLeftWheelValue()

void SoGtkFullViewer::setLeftWheelValue ( const float value )

protected

Set a new value for the left thumbwheel.

setPopupMenuEnabled()

void SoGtkFullViewer::setPopupMenuEnabled

(

const SbBool

on

)

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

setPopupMenuString()

void SoGtkFullViewer::setPopupMenuString ( const char * name )

protectedvirtual

Set title of pop-up menu.

setRightWheelString()

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

protected

Set label of the right thumbwheel.

setRightWheelValue()

void SoGtkFullViewer::setRightWheelValue ( const float value )

protected

Set a new value for the right thumbwheel.

setViewing()

void SoGtkFullViewer::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 SoGtkViewer.

Reimplemented in SoGtkExaminerViewer, SoGtkFlyViewer, and SoGtkPlaneViewer.

sizeChanged()

void SoGtkFullViewer::sizeChanged ( const SbVec2s & size )

protectedvirtual

Called internally from within the SoGtk 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.

Override to detect when the base widget in the component changes its dimensions (an operation which is usually triggered by the user).

Reimplemented from SoGtkViewer.

Member Data Documentation

bottomDecoration

GtkWidget * SoGtkFullViewer::bottomDecoration

protected

The root widget for the bottom decorations.

This is the form below the GL canvas. It is 30 pixels high, and extends beyond the GL canvas by 30 pixels on both sides.

bottomWheel

GtkWidget * SoGtkFullViewer::bottomWheel

protected

The widget representing the thumbwheel below the render canvas.

FIXME: write documentation

bottomWheelLabel

GtkWidget * SoGtkFullViewer::bottomWheelLabel

protected

Label widget of bottom wheel.

FIXME: write documentation

bottomWheelStr

char * SoGtkFullViewer::bottomWheelStr

protected

Text of bottom thumbwheel's label.

FIXME: write documentation

bottomWheelVal

float SoGtkFullViewer::bottomWheelVal

protected

Current value of the bottom thumbwheel.

FIXME: write documentation

leftDecoration

GtkWidget * SoGtkFullViewer::leftDecoration

protected

The root widget for the left-side decorations.

This is the form on the left side of the GL canvas. It is 30 pixels wide, and has the same height as the GL canvas.

leftWheel

GtkWidget * SoGtkFullViewer::leftWheel

protected

The widget representing the thumbwheel left of the render canvas.

FIXME: write documentation

leftWheelLabel

GtkWidget * SoGtkFullViewer::leftWheelLabel

protected

Label widget of left wheel.

FIXME: write documentation

leftWheelStr

char * SoGtkFullViewer::leftWheelStr

protected

Text of left thumbwheel's label.

FIXME: write documentation

leftWheelVal

float SoGtkFullViewer::leftWheelVal

protected

Current value of the left thumbwheel.

FIXME: write documentation

This variable

prefmenu

SoGtkPopupMenu * SoGtkFullViewer::prefmenu

protected

Pointer to the pop-up menu instance.

This variable contains the pop-up menu object or NULL if it has not been created yet.

rightDecoration

GtkWidget * SoGtkFullViewer::rightDecoration

protected

The root widget for the right-side decorations.

This is the form containing the buttons and the thumbwheel on the right side of the GL canvas.

rightWheel

GtkWidget * SoGtkFullViewer::rightWheel

protected

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

FIXME: write documentation

rightWheelLabel

GtkWidget * SoGtkFullViewer::rightWheelLabel

protected

Label widget of right wheel.

FIXME: write documentation

rightWheelStr

char * SoGtkFullViewer::rightWheelStr

protected

Text of right thumbwheel's label.

FIXME: write documentation

rightWheelVal

float SoGtkFullViewer::rightWheelVal

protected

Current value of the right-side thumbwheel.

This variable contains the value of the thumbwheel on the right hand side of the GL canvas. The value represents accumulated radians for the thumbwheel.

This variable should only be accessed for reading the value, not for setting it.

See also

setRightWheelValue

---

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

• SoGtkFullViewer.h
• SoGtkFullViewer.cpp
• FullViewer.cpp