vtkInteractorObserver Class Reference

#include <vtkInteractorObserver.h>

Inheritance diagram for vtkInteractorObserver:

[legend]

Collaboration diagram for vtkInteractorObserver:

[legend]

List of all members.

Detailed Description

an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor

vtkInteractorObserver is an abstract superclass for subclasses that observe events invoked by vtkRenderWindowInteractor. These subclasses are typically things like 3D widgets; objects that interact with actors in the scene, or interactively probe the scene for information.

vtkInteractorObserver defines the method SetInteractor() and enables and disables the processing of events by the vtkInteractorObserver. Use the methods EnabledOn() or SetEnabled(1) to turn on the interactor observer, and the methods EnabledOff() or SetEnabled(0) to turn off the interactor. Initial value is 0.

To support interactive manipulation of objects, this class (and subclasses) invoke the events StartInteractionEvent, InteractionEvent, and EndInteractionEvent. These events are invoked when the vtkInteractorObserver enters a state where rapid response is desired: mouse motion, etc. The events can be used, for example, to set the desired update frame rate (StartInteractionEvent), operate on data or update a pipeline (InteractionEvent), and set the desired frame rate back to normal values (EndInteractionEvent). Two other events, EnableEvent and DisableEvent, are invoked when the interactor observer is enabled or disabled.

See also:: vtk3DWidget vtkBoxWidget vtkLineWidget

Events:: vtkCommand::CursorChangedEvent

Definition at line 58 of file vtkInteractorObserver.h.


Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	OnChar ()

virtual void	SetEnabled (int)
int	GetEnabled ()
void	EnabledOn ()
void	EnabledOff ()
void	On ()
void	Off ()

virtual void	SetInteractor (vtkRenderWindowInteractor *iren)
virtual vtkRenderWindowInteractor *	GetInteractor ()

virtual void	SetPriority (float)
virtual float	GetPriority ()

virtual void	SetKeyPressActivation (int)
virtual int	GetKeyPressActivation ()
virtual void	KeyPressActivationOn ()
virtual void	KeyPressActivationOff ()

virtual void	SetKeyPressActivationValue (char)
virtual char	GetKeyPressActivationValue ()

virtual vtkRenderer *	GetDefaultRenderer ()
virtual void	SetDefaultRenderer (vtkRenderer *)

virtual vtkRenderer *	GetCurrentRenderer ()
virtual void	SetCurrentRenderer (vtkRenderer *)

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)
void	ReleaseFocus ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkInteractorObserver *	SafeDownCast (vtkObject *o)

static void	ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
static void	ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
Protected Member Functions
	vtkInteractorObserver ()
	~vtkInteractorObserver ()
int	RequestCursorShape (int requestedShape)

virtual void	StartInteraction ()
virtual void	EndInteraction ()

void	ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
void	ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
Static Protected Member Functions

static void	ProcessEvents (vtkObject object, unsigned long event, void clientdata, void *calldata)
Protected Attributes
int	Enabled
vtkCallbackCommand *	EventCallbackCommand
vtkCallbackCommand *	KeyPressCallbackCommand
float	Priority
int	KeyPressActivation
char	KeyPressActivationValue
vtkRenderWindowInteractor *	Interactor
vtkRenderer *	CurrentRenderer
vtkRenderer *	DefaultRenderer
unsigned long	CharObserverTag
unsigned long	DeleteObserverTag
vtkObserverMediator *	ObserverMediator

Member Typedef Documentation

typedef vtkObject vtkInteractorObserver::Superclass

Reimplemented from vtkObject.

Definition at line 61 of file vtkInteractorObserver.h.

Constructor & Destructor Documentation

vtkInteractorObserver::vtkInteractorObserver ( ) [protected]

vtkInteractorObserver::~vtkInteractorObserver ( ) [protected]

Member Function Documentation

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

Reimplemented from vtkObject.

static int vtkInteractorObserver::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 vtkObject.

