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

interactive manipulation of the camera specialized for images More...

#include <vtkInteractorStyleImage.h>

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

Public Types

typedef
vtkInteractorStyleTrackballCamera 
Superclass
- Public Types inherited from vtkInteractorStyleTrackballCamera
typedef vtkInteractorStyle Superclass
- Public Types inherited from vtkInteractorStyle
typedef vtkInteractorObserver Superclass
- Public Types inherited from vtkInteractorObserver
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 WindowLevel ()
virtual void Pick ()
virtual void StartWindowLevel ()
virtual void EndWindowLevel ()
virtual void StartPick ()
virtual void EndPick ()
virtual int * GetWindowLevelStartPosition ()
virtual void GetWindowLevelStartPosition (int &, int &)
virtual void GetWindowLevelStartPosition (int[2])
virtual int * GetWindowLevelCurrentPosition ()
virtual void GetWindowLevelCurrentPosition (int &, int &)
virtual void GetWindowLevelCurrentPosition (int[2])
virtual void OnMouseMove ()
virtual void OnLeftButtonDown ()
virtual void OnLeftButtonUp ()
virtual void OnRightButtonDown ()
virtual void OnRightButtonUp ()
- Public Member Functions inherited from vtkInteractorStyleTrackballCamera
virtual void Rotate ()
virtual void Spin ()
virtual void Pan ()
virtual void Dolly ()
virtual void OnMiddleButtonDown ()
virtual void OnMiddleButtonUp ()
virtual void OnMouseWheelForward ()
virtual void OnMouseWheelBackward ()
virtual void SetMotionFactor (double)
virtual double GetMotionFactor ()
- Public Member Functions inherited from vtkInteractorStyle
virtual void SetInteractor (vtkRenderWindowInteractor *interactor)
virtual void SetEnabled (int)
void FindPokedRenderer (int, int)
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 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 vtkInteractorStyleImageNew ()
static int IsTypeOf (const char *type)
static vtkInteractorStyleImageSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkInteractorStyleImage ()
 ~vtkInteractorStyleImage ()
- Protected Member Functions inherited from vtkInteractorStyleTrackballCamera
 vtkInteractorStyleTrackballCamera ()
 ~vtkInteractorStyleTrackballCamera ()
virtual void Dolly (double factor)
- 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 &)

Protected Attributes

int WindowLevelStartPosition [2]
int WindowLevelCurrentPosition [2]
- Protected Attributes inherited from vtkInteractorStyleTrackballCamera
double MotionFactor
- 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

Additional Inherited Members

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

Detailed Description

interactive manipulation of the camera specialized for images

vtkInteractorStyleImage allows the user to interactively manipulate (rotate, pan, zoomm etc.) the camera. vtkInteractorStyleImage is specially designed to work with images that are being rendered with vtkImageActor. Several events are overloaded from its superclass vtkInteractorStyle, hence the mouse bindings are different. (The bindings keep the camera's view plane normal perpendicular to the x-y plane.) In summary the mouse events are as follows:

Note that the renderer's actors are not moved; instead the camera is moved.

See Also
vtkInteractorStyle vtkInteractorStyleTrackballActor vtkInteractorStyleJoystickCamera vtkInteractorStyleJoystickActor
Events:
vtkCommand::PickEvent vtkCommand::InteractionEvent vtkCommand::EndPickEvent vtkCommand::StartPickEvent vtkCommand::StartWindowLevelEvent vtkCommand::WindowLevelEvent vtkCommand::EndWindowLevelEvent vtkCommand::ResetWindowLevelEvent
Examples:
vtkInteractorStyleImage (Examples)
Tests:
vtkInteractorStyleImage (Tests)

Definition at line 59 of file vtkInteractorStyleImage.h.

Member Typedef Documentation

Definition at line 63 of file vtkInteractorStyleImage.h.

Constructor & Destructor Documentation

vtkInteractorStyleImage::vtkInteractorStyleImage ( )
protected
vtkInteractorStyleImage::~vtkInteractorStyleImage ( )
protected

Member Function Documentation

static vtkInteractorStyleImage* vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual const char* vtkInteractorStyleImage::GetClassName ( )
virtual
static int vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual int vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

static vtkInteractorStyleImage* vtkInteractorStyleImage::SafeDownCast ( vtkObject o)
static
void vtkInteractorStyleImage::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 vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual int* vtkInteractorStyleImage::GetWindowLevelStartPosition ( )
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelStartPosition ( int &  ,
int &   
)
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelStartPosition ( int  [2])
virtual

Some useful information for handling window level

virtual int* vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( )
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( int &  ,
int &   
)
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::GetWindowLevelCurrentPosition ( int  [2])
virtual

Some useful information for handling window level

virtual void vtkInteractorStyleImage::OnMouseMove ( )
virtual

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

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual void vtkInteractorStyleImage::OnLeftButtonDown ( )
virtual

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

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnLeftButtonUp ( )
virtual

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

Reimplemented from vtkInteractorStyleTrackballCamera.

Reimplemented in vtkInteractorStyleTreeMapHover.

virtual void vtkInteractorStyleImage::OnRightButtonDown ( )
virtual

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

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnRightButtonUp ( )
virtual

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

Reimplemented from vtkInteractorStyleTrackballCamera.

virtual void vtkInteractorStyleImage::OnChar ( )
virtual

Override the "fly-to" (f keypress) for images.

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleImage::WindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::Pick ( )
virtual
virtual void vtkInteractorStyleImage::StartWindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::EndWindowLevel ( )
virtual
virtual void vtkInteractorStyleImage::StartPick ( )
virtual
virtual void vtkInteractorStyleImage::EndPick ( )
virtual

Member Data Documentation

int vtkInteractorStyleImage::WindowLevelStartPosition[2]
protected

Definition at line 102 of file vtkInteractorStyleImage.h.

int vtkInteractorStyleImage::WindowLevelCurrentPosition[2]
protected

Definition at line 103 of file vtkInteractorStyleImage.h.


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