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

provide 3DConnexion device event-driven interface to the rendering window More...

#include <vtkTDxInteractorStyle.h>

Inheritance diagram for vtkTDxInteractorStyle:
[legend]
Collaboration diagram for vtkTDxInteractorStyle:
[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...
 
vtkTDxInteractorStyleNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void OnMotionEvent (vtkTDxMotionEventInfo *motionInfo)
 Action on motion event. More...
 
virtual void OnButtonPressedEvent (int button)
 Action on button pressed event. More...
 
virtual void OnButtonReleasedEvent (int button)
 Action on button released event. More...
 
virtual void ProcessEvent (vtkRenderer *renderer, unsigned long event, void *calldata)
 Dispatch the events TDxMotionEvent, TDxButtonPressEvent and TDxButtonReleaseEvent to OnMotionEvent(), OnButtonPressedEvent() and OnButtonReleasedEvent() respectively. More...
 
virtual vtkTDxInteractorStyleSettingsGetSettings ()
 3Dconnexion device settings. More...
 
virtual void SetSettings (vtkTDxInteractorStyleSettings *settings)
 
- 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 vtkTDxInteractorStyleSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkTDxInteractorStyle ()
 
 ~vtkTDxInteractorStyle () override
 
- 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 &)
 

Protected Attributes

vtkTDxInteractorStyleSettingsSettings
 
vtkRendererRenderer
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

provide 3DConnexion device event-driven interface to the rendering window

vtkTDxInteractorStyle is an abstract class defining an event-driven interface to support 3DConnexion device events send by vtkRenderWindowInteractor. vtkRenderWindowInteractor forwards events in a platform independent form to vtkInteractorStyle which can then delegate some processing to vtkTDxInteractorStyle.

See also
vtkInteractorStyle vtkRenderWindowInteractor vtkTDxInteractorStyleCamera
Examples:
vtkTDxInteractorStyle (Examples)

Definition at line 45 of file vtkTDxInteractorStyle.h.

Member Typedef Documentation

◆ Superclass

Definition at line 48 of file vtkTDxInteractorStyle.h.

Constructor & Destructor Documentation

◆ vtkTDxInteractorStyle()

vtkTDxInteractorStyle::vtkTDxInteractorStyle ( )
protected

◆ ~vtkTDxInteractorStyle()

vtkTDxInteractorStyle::~vtkTDxInteractorStyle ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkTDxInteractorStyle::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 vtkTDxInteractorStyleCamera.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkTDxInteractorStyle::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkTDxInteractorStyleCamera.

◆ NewInstance()

vtkTDxInteractorStyle* vtkTDxInteractorStyle::NewInstance ( ) const

◆ PrintSelf()

void vtkTDxInteractorStyle::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 vtkTDxInteractorStyleCamera.

◆ OnMotionEvent()

virtual void vtkTDxInteractorStyle::OnMotionEvent ( vtkTDxMotionEventInfo motionInfo)
virtual

Action on motion event.

Default implementation is empty.

Precondition
: motionInfo_exist: motionInfo!=0

Reimplemented in vtkTDxInteractorStyleCamera.

◆ OnButtonPressedEvent()

virtual void vtkTDxInteractorStyle::OnButtonPressedEvent ( int  button)
virtual

Action on button pressed event.

Default implementation is empty.

◆ OnButtonReleasedEvent()

virtual void vtkTDxInteractorStyle::OnButtonReleasedEvent ( int  button)
virtual

Action on button released event.

Default implementation is empty.

◆ ProcessEvent()

virtual void vtkTDxInteractorStyle::ProcessEvent ( vtkRenderer renderer,
unsigned long  event,
void *  calldata 
)
virtual

Dispatch the events TDxMotionEvent, TDxButtonPressEvent and TDxButtonReleaseEvent to OnMotionEvent(), OnButtonPressedEvent() and OnButtonReleasedEvent() respectively.

It is called by the vtkInteractorStyle. This method is virtual for convenient but you should really override the On*Event() methods only.

Precondition
renderer can be null.

◆ GetSettings()

virtual vtkTDxInteractorStyleSettings* vtkTDxInteractorStyle::GetSettings ( )
virtual

3Dconnexion device settings.

(sensitivity, individual axis filters). Initial object is not null.

◆ SetSettings()

virtual void vtkTDxInteractorStyle::SetSettings ( vtkTDxInteractorStyleSettings settings)
virtual

Member Data Documentation

◆ Settings

vtkTDxInteractorStyleSettings* vtkTDxInteractorStyle::Settings
protected

Definition at line 93 of file vtkTDxInteractorStyle.h.

◆ Renderer

vtkRenderer* vtkTDxInteractorStyle::Renderer
protected

Definition at line 95 of file vtkTDxInteractorStyle.h.


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