Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCameraManipulator Class Reference

Abstraction of style away from button. More...

#include <vtkCameraManipulator.h>

Inheritance diagram for vtkCameraManipulator:
Inheritance graph
[legend]
Collaboration diagram for vtkCameraManipulator:
Collaboration graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void OnMouseMove (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *iren)
 
virtual void OnButtonDown (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *iren)
 
virtual void OnButtonUp (int x, int y, vtkRenderer *ren, vtkRenderWindowInteractor *iren)
 
virtual void StartInteraction ()
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
virtual void EndInteraction ()
 Event bindings controlling the effects of pressing mouse buttons or moving the mouse. More...
 
virtual void OnKeyUp (vtkRenderWindowInteractor *iren)
 These methods are called on all registered manipulators, not just the active one. More...
 
virtual void OnKeyDown (vtkRenderWindowInteractor *iren)
 These methods are called on all registered manipulators, not just the active one. More...
 
virtual void SetButton (int)
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual int GetButton ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void SetShift (int)
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual int GetShift ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void ShiftOn ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void ShiftOff ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void SetControl (int)
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual int GetControl ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void ControlOn ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void ControlOff ()
 These settings determine which button and modifiers the manipulator responds to. More...
 
virtual void SetCenter (double, double, double)
 For setting the center of rotation. More...
 
virtual void SetCenter (double [3])
 For setting the center of rotation. More...
 
virtual doubleGetCenter ()
 For setting the center of rotation. More...
 
virtual void GetCenter (double &, double &, double &)
 For setting the center of rotation. More...
 
virtual void GetCenter (double [3])
 For setting the center of rotation. More...
 
virtual void SetRotationFactor (double)
 Set and get the rotation factor. More...
 
virtual double GetRotationFactor ()
 Set and get the rotation factor. More...
 
virtual void SetManipulatorName (const char *)
 Set and get the manipulator name. More...
 
virtual char * GetManipulatorName ()
 Set and get the manipulator name. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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)
 
- 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)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkCameraManipulatorNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCameraManipulatorSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

void ComputeDisplayCenter (vtkRenderer *ren)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
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

char * ManipulatorName
 
int Button
 
int Shift
 
int Control
 
double Center [3]
 
double RotationFactor
 
double DisplayCenter [2]
 
vtkCameraManipulatorGUIHelperGUIHelper
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
void SetGUIHelper (vtkCameraManipulatorGUIHelper *)
 Get/Set the GUI helper. More...
 
virtual vtkCameraManipulatorGUIHelperGetGUIHelper ()
 Get/Set the GUI helper. More...
 
 vtkCameraManipulator ()
 Get/Set the GUI helper. More...
 
 ~vtkCameraManipulator () override
 Get/Set the GUI helper. More...
 

Detailed Description

Abstraction of style away from button.

vtkCameraManipulator is a superclass foractions 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. This super class might become a subclass of vtkInteractorObserver in the future.

Definition at line 24 of file vtkCameraManipulator.h.

Member Typedef Documentation

◆ Superclass

Definition at line 28 of file vtkCameraManipulator.h.

Constructor & Destructor Documentation

◆ vtkCameraManipulator()

vtkCameraManipulator::vtkCameraManipulator ( )
protected

Get/Set the GUI helper.

◆ ~vtkCameraManipulator()

vtkCameraManipulator::~vtkCameraManipulator ( )
overrideprotected

Get/Set the GUI helper.

Member Function Documentation

◆ New()

static vtkCameraManipulator* vtkCameraManipulator::New ( )
static

◆ GetClassName()

virtual const char* vtkCameraManipulator::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkCameraManipulator::IsA ( const char *  type)
virtual

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkCameraManipulator::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ StartInteraction()

virtual void vtkCameraManipulator::StartInteraction ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

◆ EndInteraction()

virtual void vtkCameraManipulator::EndInteraction ( )
virtual

Event bindings controlling the effects of pressing mouse buttons or moving the mouse.

◆ OnMouseMove()

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

◆ OnButtonDown()

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

◆ OnButtonUp()

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

◆ OnKeyUp()

virtual void vtkCameraManipulator::OnKeyUp ( vtkRenderWindowInteractor iren)
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.

