VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
vtkContextInteractorStyle Class Reference

An interactor for chart views It observes the user events (mouse events) and propagates them to the scene. If the scene doesn't eat the event, it is propagated to the interactor style superclass. More...

#include <vtkContextInteractorStyle.h>

Inherits vtkInteractorStyle.

Public Types

typedef vtkInteractorStyle Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkContextInteractorStyleNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetScene (vtkContextScene *scene)
 
vtkContextScene * GetScene ()
 
virtual void OnSceneModified ()
 
virtual void OnMouseMove ()
 
virtual void OnLeftButtonDown ()
 
virtual void OnLeftButtonUp ()
 
virtual void OnMiddleButtonDown ()
 
virtual void OnMiddleButtonUp ()
 
virtual void OnRightButtonDown ()
 
virtual void OnRightButtonUp ()
 
virtual void OnMouseWheelForward ()
 
virtual void OnMouseWheelBackward ()
 
virtual void OnSelection (unsigned int rect[5])
 
virtual void OnChar ()
 
virtual void OnKeyPress ()
 
virtual void OnKeyRelease ()
 

Static Public Member Functions

static vtkContextInteractorStyleNew ()
 
static int IsTypeOf (const char *type)
 
static vtkContextInteractorStyleSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkContextInteractorStyle ()
 
 ~vtkContextInteractorStyle ()
 
virtual void RenderNow ()
 
void BeginProcessingEvent ()
 
void EndProcessingEvent ()
 

Static Protected Member Functions

static void ProcessSceneEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 
static void ProcessInteractorEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 

Protected Attributes

vtkWeakPointer< vtkContextScene > Scene
 
vtkNew< vtkCallbackCommand > SceneCallbackCommand
 
vtkNew< vtkCallbackCommand > InteractorCallbackCommand
 
int ProcessingEvents
 
unsigned long int LastSceneRepaintMTime
 
unsigned long int TimerId
 
bool TimerCallbackInitialized
 

Detailed Description

An interactor for chart views It observes the user events (mouse events) and propagates them to the scene. If the scene doesn't eat the event, it is propagated to the interactor style superclass.

Tests:
vtkContextInteractorStyle (Tests)

Definition at line 38 of file vtkContextInteractorStyle.h.

Member Typedef Documentation

typedef vtkInteractorStyle vtkContextInteractorStyle::Superclass

Definition at line 42 of file vtkContextInteractorStyle.h.

Constructor & Destructor Documentation

vtkContextInteractorStyle::vtkContextInteractorStyle ( )
protected
vtkContextInteractorStyle::~vtkContextInteractorStyle ( )
protected

Member Function Documentation

static vtkContextInteractorStyle* vtkContextInteractorStyle::New ( )
static
static int vtkContextInteractorStyle::IsTypeOf ( const char *  type)
static
virtual int vtkContextInteractorStyle::IsA ( const char *  type)
virtual
static vtkContextInteractorStyle* vtkContextInteractorStyle::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkContextInteractorStyle::NewInstanceInternal ( ) const
protectedvirtual
vtkContextInteractorStyle* vtkContextInteractorStyle::NewInstance ( ) const
void vtkContextInteractorStyle::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkContextInteractorStyle::SetScene ( vtkContextScene *  scene)

Set the scene to forward user events to. Refresh the view when the scene is dirty and no event is being processed. The scene is observed (vtkCommand::ModifiedEvent) and a refresh on the view is called appropriately: scene is dirty and no event is being processed.

vtkContextScene* vtkContextInteractorStyle::GetScene ( )

Return the observed scene.

virtual void vtkContextInteractorStyle::OnSceneModified ( )
virtual

Called when the scene is modified. Refresh the scene if needed.

virtual void vtkContextInteractorStyle::OnMouseMove ( )
virtual

Called when the user moves the mouse Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnLeftButtonDown ( )
virtual

Called when the user clicks the mouse left button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnLeftButtonUp ( )
virtual

Called when the user releases the mouse left button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnMiddleButtonDown ( )
virtual

Called when the user clicks the mouse middle button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnMiddleButtonUp ( )
virtual

Called when the user releases the mouse middle button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnRightButtonDown ( )
virtual

Called when the user clicks the mouse right button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnRightButtonUp ( )
virtual

Called when the user releases the mouse right button. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnMouseWheelForward ( )
virtual

Called when the user moves the mouse wheel forward. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnMouseWheelBackward ( )
virtual

Called when the user moves the mouse wheel backward. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnSelection ( unsigned int  rect[5])
virtual

Place holder for future implementation. Default behavior forwards the event to the observed scene.

virtual void vtkContextInteractorStyle::OnChar ( )
virtual

Handle key presses.

virtual void vtkContextInteractorStyle::OnKeyPress ( )
virtual

Called when the user presses a key.

virtual void vtkContextInteractorStyle::OnKeyRelease ( )
virtual

Called when the user releases a key.

static void vtkContextInteractorStyle::ProcessSceneEvents ( vtkObject *  object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected
static void vtkContextInteractorStyle::ProcessInteractorEvents ( vtkObject *  object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected
virtual void vtkContextInteractorStyle::RenderNow ( )
protectedvirtual
void vtkContextInteractorStyle::BeginProcessingEvent ( )
protected

Inform the interactor style that an event is being processed. That way is knows to not refresh the view (the view will eventually be refreshed at the end.

void vtkContextInteractorStyle::EndProcessingEvent ( )
protected

Inform the interactor style that an event is finished to be processed. If no other event is being processed it check if the scene needs to be rendered (scene is dirty)

Member Data Documentation

vtkWeakPointer<vtkContextScene> vtkContextInteractorStyle::Scene
protected

Definition at line 128 of file vtkContextInteractorStyle.h.

vtkNew<vtkCallbackCommand> vtkContextInteractorStyle::SceneCallbackCommand
protected

Definition at line 129 of file vtkContextInteractorStyle.h.

vtkNew<vtkCallbackCommand> vtkContextInteractorStyle::InteractorCallbackCommand
protected

Definition at line 130 of file vtkContextInteractorStyle.h.

int vtkContextInteractorStyle::ProcessingEvents
protected

Definition at line 131 of file vtkContextInteractorStyle.h.

unsigned long int vtkContextInteractorStyle::LastSceneRepaintMTime
protected

Definition at line 132 of file vtkContextInteractorStyle.h.

unsigned long int vtkContextInteractorStyle::TimerId
protected

Definition at line 134 of file vtkContextInteractorStyle.h.

bool vtkContextInteractorStyle::TimerCallbackInitialized
protected

Definition at line 135 of file vtkContextInteractorStyle.h.


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