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

an abstract superclass for classes observing events invoked by vtkRenderWindowInteractor More...

#include <vtkInteractorObserver.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkInteractorObserverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetEnabled (int)
 Methods for turning the interactor observer on and off, and determining its state. More...
 
int GetEnabled ()
 
void EnabledOn ()
 
void EnabledOff ()
 
void On ()
 
void Off ()
 
virtual void SetInteractor (vtkRenderWindowInteractor *iren)
 This method is used to associate the widget with the render window interactor. More...
 
virtual vtkRenderWindowInteractorGetInteractor ()
 
virtual void SetPriority (float)
 Set/Get the priority at which events are processed. More...
 
virtual float GetPriority ()
 
virtual void PickingManagedOn ()
 Enable/Disable the use of a manager to process the picking. More...
 
virtual void PickingManagedOff ()
 
virtual void SetPickingManaged (bool managed)
 
virtual bool GetPickingManaged ()
 
virtual void SetKeyPressActivation (vtkTypeBool)
 Enable/Disable of the use of a keypress to turn on and off the interactor observer. More...
 
virtual vtkTypeBool GetKeyPressActivation ()
 
virtual void KeyPressActivationOn ()
 
virtual void KeyPressActivationOff ()
 
virtual void SetKeyPressActivationValue (char)
 Specify which key press value to use to activate the interactor observer (if key press activation is enabled). More...
 
virtual char GetKeyPressActivationValue ()
 
virtual vtkRendererGetDefaultRenderer ()
 Set/Get the default renderer to use when activating the interactor observer. More...
 
virtual void SetDefaultRenderer (vtkRenderer *)
 
virtual vtkRendererGetCurrentRenderer ()
 Set/Get the current renderer. More...
 
virtual void SetCurrentRenderer (vtkRenderer *)
 
virtual void OnChar ()
 Sets up the keypress-i event. More...
 
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods enable an interactor observer to exclusively grab all events invoked by its associated vtkRenderWindowInteractor. More...
 
void ReleaseFocus ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
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
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkInteractorObserverSafeDownCast (vtkObjectBase *o)
 
static void ComputeDisplayToWorld (vtkRenderer *ren, double x, double y, double z, double worldPt[4])
 Convenience methods for outside classes. More...
 
static void ComputeWorldToDisplay (vtkRenderer *ren, double x, double y, double z, double displayPt[3])
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkInteractorObserver ()
 
 ~vtkInteractorObserver () override
 
virtual void StartInteraction ()
 Utility routines used to start and end interaction. More...
 
virtual void EndInteraction ()
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 Helper method for subclasses. More...
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 
virtual void RegisterPickers ()
 Register internal Pickers in the Picking Manager. More...
 
void UnRegisterPickers ()
 Unregister internal pickers from the Picking Manager. More...
 
vtkPickingManagerGetPickingManager ()
 Return the picking manager associated on the context on which the observer currently belong. More...
 
vtkAssemblyPathGetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
 Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path. More...
 
int RequestCursorShape (int requestedShape)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Static Protected Member Functions

static void ProcessEvents (vtkObject *object, unsigned long event, void *clientdata, void *calldata)
 Handles the char widget activation event. More...
 

Protected Attributes

int Enabled
 
vtkCallbackCommandEventCallbackCommand
 
vtkCallbackCommandKeyPressCallbackCommand
 
float Priority
 
bool PickingManaged
 
vtkTypeBool KeyPressActivation
 
char KeyPressActivationValue
 
vtkRenderWindowInteractorInteractor
 
vtkRendererCurrentRenderer
 
vtkRendererDefaultRenderer
 
unsigned long CharObserverTag
 
unsigned long DeleteObserverTag
 
vtkObserverMediatorObserverMediator
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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
Examples:
vtkInteractorObserver (Examples)

Definition at line 62 of file vtkInteractorObserver.h.

Member Typedef Documentation

◆ Superclass

Definition at line 65 of file vtkInteractorObserver.h.

Constructor & Destructor Documentation

◆ vtkInteractorObserver()

vtkInteractorObserver::vtkInteractorObserver ( )
protected

◆ ~vtkInteractorObserver()

