VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
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>

Inheritance diagram for vtkContextInteractorStyle:
[legend]
Collaboration diagram for vtkContextInteractorStyle:
[legend]

List of all members.

Public Types

typedef vtkInteractorStyle Superclass
- Public Types inherited from vtkInteractorStyle
- Public Types inherited from vtkInteractorObserver
- Public Types inherited from vtkObject

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 vtkContextSceneGetScene ()
- Public Member Functions inherited from vtkInteractorStyle
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void SetEnabled (int)
void FindPokedRenderer (int, int)
virtual void OnChar ()
virtual void OnKeyDown ()
virtual void OnKeyUp ()
virtual void OnKeyPress ()
virtual void OnKeyRelease ()
virtual void OnTimer ()
virtual void SetAutoAdjustCameraClippingRange (int)
virtual int GetAutoAdjustCameraClippingRange ()
virtual void AutoAdjustCameraClippingRangeOn ()
virtual void AutoAdjustCameraClippingRangeOff ()
virtual int GetState ()
virtual int GetUseTimers ()
virtual void SetUseTimers (int)
virtual void UseTimersOn ()
virtual void UseTimersOff ()
virtual void SetTimerDuration (unsigned long)
virtual unsigned long GetTimerDuration ()
virtual void SetHandleObservers (int)
virtual int GetHandleObservers ()
virtual void HandleObserversOn ()
virtual void HandleObserversOff ()
virtual void OnExpose ()
virtual void OnConfigure ()
virtual void OnEnter ()
virtual void OnLeave ()
virtual void Rotate ()
virtual void Spin ()
virtual void Pan ()
virtual void Dolly ()
virtual void Zoom ()
virtual void UniformScale ()
virtual void StartState (int newstate)
virtual void StopState ()
virtual void StartAnimate ()
virtual void StopAnimate ()
virtual void StartRotate ()
virtual void EndRotate ()
virtual void StartZoom ()
virtual void EndZoom ()
virtual void StartPan ()
virtual void EndPan ()
virtual void StartSpin ()
virtual void EndSpin ()
virtual void StartDolly ()
virtual void EndDolly ()
virtual void StartUniformScale ()
virtual void EndUniformScale ()
virtual void StartTimer ()
virtual void EndTimer ()
virtual void HighlightProp (vtkProp *prop)
virtual void HighlightActor2D (vtkActor2D *actor2D)
virtual void HighlightProp3D (vtkProp3D *prop3D)
virtual void SetPickColor (double, double, double)
virtual void SetPickColor (double[3])
virtual double * GetPickColor ()
virtual void GetPickColor (double data[3])
virtual void SetMouseWheelMotionFactor (double)
virtual double GetMouseWheelMotionFactor ()
virtual vtkTDxInteractorStyleGetTDxStyle ()
virtual void SetTDxStyle (vtkTDxInteractorStyle *tdxStyle)
void DelegateTDxEvent (unsigned long event, void *calldata)
- Public Member Functions inherited from vtkInteractorObserver
int GetEnabled ()
void EnabledOn ()
void EnabledOff ()
void On ()
void Off ()
virtual vtkRenderWindowInteractorGetInteractor ()
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 vtkRendererGetDefaultRenderer ()
virtual void SetDefaultRenderer (vtkRenderer *)
virtual vtkRendererGetCurrentRenderer ()
virtual void SetCurrentRenderer (vtkRenderer *)
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void ReleaseFocus ()
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
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 *)
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)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- 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)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

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

Protected Member Functions

 vtkContextInteractorStyle ()
 ~vtkContextInteractorStyle ()
void BeginProcessingEvent ()
void EndProcessingEvent ()
- Protected Member Functions inherited from vtkInteractorStyle
 vtkInteractorStyle ()
 ~vtkInteractorStyle ()
- Protected Member Functions inherited from vtkInteractorObserver
 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])
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Static Protected Member Functions

static void ProcessSceneEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
- Static Protected Member Functions inherited from vtkInteractorStyle
static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)

Protected Attributes

vtkContextSceneScene
vtkCallbackCommandSceneCallbackCommand
int ProcessingEvents
unsigned long int LastSceneRepaintMTime
- Protected Attributes inherited from vtkInteractorStyle
int State
int AnimState
int HandleObservers
int UseTimers
int TimerId
int AutoAdjustCameraClippingRange
vtkOutlineSourceOutline
vtkPolyDataMapperOutlineMapper
vtkActorOutlineActor
vtkRendererPickedRenderer
vtkPropCurrentProp
vtkActor2DPickedActor2D
int PropPicked
double PickColor [3]
double MouseWheelMotionFactor
unsigned long TimerDuration
vtkEventForwarderCommandEventForwarder
vtkTDxInteractorStyleTDxStyle
- Protected Attributes inherited from vtkInteractorObserver
int Enabled
vtkCallbackCommandEventCallbackCommand
vtkCallbackCommandKeyPressCallbackCommand
float Priority
int KeyPressActivation
char KeyPressActivationValue
vtkRenderWindowInteractorInteractor
vtkRendererCurrentRenderer
vtkRendererDefaultRenderer
unsigned long CharObserverTag
unsigned long DeleteObserverTag
vtkObserverMediatorObserverMediator
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.


Member Typedef Documentation

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 
)
staticprotected
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

vtkContextScene* vtkContextInteractorStyle::Scene
protected

Definition at line 108 of file vtkContextInteractorStyle.h.

vtkCallbackCommand* vtkContextInteractorStyle::SceneCallbackCommand
protected

Definition at line 109 of file vtkContextInteractorStyle.h.

int vtkContextInteractorStyle::ProcessingEvents
protected

Definition at line 110 of file vtkContextInteractorStyle.h.

unsigned long int vtkContextInteractorStyle::LastSceneRepaintMTime
protected

Definition at line 111 of file vtkContextInteractorStyle.h.


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