virtual int vtkInteractorObserver::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 vtkObject.

static vtkInteractorObserver* vtkInteractorObserver::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

void vtkInteractorObserver::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 vtkInteractorObserver::SetEnabled ( int ) [inline, virtual]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Reimplemented in vtkAbstractWidget, vtkAffineWidget, vtkAngleWidget, vtkAxesTransformWidget, vtkBalloonWidget, vtkBiDimensionalWidget, vtkBoxWidget, vtkCaptionWidget, vtkCheckerboardWidget, vtkContourWidget, vtkDistanceWidget, vtkHoverWidget, vtkImagePlaneWidget, vtkImageTracerWidget, vtkImplicitPlaneWidget, vtkLineWidget, vtkLineWidget2, vtkOrientationMarkerWidget, vtkParallelopipedWidget, vtkPlaneWidget, vtkPointWidget, vtkSeedWidget, vtkSphereWidget, vtkSplineWidget, vtkXYPlotWidget, vtkInteractorEventRecorder, and vtkInteractorStyle.

Definition at line 71 of file vtkInteractorObserver.h.

int vtkInteractorObserver::GetEnabled ( ) [inline]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Definition at line 72 of file vtkInteractorObserver.h.

void vtkInteractorObserver::EnabledOn ( ) [inline]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Definition at line 73 of file vtkInteractorObserver.h.

void vtkInteractorObserver::EnabledOff ( ) [inline]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Definition at line 74 of file vtkInteractorObserver.h.

void vtkInteractorObserver::On ( ) [inline]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Definition at line 75 of file vtkInteractorObserver.h.

void vtkInteractorObserver::Off ( ) [inline]

Methods for turning the interactor observer on and off, and determining its state. All subclasses must provide the SetEnabled() method. Enabling a vtkInteractorObserver has the side effect of adding observers; disabling it removes the observers. Prior to enabling the vtkInteractorObserver you must set the render window interactor (via SetInteractor()). Initial value is 0.

Definition at line 76 of file vtkInteractorObserver.h.

virtual void vtkInteractorObserver::SetInteractor ( vtkRenderWindowInteractor * iren ) [virtual]

This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.

Reimplemented in vtkGeoInteractorStyle, vtkSeedWidget, vtkInteractorEventRecorder, vtkInteractorStyle, vtkInteractorStyleSwitch, vtkInteractorStyleAreaSelectHover, and vtkInteractorStyleTreeMapHover.

virtual vtkRenderWindowInteractor* vtkInteractorObserver::GetInteractor ( ) [virtual]

This method is used to associate the widget with the render window interactor. Observers of the appropriate events invoked in the render window interactor are set up as a result of this method invocation. The SetInteractor() method must be invoked prior to enabling the vtkInteractorObserver.

virtual void vtkInteractorObserver::SetPriority ( float ) [virtual]

Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)

Reimplemented in vtkAbstractWidget.

virtual float vtkInteractorObserver::GetPriority ( ) [virtual]

Set/Get the priority at which events are processed. This is used when multiple interactor observers are used simultaneously. The default value is 0.0 (lowest priority.) Note that when multiple interactor observer have the same priority, then the last observer added will process the event first. (Note: once the SetInteractor() method has been called, changing the priority does not effect event processing. You will have to SetInteractor(NULL), change priority, and then SetInteractor(iren) to have the priority take effect.)

virtual void vtkInteractorObserver::SetKeyPressActivation ( int ) [virtual]

Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)

virtual int vtkInteractorObserver::GetKeyPressActivation ( ) [virtual]

Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)

virtual void vtkInteractorObserver::KeyPressActivationOn ( ) [virtual]

Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)

virtual void vtkInteractorObserver::KeyPressActivationOff ( ) [virtual]

Enable/Disable of the use of a keypress to turn on and off the interactor observer. (By default, the keypress is 'i' for "interactor observer".) Set the KeyPressActivationValue to change which key activates the widget.)