vtkInteractorObserver::~vtkInteractorObserver ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkInteractorObserver::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkInteractorStyle, vtkContourWidget, vtkImagePlaneWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSplineWidget, vtkBrokenLineWidget, vtkPlaneWidget, vtkInteractorStyleUnicam, vtkSphereWidget2, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBoxWidget, vtkBalloonWidget, vtkLineWidget, vtkRectilinearWipeWidget, vtkImplicitPlaneWidget, vtkDistanceWidget, vtkAngleWidget, vtkBorderWidget, vtkSeedWidget, vtkCenteredSliderWidget, vtkImageTracerWidget, vtkFinitePlaneWidget, vtkSliderWidget, vtkHoverWidget, vtkPointWidget, vtkInteractorStyleImage, vtkHandleWidget, vtkOrientationMarkerWidget, vtkSphereWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkInteractorStyleTerrain, vtk3DWidget, vtkAbstractWidget, vtkInteractorStyle3D, vtkCaptionWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, vtkInteractorStyleSwitch, vtkParallelCoordinatesInteractorStyle, vtkCameraWidget, vtkLightWidget, vtkTensorProbeWidget, vtkTextWidget, vtkOSPRayTestInteractor, vtkInteractorStyleTreeMapHover, vtkLogoWidget, vtkProgressBarWidget, vtkInteractorStyleRubberBand2D, vtkPlaybackWidget, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleTrackballCamera, vtkImageCroppingRegionsWidget, vtkPolyLineWidget, vtkScalarBarWidget, vtkInteractorStyleFlight, vtkInteractorStyleRubberBand3D, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleUser, vtkQWidgetWidget, vtkPolyDataSourceWidget, vtkInteractorEventRecorder, vtkOpenVRMenuWidget, vtkInteractorStyleRubberBandPick, vtkOpenVRPanelWidget, vtkInteractorStyleJoystickCamera, vtkXYPlotWidget, vtkOpenVRInteractorStyle, vtkContextInteractorStyle, vtkInteractorStyleDrawPolygon, vtkInteractorStyleMultiTouchCamera, vtkInteractorStyleRubberBandZoom, vtkSplineWidget2, vtkInteractorStyleSwitchBase, and vtkInteractorStyleTrackball.

◆ SafeDownCast()

static vtkInteractorObserver* vtkInteractorObserver::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkInteractorObserver::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkInteractorStyle, vtkContourWidget, vtkImagePlaneWidget, vtkBiDimensionalWidget, vtkBoxWidget2, vtkImplicitPlaneWidget2, vtkSplineWidget, vtkBrokenLineWidget, vtkPlaneWidget, vtkInteractorStyleUnicam, vtkSphereWidget2, vtkImplicitCylinderWidget, vtkLineWidget2, vtkAxesTransformWidget, vtkBoxWidget, vtkBalloonWidget, vtkLineWidget, vtkRectilinearWipeWidget, vtkImplicitPlaneWidget, vtkDistanceWidget, vtkAngleWidget, vtkBorderWidget, vtkSeedWidget, vtkCenteredSliderWidget, vtkImageTracerWidget, vtkFinitePlaneWidget, vtkSliderWidget, vtkHoverWidget, vtkPointWidget, vtkInteractorStyleImage, vtkHandleWidget, vtkOrientationMarkerWidget, vtkSphereWidget, vtkCompassWidget, vtkAffineWidget, vtkContinuousValueWidget, vtkButtonWidget, vtkCheckerboardWidget, vtkInteractorStyleTerrain, vtk3DWidget, vtkAbstractWidget, vtkInteractorStyle3D, vtkCaptionWidget, vtkParallelopipedWidget, vtkResliceCursorWidget, vtkInteractorStyleSwitch, vtkParallelCoordinatesInteractorStyle, vtkCameraWidget, vtkLightWidget, vtkTensorProbeWidget, vtkTextWidget, vtkOSPRayTestInteractor, vtkInteractorStyleTreeMapHover, vtkLogoWidget, vtkProgressBarWidget, vtkInteractorStyleRubberBand2D, vtkPlaybackWidget, vtkInteractorStyleAreaSelectHover, vtkInteractorStyleTrackballCamera, vtkImageCroppingRegionsWidget, vtkPolyLineWidget, vtkScalarBarWidget, vtkInteractorStyleFlight, vtkInteractorStyleRubberBand3D, vtkInteractorStyleJoystickActor, vtkInteractorStyleTrackballActor, vtkInteractorStyleUser, vtkQWidgetWidget, vtkPolyDataSourceWidget, vtkInteractorEventRecorder, vtkOpenVRMenuWidget, vtkInteractorStyleRubberBandPick, vtkOpenVRPanelWidget, vtkInteractorStyleJoystickCamera, vtkXYPlotWidget, vtkOpenVRInteractorStyle, vtkContextInteractorStyle, vtkInteractorStyleDrawPolygon, vtkInteractorStyleMultiTouchCamera, vtkInteractorStyleRubberBandZoom, vtkSplineWidget2, vtkInteractorStyleSwitchBase, and vtkInteractorStyleTrackball.

