Abstraction of style away from button. More...

#include <vtkCameraManipulator.h>

Inheritance diagram for vtkCameraManipulator:

Collaboration diagram for vtkCameraManipulator:

Public Types
enum class	MouseButtonType { Left = 1 , Middle = 2 , Right = 3 }

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.

vtkCameraManipulator *	NewInstance () const

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

virtual void	OnMouseMove (int x, int y, vtkRenderer ren, vtkRenderWindowInteractor iren)=0
	These methods are called on the active manipulator when the corresponding events occur.

virtual void	OnButtonDown (int x, int y, vtkRenderer ren, vtkRenderWindowInteractor iren)=0

virtual void	OnButtonUp (int x, int y, vtkRenderer ren, vtkRenderWindowInteractor iren)=0


virtual void	StartInteraction ()=0
	The vtkInterctorStyleManipulator will call these methods when the corresponding events occur.

virtual void	EndInteraction ()=0
	The vtkInterctorStyleManipulator will call these methods when the corresponding events occur.


virtual void	OnKeyUp (vtkRenderWindowInteractor *iren)=0
	These methods are called on all registered manipulators, not just the active one.

virtual void	OnKeyDown (vtkRenderWindowInteractor *iren)=0
	These methods are called on all registered manipulators, not just the active one.


	vtkSetEnumMacro (MouseButton, MouseButtonType)
	These settings determine which button the manipulator responds to.

	vtkGetEnumMacro (MouseButton, MouseButtonType)
	These settings determine which button the manipulator responds to.


virtual void	SetAlt (bool)
	Set to true if this manipulator should respond when the `Alt` modifier is used.

virtual bool	GetAlt ()
	Set to true if this manipulator should respond when the `Alt` modifier is used.

virtual void	AltOn ()
	Set to true if this manipulator should respond when the `Alt` modifier is used.

virtual void	AltOff ()
	Set to true if this manipulator should respond when the `Alt` modifier is used.


virtual void	SetControl (bool)
	Set to true if this manipulator should respond when the `Ctrl` modifier is used.

virtual bool	GetControl ()
	Set to true if this manipulator should respond when the `Ctrl` modifier is used.

virtual void	ControlOn ()
	Set to true if this manipulator should respond when the `Ctrl` modifier is used.

virtual void	ControlOff ()
	Set to true if this manipulator should respond when the `Ctrl` modifier is used.


virtual void	SetShift (bool)
	Set to true if this manipulator should respond when the `Shift` modifier is used.

virtual bool	GetShift ()
	Set to true if this manipulator should respond when the `Shift` modifier is used.

virtual void	ShiftOn ()
	Set to true if this manipulator should respond when the `Shift` modifier is used.

virtual void	ShiftOff ()
	Set to true if this manipulator should respond when the `Shift` modifier is used.


virtual void	SetCenterOfRotation (double, double, double)
	Set and get the center of rotation in world coordinates.

virtual void	SetCenterOfRotation (double[3])
	Set and get the center of rotation in world coordinates.

virtual double *	GetCenterOfRotation ()
	Set and get the center of rotation in world coordinates.

virtual void	GetCenterOfRotation (double &, double &, double &)
	Set and get the center of rotation in world coordinates.

virtual void	GetCenterOfRotation (double[3])
	Set and get the center of rotation in world coordinates.


virtual void	SetMouseMotionFactor (double)
	Set and get the mouse motion factor.

virtual double	GetMouseMotionFactor ()
	Set and get the mouse motion factor.


virtual void	SetManipulatorName (const char *)
	Set and get the manipulator name.

virtual char *	GetManipulatorName ()
	Set and get the manipulator name.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

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.

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.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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