virtual void vtkInteractorObserver::SetKeyPressActivationValue ( char ) [virtual]

Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.

virtual char vtkInteractorObserver::GetKeyPressActivationValue ( ) [virtual]

Specify which key press value to use to activate the interactor observer (if key press activation is enabled). By default, the key press activation value is 'i'. Note: once the SetInteractor() method is invoked, changing the key press activation value will not affect the key press until SetInteractor(NULL)/SetInteractor(iren) is called.

virtual vtkRenderer* vtkInteractorObserver::GetDefaultRenderer ( ) [virtual]

Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.

virtual void vtkInteractorObserver::SetDefaultRenderer ( vtkRenderer * ) [virtual]

Set/Get the default renderer to use when activating the interactor observer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used. Alternatively, you can specify the renderer to bind the interactor to when the interactor observer is activated.

Reimplemented in vtkInteractorStyleSwitch.

virtual vtkRenderer* vtkInteractorObserver::GetCurrentRenderer ( ) [virtual]

Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).

virtual void vtkInteractorObserver::SetCurrentRenderer ( vtkRenderer * ) [virtual]

Set/Get the current renderer. Normally when the widget is activated (SetEnabled(1) or when keypress activation takes place), the renderer over which the mouse pointer is positioned is used and assigned to this Ivar. Alternatively, you might want to set the CurrentRenderer explicitly. WARNING: note that if the DefaultRenderer Ivar is set (see above), it will always override the parameter passed to SetCurrentRenderer, unless it is NULL. (i.e., SetCurrentRenderer(foo) = SetCurrentRenderer(DefaultRenderer).

Reimplemented in vtkGeoInteractorStyle, vtkSeedWidget, and vtkInteractorStyleSwitch.

virtual void vtkInteractorObserver::OnChar ( ) [virtual]

Sets up the keypress-i event.

Reimplemented in vtkGeoInteractorStyle, vtkImagePlaneWidget, vtkInteractorStyle, vtkInteractorStyleFlight, vtkInteractorStyleImage, vtkInteractorStyleRubberBandPick, vtkInteractorStyleSwitch, vtkInteractorStyleTerrain, vtkInteractorStyleUser, and vtkParallelCoordinatesInteractorStyle.

static void vtkInteractorObserver::ComputeDisplayToWorld	(	vtkRenderer *	ren,
		double	x,
		double	y,
		double	z,
		double	worldPt[4]
	)			`[static]`

Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.

static void vtkInteractorObserver::ComputeWorldToDisplay	(	vtkRenderer *	ren,
		double	x,
		double	y,
		double	z,
		double	displayPt[3]
	)			`[static]`

Convenience methods for outside classes. Make sure that the parameter "ren" is not-null.

void vtkInteractorObserver::GrabFocus	(	vtkCommand *	mouseEvents,
		vtkCommand *	keypressEvents = `NULL`
	)

These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. (This method is typically used by widgets to grab events once an event sequence begins.) The GrabFocus() signature takes up to two vtkCommands corresponding to mouse events and keypress events. (These two commands are separated so that the widget can listen for its activation keypress, as well as listening for DeleteEvents, without actually having to process mouse events.)

void vtkInteractorObserver::ReleaseFocus ( )

These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. (This method is typically used by widgets to grab events once an event sequence begins.) The GrabFocus() signature takes up to two vtkCommands corresponding to mouse events and keypress events. (These two commands are separated so that the widget can listen for its activation keypress, as well as listening for DeleteEvents, without actually having to process mouse events.)

virtual void vtkInteractorObserver::StartInteraction ( ) [protected, virtual]

Utility routines used to start and end interaction. For example, it switches the display update rate. It does not invoke the corresponding events.

virtual void vtkInteractorObserver::EndInteraction ( ) [protected, virtual]

Utility routines used to start and end interaction. For example, it switches the display update rate. It does not invoke the corresponding events.