provides Unicam navigation style More...

#include <vtkInteractorStyleUnicam.h>

Inheritance diagram for vtkInteractorStyleUnicam:

Collaboration diagram for vtkInteractorStyleUnicam:

Public Types
enum	{ NONE = 0 , BUTTON_LEFT = 1 , BUTTON_MIDDLE = 2 , BUTTON_RIGHT = 3 }

enum	{ CAM_INT_ROT = 0 , CAM_INT_CHOOSE = 1 , CAM_INT_PAN = 2 , CAM_INT_DOLLY = 3 }

typedef vtkInteractorStyle	Superclass

Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorStyleUnicam *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetWorldUpVector (double a[3])

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

virtual double *	GetWorldUpVector ()

virtual void	GetWorldUpVector (double data[3])

void	OnTimer () override
	OnTimer calls RotateCamera, RotateActor etc which should be overridden by style subclasses.


void	OnMouseMove () override
	Concrete implementation of event bindings.

void	OnLeftButtonDown () override
	Concrete implementation of event bindings.

void	OnLeftButtonUp () override
	Concrete implementation of event bindings.

virtual void	OnLeftButtonMove ()
	Concrete implementation of event bindings.

Public Member Functions inherited from vtkInteractorStyle
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorStyle *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetInteractor (vtkRenderWindowInteractor *interactor) override
	Set/Get the Interactor wrapper being controlled by this object.

void	SetEnabled (int) override
	Turn on/off this interactor.

void	FindPokedRenderer (int, int)
	When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers.

virtual void	OnMouseMove ()
	Generic event bindings can be overridden in subclasses.

virtual void	OnLeftButtonDown ()

virtual void	OnLeftButtonUp ()

virtual void	OnMiddleButtonDown ()

virtual void	OnMiddleButtonUp ()

virtual void	OnRightButtonDown ()

virtual void	OnRightButtonUp ()

virtual void	OnLeftButtonDoubleClick ()

virtual void	OnMiddleButtonDoubleClick ()

virtual void	OnRightButtonDoubleClick ()

virtual void	OnMouseWheelForward ()

virtual void	OnMouseWheelBackward ()

virtual void	OnMouseWheelLeft ()

virtual void	OnMouseWheelRight ()

virtual void	OnFourthButtonDown ()

virtual void	OnFourthButtonUp ()

virtual void	OnFifthButtonDown ()

virtual void	OnFifthButtonUp ()

virtual void	OnMove3D (vtkEventData *)
	Generic 3D event bindings can be overridden in subclasses.

virtual void	OnButton3D (vtkEventData *)

virtual void	OnPick3D (vtkEventData *)

virtual void	OnClip3D (vtkEventData *)

virtual void	OnSelect3D (vtkEventData *)

virtual void	OnMenu3D (vtkEventData *)

virtual void	OnNextPose3D (vtkEventData *)

virtual void	OnPositionProp3D (vtkEventData *)

virtual void	OnViewerMovement3D (vtkEventData *)

void	OnChar () override
	OnChar is triggered when an ASCII key is pressed.

virtual void	OnKeyDown ()

virtual void	OnKeyUp ()

virtual void	OnKeyPress ()

virtual void	OnKeyRelease ()

virtual void	OnExpose ()
	These are more esoteric events, but are useful in some cases.

virtual void	OnConfigure ()

virtual void	OnEnter ()

virtual void	OnLeave ()

virtual void	OnTimer ()
	OnTimer calls Rotate, Rotate etc which should be overridden by style subclasses.

virtual void	Rotate ()
	These methods for the different interactions in different modes are overridden in subclasses to perform the correct motion.

virtual void	Spin ()

virtual void	Pan ()

virtual void	Dolly ()

virtual void	Zoom ()

virtual void	UniformScale ()

virtual void	EnvironmentRotate ()

virtual void	OnStartSwipe ()
	gesture based events

virtual void	OnSwipe ()

virtual void	OnEndSwipe ()

virtual void	OnStartPinch ()

virtual void	OnPinch ()

virtual void	OnEndPinch ()

virtual void	OnStartRotate ()

virtual void	OnRotate ()

virtual void	OnEndRotate ()

virtual void	OnStartPan ()

virtual void	OnPan ()

virtual void	OnEndPan ()

virtual void	OnTap ()

virtual void	OnLongTap ()

virtual void	OnDropLocation (double *vtkNotUsed(position))
	When the mouse location is updated while dragging files.

virtual void	OnDropFiles (vtkStringArray *vtkNotUsed(filePaths))
	When files are dropped on the render window.

void	DelegateTDxEvent (unsigned long event, void *calldata)
	Called by the callback to process 3DConnexion device events.

