SoXtMPPlaneViewer Class Reference

Viewer component which moves the camera in a plane. More...

#include <Inventor/MP/Xt/viewers/SoXtMPPlaneViewer.h>

Inheritance diagram for SoXtMPPlaneViewer:

Public Member Functions
	SoXtMPPlaneViewer (SoWidget parent=NULL, const char *name=NULL, SbBool buildInsideParent=TRUE, SoXtMPFullViewer::BuildFlag flag=BUILD_ALL, SoXtMPViewer::Type type=BROWSER)
	~SoXtMPPlaneViewer ()
void	setPlane (const SbVec3f &newNormal, const SbVec3f &newRight)
virtual void	setViewing (SbBool onOrOff)
virtual void	setCamera (SoCamera *cam)
virtual void	setCursorEnabled (SbBool onOrOff)

Detailed Description

Viewer component which moves the camera in a plane.

The Plane viewer component allows the user to translate the camera in the viewing plane, as well as dolly (move foward/backward) and zoom in and out. The viewer also allows the user to roll the camera (rotate around the forward direction) and seek to objects which will specify a new viewing plane. This viewer could be used for modeling, in drafting, and architectural work. The camera can be aligned to the X, Y or Z axes.

NOTE: This class does not exist in Open Inventor 10.0 and later.

RESOURCES

     !!------------------------------------------------
     !! Decorations for Plane Viewer !!
     !!------------------------------------------------
     *IvPlaneTitle.labelString: Plane Viewer
     *IvPlanePrefTitle.labelString: Plane Viewer Preference Sheet
     *IvPlanePopupTitle.labelString: Plane Viewer
     *IvPlaneIconTitle.labelString: Plane Viewer
     *IvPlaneTransx.labelString: transX
     *IvPlaneTransy.labelString: transY
     *IvPlaneZoom.labelString: Zoom
     *IvPlaneDolly.labelString: Dolly

USAGE

Left Mouse or
Left + Middle Mouse: Dolly in and out (gets closer to and further away from the object).

Middle Mouse or
Ctrl + Left Mouse: Translate up, down, left and right.

Ctrl + Middle Mouse: Used for roll action (rotates around the viewer forward direction).

<s> + Left Mouse: Alternative to the Seek button. Press (but do not hold down) the <s> key, then click on a target object.

Right Mouse: Open the popup menu.

ALT: When the viewer is in selection (a.k.a. pick) mode, pressing and holding the ALT key temporarily switches the viewer to viewing mode. When the ALT key is released, the viewer returns to selection mode. Note: If any of the mouse buttons are currently depressed, the ALT key has no effect.

Constructor & Destructor Documentation

SoXtMPPlaneViewer::SoXtMPPlaneViewer	(	SoWidget	parent = `NULL`,
		const char *	name = `NULL`,
		SbBool	buildInsideParent = `TRUE`,
		SoXtMPFullViewer::BuildFlag	flag = `BUILD_ALL`,
		SoXtMPViewer::Type	type = `BROWSER`
	)

Constructor which specifies the viewer type.

Please refer to the SoXtViewer reference pages for a description of the viewer types.

SoXtMPPlaneViewer::~SoXtMPPlaneViewer ( )

Destructor.

Member Function Documentation

virtual void SoXtMPPlaneViewer::setCamera ( SoCamera * cam ) [virtual]

Sets the edited camera.

Setting the camera is only needed if the first camera found in the scene when setting the scene graph isn't the one the user really wants to edit.

Reimplemented from SoXtMPFullViewer.

virtual void SoXtMPPlaneViewer::setCursorEnabled ( SbBool onOrOff ) [virtual]

Sets whether the viewer is allowed to change the cursor over the renderArea window.

When disabled, the cursor is undefined by the viewer and will not change as the mode of the viewer changes. When re-enabled, the viewer will reset it to the appropriate icon.

Disabling the cursor enables the application to set the cursor directly on the viewer window or on any parent widget of the viewer. This can be used when setting a busy cursor on the application shell.

Reimplemented from SoXtMPViewer.

void SoXtMPPlaneViewer::setPlane	(	const SbVec3f &	newNormal,
		const SbVec3f &	newRight
	)

Moves the camera to be aligned with the given plane.

virtual void SoXtMPPlaneViewer::setViewing ( SbBool onOrOff ) [virtual]

Sets whether the viewer is turned on or off.

When turned on, events are consumed by the viewer. When viewing is off, events are processed by the viewer's render area. This means events will be sent down to the scene graph for processing (i.e. picking can occur). Note that if the application has registered an event callback, it will be invoked on every message, whether viewing is turned on or not. However, the return value of this callback (which specifies whether the callback handled the event or not) is ignored when viewing is on. That is, the viewer will process the event even if the callback already did. This is to ensure that the viewing paradigm is not broken (default viewing is on).