provides Unicam navigation style More...

#include <vtkInteractorStyleUnicam.h>

Inheritance diagram for vtkInteractorStyleUnicam:

Collaboration diagram for vtkInteractorStyleUnicam:

Public Types
typedef vtkInteractorStyle	Superclass

Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkInteractorStyleUnicam *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetWorldUpVector (double a[3])

void	SetWorldUpVector (double x, double y, double z)

virtual double *	GetWorldUpVector ()

virtual void	GetWorldUpVector (double data[3])

virtual void	OnTimer ()


virtual void	OnMouseMove ()

virtual void	OnLeftButtonDown ()

virtual void	OnLeftButtonUp ()

virtual void	OnLeftButtonMove ()

Public Member Functions inherited from vtkInteractorStyle
vtkInteractorStyle *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	SetInteractor (vtkRenderWindowInteractor *interactor)

virtual void	SetEnabled (int)

void	FindPokedRenderer (int, int)

virtual void	OnChar ()

virtual void	OnKeyDown ()

virtual void	OnKeyUp ()

virtual void	OnKeyPress ()

virtual void	OnKeyRelease ()

virtual void	SetAutoAdjustCameraClippingRange (int)

virtual int	GetAutoAdjustCameraClippingRange ()

virtual void	AutoAdjustCameraClippingRangeOn ()

virtual void	AutoAdjustCameraClippingRangeOff ()

virtual int	GetState ()

virtual int	GetUseTimers ()

virtual void	SetUseTimers (int)

virtual void	UseTimersOn ()

virtual void	UseTimersOff ()

virtual void	SetTimerDuration (unsigned long)

virtual unsigned long	GetTimerDuration ()

virtual void	SetHandleObservers (int)

virtual int	GetHandleObservers ()

virtual void	HandleObserversOn ()

virtual void	HandleObserversOff ()

virtual void	OnMiddleButtonDown ()

virtual void	OnMiddleButtonUp ()

virtual void	OnRightButtonDown ()

virtual void	OnRightButtonUp ()

virtual void	OnMouseWheelForward ()

virtual void	OnMouseWheelBackward ()

virtual void	OnExpose ()

virtual void	OnConfigure ()

virtual void	OnEnter ()

virtual void	OnLeave ()

virtual void	Rotate ()

virtual void	Spin ()

virtual void	Pan ()

virtual void	Dolly ()

virtual void	Zoom ()

virtual void	UniformScale ()

virtual void	StartState (int newstate)

virtual void	StopState ()

virtual void	StartAnimate ()

virtual void	StopAnimate ()

virtual void	StartRotate ()

virtual void	EndRotate ()

virtual void	StartZoom ()

virtual void	EndZoom ()

virtual void	StartPan ()

virtual void	EndPan ()

virtual void	StartSpin ()

virtual void	EndSpin ()

virtual void	StartDolly ()

virtual void	EndDolly ()

virtual void	StartUniformScale ()

virtual void	EndUniformScale ()

virtual void	StartTimer ()

virtual void	EndTimer ()

virtual void	StartTwoPointer ()

virtual void	EndTwoPointer ()

virtual void	HighlightProp (vtkProp *prop)

virtual void	HighlightActor2D (vtkActor2D *actor2D)

virtual void	HighlightProp3D (vtkProp3D *prop3D)

virtual void	SetPickColor (double, double, double)

virtual void	SetPickColor (double[3])

virtual double *	GetPickColor ()

virtual void	GetPickColor (double data[3])

virtual void	SetMouseWheelMotionFactor (double)

virtual double	GetMouseWheelMotionFactor ()

virtual vtkTDxInteractorStyle *	GetTDxStyle ()

virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)

void	DelegateTDxEvent (unsigned long event, void *calldata)

Public Member Functions inherited from vtkInteractorObserver
vtkInteractorObserver *	NewInstance () const

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual void	SetPriority (float)

virtual float	GetPriority ()

virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetKeyPressActivation (int)

virtual int	GetKeyPressActivation ()

virtual void	KeyPressActivationOn ()

virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)

virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()

virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()

virtual void	SetCurrentRenderer (vtkRenderer *)

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkInteractorStyleUnicam *	New ()

static int	IsTypeOf (const char *type)

static vtkInteractorStyleUnicam *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()

static int	IsTypeOf (const char *type)

static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorObserver
static int	IsTypeOf (const char *type)

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyleUnicam ()

virtual	~vtkInteractorStyleUnicam ()

void	ChooseXY (int X, int Y)

void	RotateXY (int X, int Y)

void	DollyXY (int X, int Y)

void	PanXY (int X, int Y)

void	MyTranslateCamera (double v[3])

void	MyRotateCamera (double cx, double cy, double cz, double ax, double ay, double az, double angle)

void	GetRightVandUpV (double p, vtkCamera cam, double rightV, double upV)

void	NormalizeMouseXY (int X, int Y, double NX, double NY)

double	WindowAspect ()