◆ NewInstance()

vtkInteractorObserver* vtkInteractorObserver::NewInstance ( ) const

◆ PrintSelf()

void vtkInteractorObserver::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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.

Reimplemented in vtkInteractorStyle, vtkInteractorStyle3D, vtkInteractorStyleTreeMapHover, vtkInteractorStyleAreaSelectHover, vtkOpenVRMenuWidget, vtkOpenVRPanelWidget, vtkOpenVRInteractorStyle, vtkContextInteractorStyle, and vtkInteractorStyleSwitchBase.

◆ SetEnabled()

virtual void vtkInteractorObserver::SetEnabled ( int  )
inlinevirtual

◆ GetEnabled()

int vtkInteractorObserver::GetEnabled ( )
inline

Definition at line 77 of file vtkInteractorObserver.h.

◆ EnabledOn()

void vtkInteractorObserver::EnabledOn ( )
inline

Definition at line 78 of file vtkInteractorObserver.h.

◆ EnabledOff()

void vtkInteractorObserver::EnabledOff ( )
inline

Definition at line 79 of file vtkInteractorObserver.h.

◆ On()

void vtkInteractorObserver::On ( )
inline

Definition at line 80 of file vtkInteractorObserver.h.

◆ Off()

void vtkInteractorObserver::Off ( )
inline

Definition at line 81 of file vtkInteractorObserver.h.

◆ SetInteractor()

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. It automatically registers available pickers to the Picking Manager.

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

◆ GetInteractor()

virtual vtkRenderWindowInteractor* vtkInteractorObserver::GetInteractor ( )
virtual

Reimplemented in vtkInteractorStyleSwitchBase.

◆ SetPriority()

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.

◆ GetPriority()

virtual float vtkInteractorObserver::GetPriority ( )
virtual

◆ PickingManagedOn()

virtual void vtkInteractorObserver::PickingManagedOn ( )
virtual

Enable/Disable the use of a manager to process the picking.

Enabled by default.

◆ PickingManagedOff()

virtual void vtkInteractorObserver::PickingManagedOff ( )
virtual

◆ SetPickingManaged()

virtual void vtkInteractorObserver::SetPickingManaged ( bool  managed)
virtual

◆ GetPickingManaged()

virtual bool vtkInteractorObserver::GetPickingManaged ( )
virtual

◆ SetKeyPressActivation()

virtual void vtkInteractorObserver::SetKeyPressActivation ( vtkTypeBool  )
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.)

◆ GetKeyPressActivation()

virtual vtkTypeBool vtkInteractorObserver::GetKeyPressActivation ( )
virtual

◆ KeyPressActivationOn()

virtual void vtkInteractorObserver::KeyPressActivationOn ( )
virtual

◆ KeyPressActivationOff()

virtual void vtkInteractorObserver::KeyPressActivationOff ( )
virtual

◆ SetKeyPressActivationValue()

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.

◆ GetKeyPressActivationValue()

virtual char vtkInteractorObserver::GetKeyPressActivationValue ( )
virtual

◆ GetDefaultRenderer()

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.

◆ SetDefaultRenderer()

virtual void vtkInteractorObserver::SetDefaultRenderer ( vtkRenderer )
virtual

Reimplemented in vtkInteractorStyleSwitch.

◆ GetCurrentRenderer()

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. This is especially true with multiple viewports (renderers). 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).

◆ SetCurrentRenderer()

virtual void vtkInteractorObserver::SetCurrentRenderer ( vtkRenderer )
virtual

Reimplemented in vtkSeedWidget, and vtkInteractorStyleSwitch.

◆ OnChar()

virtual void vtkInteractorObserver::OnChar ( )
virtual

◆ ComputeDisplayToWorld() [1/2]

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.

◆ ComputeWorldToDisplay() [1/2]

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

◆ GrabFocus()

void vtkInteractorObserver::GrabFocus ( vtkCommand mouseEvents,
vtkCommand keypressEvents = nullptr 
)

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

◆ ReleaseFocus()