virtual void	SetAutoAdjustCameraClippingRange (vtkTypeBool)
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual vtkTypeBool	GetAutoAdjustCameraClippingRange ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOn ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual void	AutoAdjustCameraClippingRangeOff ()
	If AutoAdjustCameraClippingRange is on, then before each render the camera clipping range will be adjusted to "fit" the whole scene.

virtual int	GetState ()
	Some useful information for interaction.

virtual vtkTypeBool	GetUseTimers ()
	Set/Get timer hint.

virtual void	SetUseTimers (vtkTypeBool)
	Set/Get timer hint.

virtual void	UseTimersOn ()
	Set/Get timer hint.

virtual void	UseTimersOff ()
	Set/Get timer hint.

virtual void	SetTimerDuration (unsigned long)
	If using timers, specify the default timer interval (in milliseconds).

virtual unsigned long	GetTimerDuration ()
	If using timers, specify the default timer interval (in milliseconds).

virtual void	SetHandleObservers (vtkTypeBool)
	Does ProcessEvents handle observers on this class or not.

virtual vtkTypeBool	GetHandleObservers ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOn ()
	Does ProcessEvents handle observers on this class or not.

virtual void	HandleObserversOff ()
	Does ProcessEvents handle observers on this class or not.

virtual void	StartState (int newstate)
	utility routines used by state changes

virtual void	StopState ()
	utility routines used by state changes

virtual void	StartAnimate ()
	Interaction mode entry points used internally.

virtual void	StopAnimate ()
	Interaction mode entry points used internally.

virtual void	StartRotate ()
	Interaction mode entry points used internally.

virtual void	EndRotate ()
	Interaction mode entry points used internally.

virtual void	StartZoom ()
	Interaction mode entry points used internally.

virtual void	EndZoom ()
	Interaction mode entry points used internally.

virtual void	StartPan ()
	Interaction mode entry points used internally.

virtual void	EndPan ()
	Interaction mode entry points used internally.

virtual void	StartSpin ()
	Interaction mode entry points used internally.

virtual void	EndSpin ()
	Interaction mode entry points used internally.

virtual void	StartDolly ()
	Interaction mode entry points used internally.

virtual void	EndDolly ()
	Interaction mode entry points used internally.

virtual void	StartUniformScale ()
	Interaction mode entry points used internally.

virtual void	EndUniformScale ()
	Interaction mode entry points used internally.

virtual void	StartTimer ()
	Interaction mode entry points used internally.

virtual void	EndTimer ()
	Interaction mode entry points used internally.

virtual void	StartTwoPointer ()
	Interaction mode entry points used internally.

virtual void	EndTwoPointer ()
	Interaction mode entry points used internally.

virtual void	StartGesture ()
	Interaction mode entry points used internally.

virtual void	EndGesture ()
	Interaction mode entry points used internally.

virtual void	StartEnvRotate ()
	Interaction mode entry points used internally.

virtual void	EndEnvRotate ()
	Interaction mode entry points used internally.