Protected Member Functions inherited from vtkInteractorStyle
	vtkInteractorStyle ()

	~vtkInteractorStyle ()

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

virtual void	RegisterPickers ()

void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()

virtual void	EndInteraction ()

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkWorldPointPicker *	InteractionPicker

int	ButtonDown

double	DTime

double	Dist

double	StartPix [2]

double	LastPos [2]

double	LastPix [2]

double	DownPt [3]

double	Center [3]

double	WorldUpVector [3]

vtkActor *	FocusSphere

int	IsDot

vtkRenderer *	FocusSphereRenderer

int	state

Protected Attributes inherited from vtkInteractorStyle
int	State

int	AnimState

int	HandleObservers

int	UseTimers

int	TimerId

int	AutoAdjustCameraClippingRange

vtkOutlineSource *	Outline

vtkPolyDataMapper *	OutlineMapper

vtkActor *	OutlineActor

vtkRenderer *	PickedRenderer

vtkProp *	CurrentProp

vtkActor2D *	PickedActor2D

int	PropPicked

double	PickColor [3]

double	MouseWheelMotionFactor

unsigned long	TimerDuration

vtkEventForwarderCommand *	EventForwarder

vtkTDxInteractorStyle *	TDxStyle

Protected Attributes inherited from vtkInteractorObserver
int	Enabled

vtkCallbackCommand *	EventCallbackCommand

vtkCallbackCommand *	KeyPressCallbackCommand

float	Priority

bool	PickingManaged

int	KeyPressActivation

char	KeyPressActivationValue

vtkRenderWindowInteractor *	Interactor

vtkRenderer *	CurrentRenderer

vtkRenderer *	DefaultRenderer

unsigned long	CharObserverTag

unsigned long	DeleteObserverTag

vtkObserverMediator *	ObserverMediator

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkInteractorStyle
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)

Detailed Description

provides Unicam navigation style

UniCam is a camera interactor. Here, just the primary features of the UniCam technique are implemented. UniCam requires just one mouse button and supports context sensitive dollying, panning, and rotation. (In this implementation, it uses the right mouse button, leaving the middle and left available for other functions.) For more information, see the paper at:

ftp://ftp.cs.brown.edu/pub/papers/graphics/research/unicam.pdf

The following is a brief description of the UniCam Camera Controls. You can perform 3 operations on the camera: rotate, pan, and dolly the camera. All operations are reached through the right mouse button & mouse movements.

IMPORTANT: UniCam assumes there is an axis that makes sense as a "up" vector for the world. By default, this axis is defined to be the vector <0,0,1>. You can set it explicitly for the data you are viewing with the 'SetWorldUpVector(..)' method in C++, or similarly in Tcl/Tk (or other interpreted languages).

ROTATE:

Position the cursor over the point you wish to rotate around and press and release the left mouse button. A 'focus dot' appears indicating the point that will be the center of rotation. To rotate, press and hold the left mouse button and drag the mouse.. release the button to complete the rotation.

Rotations can be done without placing a focus dot first by moving the mouse cursor to within 10% of the window border & pressing and holding the left button followed by dragging the mouse. The last focus dot position will be re-used.

PAN:

Click and hold the left mouse button, and initially move the mouse left or right. The point under the initial pick will pick correlate w/ the mouse tip– (i.e., direct manipulation).

DOLLY (+ PAN):

Click and hold the left mouse button, and initially move the mouse up or down. Moving the mouse down will dolly towards the picked point, and moving the mouse up will dolly away from it. Dollying occurs relative to the picked point which simplifies the task of dollying towards a region of interest. Left and right mouse movements will pan the camera left and right.

Warning: (NOTE: This implementation of Unicam assumes a perspective camera. It could be modified relatively easily to also support an orthographic projection.)

Definition at line 108 of file vtkInteractorStyleUnicam.h.

Member Typedef Documentation

typedef vtkInteractorStyle vtkInteractorStyleUnicam::Superclass

Definition at line 112 of file vtkInteractorStyleUnicam.h.

Constructor & Destructor Documentation

vtkInteractorStyleUnicam::vtkInteractorStyleUnicam ( )

protected

virtual vtkInteractorStyleUnicam::~vtkInteractorStyleUnicam ( )

protectedvirtual

Member Function Documentation

static vtkInteractorStyleUnicam* vtkInteractorStyleUnicam::New ( )

static

static int vtkInteractorStyleUnicam::IsTypeOf ( const char * type )

static

virtual int vtkInteractorStyleUnicam::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

static vtkInteractorStyleUnicam* vtkInteractorStyleUnicam::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkInteractorStyleUnicam::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyle.

vtkInteractorStyleUnicam* vtkInteractorStyleUnicam::NewInstance ( ) const

void vtkInteractorStyleUnicam::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

void vtkInteractorStyleUnicam::SetWorldUpVector ( double a[3] )

inline

Definition at line 115 of file vtkInteractorStyleUnicam.h.