vtkContextInteractorStyle Class Reference

#include <vtkContextInteractorStyle.h>

Inheritance diagram for vtkContextInteractorStyle:

[legend]

Collaboration diagram for vtkContextInteractorStyle:

[legend]

List of all members.

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.

Definition at line 31 of file vtkContextInteractorStyle.h.


Public Types
typedef vtkInteractorStyle	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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])

void	SetScene (vtkContextScene *scene)
virtual vtkContextScene *	GetScene ()
Static Public Member Functions
static vtkContextInteractorStyle *	New ()
static int	IsTypeOf (const char *type)
static vtkContextInteractorStyle *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkContextInteractorStyle ()
	~vtkContextInteractorStyle ()
void	BeginProcessingEvent ()
void	EndProcessingEvent ()
Static Protected Member Functions
static void	ProcessSceneEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
Protected Attributes
vtkContextScene *	Scene
vtkCallbackCommand *	SceneCallbackCommand
int	ProcessingEvents
unsigned long int	LastSceneRepaintMTime

Member Typedef Documentation

typedef vtkInteractorStyle vtkContextInteractorStyle::Superclass

Reimplemented from vtkInteractorStyle.

Definition at line 35 of file vtkContextInteractorStyle.h.

Constructor & Destructor Documentation

vtkContextInteractorStyle::vtkContextInteractorStyle ( ) [protected]

vtkContextInteractorStyle::~vtkContextInteractorStyle ( ) [protected]

Member Function Documentation

static vtkContextInteractorStyle* vtkContextInteractorStyle::New ( ) [static]

This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. This class should not normally be instantiated by application programmers.

Reimplemented from vtkInteractorStyle.

virtual const char* vtkContextInteractorStyle::GetClassName ( ) [virtual]

Reimplemented from vtkInteractorStyle.

static int vtkContextInteractorStyle::IsTypeOf ( const char * name ) [static]

Return 1 if this class type 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.

virtual int vtkContextInteractorStyle::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 vtkContextInteractorStyle* vtkContextInteractorStyle::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkInteractorStyle.

void vtkContextInteractorStyle::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 vtkInteractorStyle.

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.

virtual vtkContextScene* vtkContextInteractorStyle::GetScene ( ) [virtual]

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.

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.

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnLeftButtonDown ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnLeftButtonUp ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnMiddleButtonDown ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnMiddleButtonUp ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnRightButtonDown ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnRightButtonUp ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnMouseWheelForward ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

virtual void vtkContextInteractorStyle::OnMouseWheelBackward ( ) [virtual]

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

Reimplemented from vtkInteractorStyle.

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

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

static void vtkContextInteractorStyle::ProcessSceneEvents	(	vtkObject *	object,
		unsigned long	event,
		void *	clientdata,
		void *	calldata
	)			`[static, protected]`

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)