virtual void	HighlightProp (vtkProp *prop)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightActor2D (vtkActor2D *actor2D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	HighlightProp3D (vtkProp3D *prop3D)
	When picking successfully selects an actor, this method highlights the picked prop appropriately.

virtual void	SetPickColor (double, double, double)
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetPickColor (double[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual double *	GetPickColor ()
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	GetPickColor (double data[3])
	Set/Get the pick color (used by default to color vtkActor2D's).

virtual void	SetMouseWheelMotionFactor (double)
	Set/Get the mouse wheel motion factor.

virtual double	GetMouseWheelMotionFactor ()
	Set/Get the mouse wheel motion factor.

virtual vtkTDxInteractorStyle *	GetTDxStyle ()
	3Dconnexion device interactor style.

virtual void	SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
	3Dconnexion device interactor style.

Public Member Functions inherited from vtkInteractorObserver
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkInteractorObserver *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual void	SetEnabled (int)
	Methods for turning the interactor observer on and off, and determining its state.

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

virtual void	OnChar ()
	Sets up the keypress-i event.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	This method is used to associate the widget with the render window interactor.

virtual void	SetPriority (float)
	Set/Get the priority at which events are processed.

virtual float	GetPriority ()
	Set/Get the priority at which events are processed.

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking.

virtual void	PickingManagedOff ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking.

virtual bool	GetPickingManaged ()
	Enable/Disable the use of a manager to process the picking.

virtual void	SetKeyPressActivation (vtkTypeBool)
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual vtkTypeBool	GetKeyPressActivation ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOn ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	KeyPressActivationOff ()
	Enable/Disable of the use of a keypress to turn on and off the interactor observer.

virtual void	SetKeyPressActivationValue (char)
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual char	GetKeyPressActivationValue ()
	Specify which key press value to use to activate the interactor observer (if key press activation is enabled).

virtual vtkRenderer *	GetDefaultRenderer ()
	Set/Get the default renderer to use when activating the interactor observer.

virtual void	SetDefaultRenderer (vtkRenderer *)
	Set/Get the default renderer to use when activating the interactor observer.

virtual vtkRenderer *	GetCurrentRenderer ()
	Set/Get the current renderer.

virtual void	SetCurrentRenderer (vtkRenderer *)
	Set/Get the current renderer.

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

void	ReleaseFocus ()
	These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Static Public Member Functions
static vtkInteractorStyleUnicam *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyleUnicam *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkInteractorStyle
static vtkInteractorStyle *	New ()
	This class must be supplied with a vtkRenderWindowInteractor wrapper or parent.

static vtkTypeBool	IsTypeOf (const char *type)

static vtkInteractorStyle *	SafeDownCast (vtkObjectBase *o)

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

static vtkInteractorObserver *	SafeDownCast (vtkObjectBase *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
	Convenience methods for outside classes.

static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
	Convenience methods for outside classes.

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyleUnicam ()

	~vtkInteractorStyleUnicam () override

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyle ()

	~vtkInteractorStyle () override

Protected Member Functions inherited from vtkInteractorObserver
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorObserver ()

	~vtkInteractorObserver () override

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager.

void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager.

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the observer currently belong.

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.

int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
	Utility routines used to start and end interaction.

virtual void	EndInteraction ()
	Utility routines used to start and end interaction.

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
	Helper method for subclasses.

void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
	Helper method for subclasses.

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

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

vtkTypeBool	HandleObservers

vtkTypeBool	UseTimers

int	TimerId

vtkTypeBool	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

vtkTypeBool	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
std::atomic< int32_t >	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)
	Main process event method.

Static Protected Member Functions inherited from vtkInteractorObserver
static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
	Handles the char widget activation event.

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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.

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 104 of file vtkInteractorStyleUnicam.h.

Member Typedef Documentation

◆ Superclass

typedef vtkInteractorStyle vtkInteractorStyleUnicam::Superclass

Definition at line 123 of file vtkInteractorStyleUnicam.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
NONE
BUTTON_LEFT
BUTTON_MIDDLE
BUTTON_RIGHT

Definition at line 107 of file vtkInteractorStyleUnicam.h.

◆ anonymous enum

anonymous enum

Enumerator
CAM_INT_ROT
CAM_INT_CHOOSE
CAM_INT_PAN
CAM_INT_DOLLY

Definition at line 114 of file vtkInteractorStyleUnicam.h.

Constructor & Destructor Documentation

◆ vtkInteractorStyleUnicam()

vtkInteractorStyleUnicam::vtkInteractorStyleUnicam ( )

protected

◆ ~vtkInteractorStyleUnicam()

vtkInteractorStyleUnicam::~vtkInteractorStyleUnicam ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkInteractorStyleUnicam * vtkInteractorStyleUnicam::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool 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.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkInteractorStyleUnicam::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyle.

◆ NewInstance()

vtkInteractorStyleUnicam * vtkInteractorStyleUnicam::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

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.

◆ SetWorldUpVector() [1/2]

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

inline

Definition at line 126 of file vtkInteractorStyleUnicam.h.

◆ SetWorldUpVector() [2/2]

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

◆ GetWorldUpVector() [1/2]

virtual double * vtkInteractorStyleUnicam::GetWorldUpVector ( )

virtual

◆ GetWorldUpVector() [2/2]

virtual void vtkInteractorStyleUnicam::GetWorldUpVector ( double data[3] )

virtual

◆ OnMouseMove()

void vtkInteractorStyleUnicam::OnMouseMove ( )

overridevirtual

Concrete implementation of event bindings.

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonDown()

void vtkInteractorStyleUnicam::OnLeftButtonDown ( )

overridevirtual

Concrete implementation of event bindings.

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonUp()

void vtkInteractorStyleUnicam::OnLeftButtonUp ( )

overridevirtual

Concrete implementation of event bindings.

Reimplemented from vtkInteractorStyle.

◆ OnLeftButtonMove()

virtual void vtkInteractorStyleUnicam::OnLeftButtonMove ( )

virtual

Concrete implementation of event bindings.

◆ OnTimer()

void vtkInteractorStyleUnicam::OnTimer ( )

overridevirtual

OnTimer calls RotateCamera, RotateActor etc which should be overridden by style subclasses.

Reimplemented from vtkInteractorStyle.

◆ ChooseXY()

void vtkInteractorStyleUnicam::ChooseXY	(	int	X,
		int	Y
	)

protected

◆ RotateXY()

void vtkInteractorStyleUnicam::RotateXY	(	int	X,
		int	Y
	)

protected

◆ DollyXY()

void vtkInteractorStyleUnicam::DollyXY	(	int	X,
		int	Y
	)

protected

◆ PanXY()

void vtkInteractorStyleUnicam::PanXY	(	int	X,
		int	Y
	)

protected

◆ MyTranslateCamera()

void vtkInteractorStyleUnicam::MyTranslateCamera ( double v[3] )

protected

◆ MyRotateCamera()

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

protected

◆ GetRightVandUpV()

void vtkInteractorStyleUnicam::GetRightVandUpV	(	double *	p,
		vtkCamera *	cam,
		double *	rightV,
		double *	upV
	)

protected

◆ NormalizeMouseXY()

void vtkInteractorStyleUnicam::NormalizeMouseXY	(	int	X,
		int	Y,
		double *	NX,
		double *	NY
	)

protected

◆ WindowAspect()

double vtkInteractorStyleUnicam::WindowAspect ( )

protected

Member Data Documentation

◆ InteractionPicker

vtkWorldPointPicker* vtkInteractorStyleUnicam::InteractionPicker

protected

Definition at line 150 of file vtkInteractorStyleUnicam.h.

◆ ButtonDown

int vtkInteractorStyleUnicam::ButtonDown

protected

Definition at line 152 of file vtkInteractorStyleUnicam.h.

◆ DTime

double vtkInteractorStyleUnicam::DTime

protected

Definition at line 153 of file vtkInteractorStyleUnicam.h.

◆ Dist

double vtkInteractorStyleUnicam::Dist

protected

Definition at line 154 of file vtkInteractorStyleUnicam.h.

◆ StartPix

double vtkInteractorStyleUnicam::StartPix[2]

protected

Definition at line 155 of file vtkInteractorStyleUnicam.h.

◆ LastPos

double vtkInteractorStyleUnicam::LastPos[2]

protected

Definition at line 156 of file vtkInteractorStyleUnicam.h.

◆ LastPix

double vtkInteractorStyleUnicam::LastPix[2]

protected

Definition at line 157 of file vtkInteractorStyleUnicam.h.

◆ DownPt

double vtkInteractorStyleUnicam::DownPt[3]

protected

Definition at line 158 of file vtkInteractorStyleUnicam.h.

◆ Center

double vtkInteractorStyleUnicam::Center[3]

protected

Definition at line 159 of file vtkInteractorStyleUnicam.h.

◆ WorldUpVector

double vtkInteractorStyleUnicam::WorldUpVector[3]

protected

Definition at line 161 of file vtkInteractorStyleUnicam.h.

◆ FocusSphere

vtkActor* vtkInteractorStyleUnicam::FocusSphere

protected

Definition at line 163 of file vtkInteractorStyleUnicam.h.

◆ IsDot

int vtkInteractorStyleUnicam::IsDot

protected

Definition at line 164 of file vtkInteractorStyleUnicam.h.

◆ FocusSphereRenderer

vtkRenderer* vtkInteractorStyleUnicam::FocusSphereRenderer

protected

Definition at line 165 of file vtkInteractorStyleUnicam.h.

◆ state

int vtkInteractorStyleUnicam::state

protected

Definition at line 167 of file vtkInteractorStyleUnicam.h.

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

Interaction/Style/vtkInteractorStyleUnicam.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkInteractorStyleUnicam()

◆ ~vtkInteractorStyleUnicam()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetWorldUpVector() [1/2]

◆ SetWorldUpVector() [2/2]

◆ GetWorldUpVector() [1/2]

◆ GetWorldUpVector() [2/2]

◆ OnMouseMove()

◆ OnLeftButtonDown()

◆ OnLeftButtonUp()

◆ OnLeftButtonMove()

◆ OnTimer()

◆ ChooseXY()

◆ RotateXY()

◆ DollyXY()

◆ PanXY()

◆ MyTranslateCamera()

◆ MyRotateCamera()

◆ GetRightVandUpV()

◆ NormalizeMouseXY()

◆ WindowAspect()

Member Data Documentation

◆ InteractionPicker

◆ ButtonDown

◆ DTime

◆ Dist

◆ StartPix

◆ LastPos

◆ LastPix

◆ DownPt

◆ Center

◆ WorldUpVector

◆ FocusSphere

◆ IsDot

◆ FocusSphereRenderer

◆ state