The SoWinPlaneViewer class is for examining 3D models by moving the camera in orthogonal planes. More...

#include <Inventor/Win/viewers/SoWinPlaneViewer.h>

Inheritance diagram for SoWinPlaneViewer:

Public Member Functions
	SoWinPlaneViewer (HWND parent=NULL, const char *const name=NULL, SbBool embed=TRUE, SoWinFullViewer::BuildFlag flag=BUILD_ALL, SoWinViewer::Type type=BROWSER)

	~SoWinPlaneViewer ()

virtual void	setCamera (SoCamera *camera)

virtual void	setCursorEnabled (SbBool enable)

virtual void	setViewing (SbBool enable)

Public Member Functions inherited from SoWinFullViewer
void	addAppPushButton (HWND newButton)

int	findAppPushButton (HWND oldButton) const

HWND	getAppPushButtonParent (void) const

HWND	getRenderAreaWidget (void) const

void	insertAppPushButton (HWND newButton, int index)

SbBool	isDecoration (void) const

SbBool	isPopupMenuEnabled (void) const

int	lengthAppPushButton (void) const

void	removeAppPushButton (HWND oldButton)

virtual void	setComponentCursor (const SoWinCursor &cursor)

void	setDecoration (const SbBool on)

void	setPopupMenuEnabled (const SbBool on)

Public Member Functions inherited from SoWinViewer
void	addFinishCallback (SoWinViewerCB func, void data=NULL)

void	addStartCallback (SoWinViewerCB func, void data=NULL)

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

SoWinViewer::BufferType	getBufferingType (void) const

SoCamera *	getCamera (void) const

SoType	getCameraType (void) const

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

SoDirectionalLight *	getHeadlight (void) const

virtual SoNode *	getSceneGraph (void)

float	getSeekTime (void) const

float	getStereoOffset (void) const

SoWinViewer::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 (SoWinViewerCB func, void data=NULL)

void	removeStartCallback (SoWinViewerCB 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, SoWinAutoClippingCB cb=NULL, void cbuserdata=NULL)

virtual void	setBufferingType (SoWinViewer::BufferType type)

virtual void	setCameraType (SoType type)

void	setDetailSeek (const SbBool enable)

virtual void	setDoubleBuffer (const SbBool enable)