Reimplemented in vtkPVTrackballRotate, and vtkTrackballPan.

◆ OnKeyDown()

virtual void vtkCameraManipulator::OnKeyDown ( vtkRenderWindowInteractor iren)
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.

Reimplemented in vtkPVTrackballRotate, and vtkTrackballPan.

◆ SetButton()

virtual void vtkCameraManipulator::SetButton ( int  )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ GetButton()

virtual int vtkCameraManipulator::GetButton ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ SetShift()

virtual void vtkCameraManipulator::SetShift ( int  )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ GetShift()

virtual int vtkCameraManipulator::GetShift ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ ShiftOn()

virtual void vtkCameraManipulator::ShiftOn ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ ShiftOff()

virtual void vtkCameraManipulator::ShiftOff ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ SetControl()

virtual void vtkCameraManipulator::SetControl ( int  )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ GetControl()

virtual int vtkCameraManipulator::GetControl ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ ControlOn()

virtual void vtkCameraManipulator::ControlOn ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ ControlOff()

virtual void vtkCameraManipulator::ControlOff ( )
virtual

These settings determine which button and modifiers the manipulator responds to.

Button can be either 1 (left), 2 (middle), and 3 right.

◆ SetCenter() [1/2]

virtual void vtkCameraManipulator::SetCenter ( double  ,
double  ,
double   
)
virtual

For setting the center of rotation.

◆ SetCenter() [2/2]

virtual void vtkCameraManipulator::SetCenter ( double  [3])
virtual

For setting the center of rotation.

◆ GetCenter() [1/3]

virtual double* vtkCameraManipulator::GetCenter ( )
virtual

For setting the center of rotation.

◆ GetCenter() [2/3]

virtual void vtkCameraManipulator::GetCenter ( double ,
double ,
double  
)
virtual

For setting the center of rotation.

◆ GetCenter() [3/3]

virtual void vtkCameraManipulator::GetCenter ( double  [3])
virtual

For setting the center of rotation.

◆ SetRotationFactor()

virtual void vtkCameraManipulator::SetRotationFactor ( double  )
virtual

Set and get the rotation factor.

◆ GetRotationFactor()

virtual double vtkCameraManipulator::GetRotationFactor ( )
virtual

Set and get the rotation factor.

◆ SetManipulatorName()

virtual void vtkCameraManipulator::SetManipulatorName ( const char *  )
virtual

Set and get the manipulator name.

◆ GetManipulatorName()

virtual char* vtkCameraManipulator::GetManipulatorName ( )
virtual

Set and get the manipulator name.

◆ SetGUIHelper()

void vtkCameraManipulator::SetGUIHelper ( vtkCameraManipulatorGUIHelper )

Get/Set the GUI helper.

◆ GetGUIHelper()

virtual vtkCameraManipulatorGUIHelper* vtkCameraManipulator::GetGUIHelper ( )
virtual

Get/Set the GUI helper.

◆ ComputeDisplayCenter()

void vtkCameraManipulator::ComputeDisplayCenter ( vtkRenderer ren)
protected

Member Data Documentation

◆ ManipulatorName

char* vtkCameraManipulator::ManipulatorName
protected

Definition at line 106 of file vtkCameraManipulator.h.

◆ Button

int vtkCameraManipulator::Button
protected

Definition at line 108 of file vtkCameraManipulator.h.

◆ Shift

int vtkCameraManipulator::Shift
protected

Definition at line 109 of file vtkCameraManipulator.h.

◆ Control

int vtkCameraManipulator::Control
protected

Definition at line 110 of file vtkCameraManipulator.h.

◆ Center

double vtkCameraManipulator::Center[3]
protected

Definition at line 112 of file vtkCameraManipulator.h.

◆ RotationFactor

double vtkCameraManipulator::RotationFactor
protected

Definition at line 113 of file vtkCameraManipulator.h.

◆ DisplayCenter

double vtkCameraManipulator::DisplayCenter[2]
protected

Definition at line 114 of file vtkCameraManipulator.h.

◆ GUIHelper

vtkCameraManipulatorGUIHelper* vtkCameraManipulator::GUIHelper
protected

Definition at line 117 of file vtkCameraManipulator.h.


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