manipulate camera in scene with natural view up (e.g., terrain) More...

#include <vtkInteractorStyleTerrain.h>

Inheritance diagram for vtkInteractorStyleTerrain:

Collaboration diagram for vtkInteractorStyleTerrain:

Public Types
typedef vtkInteractorStyle	Superclass

Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver	Superclass

Public Types inherited from vtkInteractorObserver
typedef vtkObject	Superclass

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

vtkInteractorStyleTerrain *	NewInstance () const

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

virtual void	OnChar ()
	Override the "fly-to" (f keypress) for images. More...

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

virtual void	Pan ()

virtual void	Dolly ()


virtual void	OnMouseMove ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnLeftButtonDown ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnLeftButtonUp ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnMiddleButtonDown ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnMiddleButtonUp ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnRightButtonDown ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...

virtual void	OnRightButtonUp ()
	Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...


virtual void	SetLatLongLines (int)
	Turn on/off the latitude/longitude lines. More...

virtual int	GetLatLongLines ()
	Turn on/off the latitude/longitude lines. More...

virtual void	LatLongLinesOn ()
	Turn on/off the latitude/longitude lines. More...

virtual void	LatLongLinesOff ()
	Turn on/off the latitude/longitude lines. More...

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

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

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

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

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

virtual void	OnMouseWheelForward ()

virtual void	OnMouseWheelBackward ()

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. More...

virtual void	OnConfigure ()

virtual void	OnEnter ()

virtual void	OnLeave ()

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

virtual void	Spin ()

virtual void	Zoom ()

virtual void	UniformScale ()

virtual void	OnPinch ()
	gesture based events More...

virtual void	OnRotate ()

virtual void	OnPan ()

virtual void	OnTap ()

virtual void	OnLongTap ()

virtual void	OnSwipe ()

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

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

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

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

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

virtual int	GetState ()
	Some useful information for interaction. More...

virtual int	GetUseTimers ()
	Set/Get timer hint. More...

virtual void	SetUseTimers (int)
	Set/Get timer hint. More...

virtual void	UseTimersOn ()
	Set/Get timer hint. More...

virtual void	UseTimersOff ()
	Set/Get timer hint. More...

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

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

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

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

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

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

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

virtual void	StopState ()
	utility routines used by state changes More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int	GetEnabled ()

void	EnabledOn ()

void	EnabledOff ()

void	On ()

void	Off ()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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)

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. More...

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

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

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

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

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

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

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

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. More...

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. More...

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. More...

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

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

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

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

Static Public Member Functions
static vtkInteractorStyleTerrain *	New ()
	Instantiate the object. More...

static int	IsTypeOf (const char *type)

static vtkInteractorStyleTerrain *	SafeDownCast (vtkObjectBase *o)

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

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])
	Convenience methods for outside classes. More...

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

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. More...

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

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

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

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

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

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. More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkInteractorStyleTerrain ()

	~vtkInteractorStyleTerrain ()

void	SelectRepresentation ()

void	CreateLatLong ()

Protected Member Functions inherited from vtkInteractorStyle
	vtkInteractorStyle ()

	~vtkInteractorStyle ()

Protected Member Functions inherited from vtkInteractorObserver
	vtkInteractorObserver ()

	~vtkInteractorObserver ()

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

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

virtual void	PickersModified ()
	Update the pickers registered in the Picking Manager when pickers are modified. More...

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

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. More...

int	RequestCursorShape (int requestedShape)

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

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

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

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

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=NULL)
	These methods allow a command to exclusively grab all events. More...

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

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
int	LatLongLines

vtkSphereSource *	LatLongSphere

vtkPolyDataMapper *	LatLongMapper

vtkActor *	LatLongActor

vtkExtractEdges *	LatLongExtractEdges

double	MotionFactor

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)
	Main process event method. More...

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. More...

Detailed Description

manipulate camera in scene with natural view up (e.g., terrain)

vtkInteractorStyleTerrain is used to manipulate a camera which is viewing a scene with a natural view up, e.g., terrain. The camera in such a scene is manipulated by specifying azimuth (angle around the view up vector) and elevation (the angle from the horizon).

The mouse binding for this class is as follows. Left mouse click followed rotates the camera around the focal point using both elevation and azimuth invocations on the camera. Left mouse motion in the horizontal direction results in azimuth motion; left mouse motion in the vertical direction results in elevation motion. Therefore, diagonal motion results in a combination of azimuth and elevation. (If the shift key is held during motion, then only one of elevation or azimuth is invoked, depending on the whether the mouse motion is primarily horizontal or vertical.) Middle mouse button pans the camera across the scene (again the shift key has a similar effect on limiting the motion to the vertical or horizontal direction. The right mouse is used to dolly (e.g., a type of zoom) towards or away from the focal point.

The class also supports some keypress events. The "r" key resets the camera. The "e" key invokes the exit callback and by default exits the program. The "f" key sets a new camera focal point and flys towards that point. The "u" key invokes the user event. The "3" key toggles between stereo and non-stero mode. The "l" key toggles on/off a latitude/longitude markers that can be used to estimate/control position.

See also: vtkInteractorObserver vtkInteractorStyle vtk3DWidget

Tests:: vtkInteractorStyleTerrain (Tests)

Definition at line 62 of file vtkInteractorStyleTerrain.h.

Member Typedef Documentation

typedef vtkInteractorStyle vtkInteractorStyleTerrain::Superclass

Definition at line 70 of file vtkInteractorStyleTerrain.h.

Constructor & Destructor Documentation

vtkInteractorStyleTerrain::vtkInteractorStyleTerrain ( )

protected

vtkInteractorStyleTerrain::~vtkInteractorStyleTerrain ( )

protected

Member Function Documentation

static vtkInteractorStyleTerrain* vtkInteractorStyleTerrain::New ( )

static

Instantiate the object.

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

static

virtual int vtkInteractorStyleTerrain::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 vtkInteractorStyleTerrain* vtkInteractorStyleTerrain::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkInteractorStyleTerrain::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkInteractorStyle.

vtkInteractorStyleTerrain* vtkInteractorStyleTerrain::NewInstance ( ) const

void vtkInteractorStyleTerrain::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.

virtual void vtkInteractorStyleTerrain::OnMouseMove ( )

virtual