virtual void	setDrawStyle (SoWinViewer::DrawType type, SoWinViewer::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 (SoWinViewer::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 SoWinRenderArea
	SoWinRenderArea (HWND parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)

	~SoWinRenderArea ()

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 (SoWinDevice *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 (SoWinRenderAreaEventCB 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 (SoWinDevice *device)

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

SbBool	getAlphaChannel (void) const

HWND	getGLWidget (void) const

void	getLineWidthLimits (SbVec2f &range, float &granularity)

HWND	getNormalWidget (void) const

unsigned long	getOverlayTransparentPixel (void)

HWND	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 SoWinComponent
virtual	~SoWinComponent ()

HWND	getBaseWidget (void) const

const char *	getClassName (void) const

const char *	getIconTitle (void) const

HWND	getParentWidget (void) const

HWND	getShellWidget (void) const

SbVec2s	getSize (void) const

const char *	getTitle (void) const

HWND	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 (SoWinComponentCB const func, void const user=NULL)

virtual void	show (void)

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

SbBool	isOfType (SoType type) const

Protected Member Functions
	SoWinPlaneViewer (HWND parent, const char *const name, SbBool embed, SoWinFullViewer::BuildFlag flag, SoWinViewer::Type type, SbBool build)

virtual void	actualRedraw (void)

virtual void	afterRealizeHook (void)

virtual void	bottomWheelFinish (void)

virtual void	bottomWheelMotion (float value)

virtual void	bottomWheelStart (void)

HWND	buildWidget (HWND parent)

virtual void	computeSeekFinalOrientation (void)

virtual void	createViewerButtons (HWND parent, SbPList *buttons)

virtual const char *	getDefaultIconTitle (void) const

virtual const char *	getDefaultTitle (void) const

virtual const char *	getDefaultWidgetName (void) const

virtual void	leftWheelFinish (void)

virtual void	leftWheelMotion (float value)

virtual void	leftWheelStart (void)

virtual SbBool	processSoEvent (const SoEvent *const event)

virtual void	rightWheelFinish (void)

virtual void	rightWheelMotion (float value)

virtual void	rightWheelStart (void)

virtual void	setSeekMode (SbBool enable)

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

	~SoWinFullViewer ()

HWND	buildAppButtons (HWND parent)

virtual HWND	buildBottomTrim (HWND parent)

virtual void	buildDecoration (HWND parent)

virtual HWND	buildLeftTrim (HWND parent)

virtual void	buildPopupMenu (void)

virtual HWND	buildRightTrim (HWND parent)

HWND	buildViewerButtons (HWND parent)

HWND	buildWidget (HWND parent)

HWND	getBottomWheelLabelWidget (void) const

float	getBottomWheelValue (void) const

HWND	getLeftWheelLabelWidget (void) const

float	getLeftWheelValue (void) const

HWND	getRightWheelLabelWidget (void) const

const char *	getRightWheelString () const

float	getRightWheelValue (void) const

virtual void	openPopupMenu (const SbVec2s position)

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 SoWinViewer
	SoWinViewer (HWND parent, const char *name, SbBool embed, Type type, SbBool build)

	~SoWinViewer ()

void	addSuperimposition (SoNode *scene)

virtual void	changeCameraValues (SoCamera *camera)

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)

void	setSeekValueAsPercentage (const SbBool on)

void	setSuperimpositionEnabled (SoNode *scene, const SbBool enable)

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

virtual void	actualOverlayRedraw (void)

HWND	buildWidget (HWND parent)

virtual SbBool	glScheduleRedraw (void)

virtual void	initGraphic (void)

virtual void	initOverlayGraphic (void)

virtual void	processEvent (MSG *event)

virtual void	redraw (void)

virtual void	redrawOverlay (void)

virtual void	widgetChanged (HWND widget)

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

	~SoWinGLWidget ()

HWND	buildWidget (HWND parent)

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 SoWinComponent
	SoWinComponent (HWND const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)

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

void	registerWidget (HWND widget)

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

void	setBaseWidget (HWND widget)

void	setClassName (const char *const name)

void	unregisterWidget (HWND widget)

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

Public Types inherited from SoWinViewer
enum	AutoClippingStrategy { VARIABLE_NEAR_PLANE , CONSTANT_NEAR_PLANE }

enum	BufferType { BUFFER_SINGLE , BUFFER_DOUBLE , BUFFER_INTERACTIVE }

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

enum	DrawType { STILL = 0 , INTERACTIVE }

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

enum	Type { BROWSER , EDITOR }

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

Static Public Member Functions inherited from SoWinComponent
static SoWinComponent *	getComponent (HWND widget)

static void	initClasses (void)

static void	setWidgetCursor (HWND w, const SoWinCursor &cursor)

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

static void	init (void)

static void	initClass (void)

Protected Attributes inherited from SoWinFullViewer
HWND	bottomDecoration

HWND	bottomWheel

HWND	bottomWheelLabel

char *	bottomWheelStr

float	bottomWheelVal

HWND	leftDecoration

HWND	leftWheel

HWND	leftWheelLabel

char *	leftWheelStr

float	leftWheelVal

SoWinPopupMenu *	prefmenu

HWND	rightDecoration

HWND	rightWheel

HWND	rightWheelLabel

char *	rightWheelStr

float	rightWheelVal

Protected Attributes inherited from SoWinGLWidget
SbBool	drawToFrontBuffer

SbBool	waitForExpose

Protected Attributes inherited from SoWinComponent
SbBool	firstRealize

Detailed Description

The SoWinPlaneViewer class is for examining 3D models by moving the camera in orthogonal planes.

The SoWinPlaneViewer is a viewer that is useful for "CAD-style" applications, where you want the end-user to examine your model with the viewpoint set from one of the three principal axes.

Controls:

hold down left mouse button and move mouse pointer to dolly (or hold both left and middle mouse buttons)
hold middle mouse button to pan (or a CTRL-key plus left mouse button, or a SHIFT-key plus left mouse button)
hold down CTRL + middle mouse button to rotate (or CTRL + SHIFT + the left mouse button)
click 's', then pick with the left mouse button to seek
right mouse button open the pop-up menu
click 'ESC' key to switch to and from 'view' mode and 'scene graph interaction' mode (see setViewing() documentation)
hold down the 'ALT' key to temporary toggle from
camera-interaction mode to scene graph-interaction mode

Hitting any of the X, Y or Z buttons in the panel on the right side of the render canvas will "flip" the current camera direction around its focal point to point along the selected axis (towards negative infinity).

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

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

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

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

Constructor & Destructor Documentation

◆ SoWinPlaneViewer() [1/2]

SoWinPlaneViewer::SoWinPlaneViewer	(	HWND	parent = NULL,
		const char *const	name = NULL,
		SbBool	embed = TRUE,
		SoWinFullViewer::BuildFlag	flag = BUILD_ALL,
		SoWinViewer::Type	type = BROWSER )

The public constructor, to be used by application programmers who want to instantiate the plain, standard SoWinPlaneViewer.

◆ ~SoWinPlaneViewer()

SoWinPlaneViewer::~SoWinPlaneViewer ( )

The destructor. Cleans up all internal resources used by the SoWinPlaneViewer instance.

◆ SoWinPlaneViewer() [2/2]

SoWinPlaneViewer::SoWinPlaneViewer	(	HWND	parent,
		const char *const	name,
		SbBool	embed,
		SoWinFullViewer::BuildFlag	flag,
		SoWinViewer::Type	type,
		SbBool	build )

protected

A protected constructor, to be used by application programmers who want to extend the SoWinPlaneViewer.

Member Function Documentation

◆ actualRedraw()

void SoWinPlaneViewer::actualRedraw ( void )

protectedvirtual

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

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

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

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

Reimplemented from SoWinViewer.

◆ afterRealizeHook()

void SoWinPlaneViewer::afterRealizeHook ( void )

protectedvirtual

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

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

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

Reimplemented from SoWinRenderArea.

◆ bottomWheelFinish()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ bottomWheelMotion()

void SoWinPlaneViewer::bottomWheelMotion ( float value )

protectedvirtual

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

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

Reimplemented from SoWinFullViewer.

◆ bottomWheelStart()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ computeSeekFinalOrientation()

virtual void SoWinPlaneViewer::computeSeekFinalOrientation ( void )

protectedvirtual

This method can be overridden in subclasses if the final orientation of the camera after a seek should be something other than what is computed in SoWinViewer::seekToPoint(const SbVec3f & scenepos)

Reimplemented from SoWinViewer.

◆ createViewerButtons()

void SoWinPlaneViewer::createViewerButtons	(	HWND	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 SoWinExaminerViewer:

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

Reimplemented from SoWinFullViewer.

◆ getDefaultIconTitle()

const char * SoWinPlaneViewer::getDefaultIconTitle ( void ) const

protectedvirtual

This method returns the default icon title of the component.

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

Reimplemented from SoWinRenderArea.

◆ getDefaultTitle()

const char * SoWinPlaneViewer::getDefaultTitle ( void ) const

protectedvirtual

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

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

Reimplemented from SoWinRenderArea.

◆ getDefaultWidgetName()

const char * SoWinPlaneViewer::getDefaultWidgetName ( void ) const

protectedvirtual

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

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

Reimplemented from SoWinRenderArea.

◆ leftWheelFinish()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ leftWheelMotion()

void SoWinPlaneViewer::leftWheelMotion ( float value )

protectedvirtual

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

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

Reimplemented from SoWinFullViewer.

◆ leftWheelStart()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ processSoEvent()

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

protectedvirtual

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

◆ rightWheelFinish()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ rightWheelMotion()

void SoWinPlaneViewer::rightWheelMotion ( float value )

protectedvirtual

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

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

Reimplemented from SoWinFullViewer.

◆ rightWheelStart()

void SoWinPlaneViewer::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 from SoWinFullViewer.

◆ setCamera()

void SoWinPlaneViewer::setCamera ( SoCamera * cam )

virtual

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

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

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

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

See also: getCamera()

Reimplemented from SoWinViewer.

◆ setCursorEnabled()

void SoWinPlaneViewer::setCursorEnabled ( SbBool on )

virtual

Set whether or not the mouse cursor representation should be visible in the viewer canvas.

Default value is on.

See also: isCursorEnabled()

Reimplemented from SoWinViewer.

◆ setSeekMode()

void SoWinPlaneViewer::setSeekMode ( SbBool enable )

protectedvirtual

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

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

See also: isSeekMode(), setDetailSeek()

Reimplemented from SoWinViewer.

◆ setViewing()

void SoWinPlaneViewer::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 SoWinFullViewer.

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

SoWinPlaneViewer.h
SoWinPlaneViewer.cpp
PlaneViewer.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SoWinPlaneViewer() [1/2]

◆ ~SoWinPlaneViewer()

◆ SoWinPlaneViewer() [2/2]

Member Function Documentation

◆ actualRedraw()

◆ afterRealizeHook()

◆ bottomWheelFinish()

◆ bottomWheelMotion()

◆ bottomWheelStart()

◆ computeSeekFinalOrientation()

◆ createViewerButtons()

◆ getDefaultIconTitle()

◆ getDefaultTitle()

◆ getDefaultWidgetName()

◆ leftWheelFinish()

◆ leftWheelMotion()

◆ leftWheelStart()

◆ processSoEvent()

◆ rightWheelFinish()

◆ rightWheelMotion()

◆ rightWheelStart()

◆ setCamera()

◆ setCursorEnabled()

◆ setSeekMode()

◆ setViewing()