void vtkInteractorObserver::ReleaseFocus ( )

◆ StartInteraction()

virtual void vtkInteractorObserver::StartInteraction ( )
protectedvirtual

Utility routines used to start and end interaction.

For example, it switches the display update rate. It does not invoke the corresponding events.

◆ EndInteraction()

virtual void vtkInteractorObserver::EndInteraction ( )
protectedvirtual

◆ ProcessEvents()

static void vtkInteractorObserver::ProcessEvents ( vtkObject object,
unsigned long  event,
void *  clientdata,
void *  calldata 
)
staticprotected

Handles the char widget activation event.

Also handles the delete event.

◆ ComputeDisplayToWorld() [2/2]

void vtkInteractorObserver::ComputeDisplayToWorld ( double  x,
double  y,
double  z,
double  worldPt[4] 
)
protected

Helper method for subclasses.

◆ ComputeWorldToDisplay() [2/2]

void vtkInteractorObserver::ComputeWorldToDisplay ( double  x,
double  y,
double  z,
double  displayPt[3] 
)
protected

◆ RegisterPickers()

virtual void vtkInteractorObserver::RegisterPickers ( )
protectedvirtual

Register internal Pickers in the Picking Manager.

Must be reimplemented by concrete widgets to register their pickers.

Reimplemented in vtkImagePlaneWidget, vtkImplicitPlaneWidget, vtkImageTracerWidget, vtkPlaneWidget, vtkSplineWidget, vtkBrokenLineWidget, vtkBoxWidget, vtkSphereWidget, vtkPointWidget, vtkLineWidget, and vtkBalloonWidget.

◆ UnRegisterPickers()

void vtkInteractorObserver::UnRegisterPickers ( )
protected

Unregister internal pickers from the Picking Manager.

◆ GetPickingManager()

vtkPickingManager* vtkInteractorObserver::GetPickingManager ( )
protected

Return the picking manager associated on the context on which the observer currently belong.

◆ GetAssemblyPath()

vtkAssemblyPath* vtkInteractorObserver::GetAssemblyPath ( double  X,
double  Y,
double  Z,
vtkAbstractPropPicker picker 
)
protected

Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the picker, and return the assembly path.

◆ RequestCursorShape()

int vtkInteractorObserver::RequestCursorShape ( int  requestedShape)
protected

Member Data Documentation

◆ Enabled

int vtkInteractorObserver::Enabled
protected

Definition at line 238 of file vtkInteractorObserver.h.

◆ EventCallbackCommand

vtkCallbackCommand* vtkInteractorObserver::EventCallbackCommand
protected

Definition at line 241 of file vtkInteractorObserver.h.

◆ KeyPressCallbackCommand

vtkCallbackCommand* vtkInteractorObserver::KeyPressCallbackCommand
protected

Definition at line 242 of file vtkInteractorObserver.h.

◆ Priority

float vtkInteractorObserver::Priority
protected

Definition at line 245 of file vtkInteractorObserver.h.

◆ PickingManaged

bool vtkInteractorObserver::PickingManaged
protected

Definition at line 249 of file vtkInteractorObserver.h.

◆ KeyPressActivation

vtkTypeBool vtkInteractorObserver::KeyPressActivation
protected

Definition at line 277 of file vtkInteractorObserver.h.

◆ KeyPressActivationValue

char vtkInteractorObserver::KeyPressActivationValue
protected

Definition at line 278 of file vtkInteractorObserver.h.

◆ Interactor

vtkRenderWindowInteractor* vtkInteractorObserver::Interactor
protected

Definition at line 281 of file vtkInteractorObserver.h.

◆ CurrentRenderer

vtkRenderer* vtkInteractorObserver::CurrentRenderer
protected

Definition at line 284 of file vtkInteractorObserver.h.

◆ DefaultRenderer

vtkRenderer* vtkInteractorObserver::DefaultRenderer
protected

Definition at line 285 of file vtkInteractorObserver.h.

◆ CharObserverTag

unsigned long vtkInteractorObserver::CharObserverTag
protected

Definition at line 287 of file vtkInteractorObserver.h.

◆ DeleteObserverTag

unsigned long vtkInteractorObserver::DeleteObserverTag
protected

Definition at line 288 of file vtkInteractorObserver.h.

◆ ObserverMediator

vtkObserverMediator* vtkInteractorObserver::ObserverMediator
protected

Definition at line 291 of file vtkInteractorObserver.h.


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