static vtkCameraManipulator *	SafeDownCast (vtkObjectBase *o)

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 (vtkTypeBool 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 vtkTypeBool	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

	vtkCameraManipulator ()

	~vtkCameraManipulator () override

void	ComputeCenterOfRotationInDisplayCoordinates (vtkRenderer *ren)
	Compute the center of rotation in display coordinates.

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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
double	CenterOfRotationInDisplayCoordinates [2] = { 0.0, 0.0 }

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Abstraction of style away from button.

vtkCameraManipulator is a superclass for actions inside an interactor style and associated with a single button. An example might be rubber-band bounding-box zoom. This abstraction allows a camera manipulator to be assigned to any button.

When the interactor style receives a mouse button press event, it finds a suitable manipulator that was bound to the button and modifier keys. Then, it calls StartInteraction on the manipulator, followed by OnButtonDown. As the mouse moves, it calls OnMouseMove on the active manipulator. Finally, when the mouse button is released, it calls OnButtonUp and then EndInteraction on the manipulator.

See also: vtkInteractorStyleManipulator

Tests:: vtkCameraManipulator (Tests)

Definition at line 35 of file vtkCameraManipulator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCameraManipulator::Superclass

Definition at line 38 of file vtkCameraManipulator.h.

Member Enumeration Documentation

◆ MouseButtonType

enum class vtkCameraManipulator::MouseButtonType

strong

Enumerator
Left
Middle
Right

Definition at line 69 of file vtkCameraManipulator.h.

Constructor & Destructor Documentation

◆ vtkCameraManipulator()

vtkCameraManipulator::vtkCameraManipulator ( )

protected

◆ ~vtkCameraManipulator()

vtkCameraManipulator::~vtkCameraManipulator ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkCameraManipulator::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 vtkObjectBase.

Reimplemented in vtkJoystickFly, vtkJoystickFlyIn, vtkJoystickFlyOut, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, vtkTrackballZoom, and vtkTrackballZoomToMouse.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCameraManipulator::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkJoystickFly, vtkJoystickFlyIn, vtkJoystickFlyOut, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, vtkTrackballZoom, and vtkTrackballZoomToMouse.

◆ NewInstance()

vtkCameraManipulator * vtkCameraManipulator::NewInstance ( ) const

◆ PrintSelf()

void vtkCameraManipulator::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 vtkObjectBase.

Reimplemented in vtkJoystickFly, vtkJoystickFlyIn, vtkJoystickFlyOut, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, vtkTrackballZoom, and vtkTrackballZoomToMouse.

◆ StartInteraction()

virtual void vtkCameraManipulator::StartInteraction ( )

pure virtual

The vtkInterctorStyleManipulator will call these methods when the corresponding events occur.

The StartInteraction is called before the OnButtonDown and EndInteraction is called after the OnButtonUp.

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, and vtkTrackballZoom.

◆ EndInteraction()

virtual void vtkCameraManipulator::EndInteraction ( )

pure virtual

The vtkInterctorStyleManipulator will call these methods when the corresponding events occur.

The StartInteraction is called before the OnButtonDown and EndInteraction is called after the OnButtonUp.

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, and vtkTrackballZoom.

◆ OnMouseMove()

virtual void vtkCameraManipulator::OnMouseMove	(	int	x,
		int	y,
		vtkRenderer *	ren,
		vtkRenderWindowInteractor *	iren )

pure virtual

These methods are called on the active manipulator when the corresponding events occur.

The manipulator can then perform the appropriate camera manipulation.

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, vtkTrackballZoom, and vtkTrackballZoomToMouse.

◆ OnButtonDown()

virtual void vtkCameraManipulator::OnButtonDown	(	int	x,
		int	y,
		vtkRenderer *	ren,
		vtkRenderWindowInteractor *	iren )

pure virtual

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, vtkTrackballZoom, and vtkTrackballZoomToMouse.

◆ OnButtonUp()

virtual void vtkCameraManipulator::OnButtonUp	(	int	x,
		int	y,
		vtkRenderer *	ren,
		vtkRenderWindowInteractor *	iren )

pure virtual

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, and vtkTrackballZoom.

◆ OnKeyUp()

virtual void vtkCameraManipulator::OnKeyUp ( vtkRenderWindowInteractor * iren )

pure virtual

These methods are called on all registered manipulators, not just the active one.

Hence, these should just be used to record state and not perform any interactions.

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, and vtkTrackballZoom.

◆ OnKeyDown()

virtual void vtkCameraManipulator::OnKeyDown ( vtkRenderWindowInteractor * iren )

pure virtual

These methods are called on all registered manipulators, not just the active one.

Hence, these should just be used to record state and not perform any interactions.

Implemented in vtkJoystickFly, vtkTableTopRotate, vtkTrackballEnvironmentRotate, vtkTrackballMoveActor, vtkTrackballMultiRotate, vtkTrackballPan, vtkTrackballRoll, vtkTrackballRotate, and vtkTrackballZoom.

◆ vtkSetEnumMacro()

vtkCameraManipulator::vtkSetEnumMacro	(	MouseButton	,
		MouseButtonType	)

These settings determine which button the manipulator responds to.

Button can be:

MouseButtonType::Left
MouseButtonType::Middle
MouseButtonType::Right

◆ vtkGetEnumMacro()

vtkCameraManipulator::vtkGetEnumMacro	(	MouseButton	,
		MouseButtonType	)

These settings determine which button the manipulator responds to.

Button can be:

MouseButtonType::Left
MouseButtonType::Middle
MouseButtonType::Right

◆ SetAlt()

virtual void vtkCameraManipulator::SetAlt ( bool )

virtual

Set to true if this manipulator should respond when the Alt modifier is used.

◆ GetAlt()

virtual bool vtkCameraManipulator::GetAlt ( )

virtual

Set to true if this manipulator should respond when the Alt modifier is used.

◆ AltOn()

virtual void vtkCameraManipulator::AltOn ( )

virtual

Set to true if this manipulator should respond when the Alt modifier is used.

◆ AltOff()

virtual void vtkCameraManipulator::AltOff ( )

virtual

Set to true if this manipulator should respond when the Alt modifier is used.

◆ SetControl()

virtual void vtkCameraManipulator::SetControl ( bool )

virtual

Set to true if this manipulator should respond when the Ctrl modifier is used.

◆ GetControl()

virtual bool vtkCameraManipulator::GetControl ( )

virtual

Set to true if this manipulator should respond when the Ctrl modifier is used.

◆ ControlOn()

virtual void vtkCameraManipulator::ControlOn ( )

virtual

Set to true if this manipulator should respond when the Ctrl modifier is used.

◆ ControlOff()

virtual void vtkCameraManipulator::ControlOff ( )

virtual

Set to true if this manipulator should respond when the Ctrl modifier is used.

◆ SetShift()

virtual void vtkCameraManipulator::SetShift ( bool )

virtual

Set to true if this manipulator should respond when the Shift modifier is used.

◆ GetShift()

virtual bool vtkCameraManipulator::GetShift ( )

virtual

Set to true if this manipulator should respond when the Shift modifier is used.

◆ ShiftOn()

virtual void vtkCameraManipulator::ShiftOn ( )

virtual

Set to true if this manipulator should respond when the Shift modifier is used.

◆ ShiftOff()

virtual void vtkCameraManipulator::ShiftOff ( )

virtual

Set to true if this manipulator should respond when the Shift modifier is used.