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

a TCL event driven interface for a RenderWindow More...

#include <vtkXRenderWindowTclInteractor.h>

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

Public Types

typedef vtkXRenderWindowInteractor Superclass
- Public Types inherited from vtkXRenderWindowInteractor
typedef vtkRenderWindowInteractor Superclass
- Public Types inherited from vtkRenderWindowInteractor
enum  { OneShotTimer = 1, RepeatingTimer }
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 Initialize ()
virtual void Initialize (XtAppContext app)
virtual void Start ()
virtual void Enable ()
virtual void Disable ()
- Public Member Functions inherited from vtkXRenderWindowInteractor
void TerminateApp ()
virtual void UpdateSize (int, int)
virtual void GetMousePosition (int *x, int *y)
virtual int GetBreakLoopFlag ()
void SetBreakLoopFlag (int)
void BreakLoopFlagOff ()
void BreakLoopFlagOn ()
virtual XtAppContext GetApp ()
virtual void SetWidget (Widget)
Widget GetWidget ()
virtual void SetTopLevelShell (Widget)
Widget GetTopLevelShell ()
- Public Member Functions inherited from vtkRenderWindowInteractor
virtual void UnRegister (vtkObjectBase *o)
virtual vtkAbstractPropPickerCreateDefaultPicker ()
virtual void Render ()
virtual vtkRendererFindPokedRenderer (int, int)
vtkObserverMediatorGetObserverMediator ()
void ReInitialize ()
virtual int GetEnabled ()
virtual void EnableRenderOn ()
virtual void EnableRenderOff ()
virtual void SetEnableRender (bool)
virtual bool GetEnableRender ()
void SetRenderWindow (vtkRenderWindow *aren)
virtual vtkRenderWindowGetRenderWindow ()
virtual int CreateTimer (int timerType)
virtual int DestroyTimer ()
int CreateRepeatingTimer (unsigned long duration)
int CreateOneShotTimer (unsigned long duration)
int IsOneShotTimer (int timerId)
unsigned long GetTimerDuration (int timerId)
int ResetTimer (int timerId)
int DestroyTimer (int timerId)
virtual int GetVTKTimerId (int platformTimerId)
virtual void SetTimerDuration (unsigned long)
virtual unsigned long GetTimerDuration ()
virtual void SetTimerEventId (int)
virtual int GetTimerEventId ()
virtual void SetTimerEventType (int)
virtual int GetTimerEventType ()
virtual void SetTimerEventDuration (int)
virtual int GetTimerEventDuration ()
virtual void SetTimerEventPlatformId (int)
virtual int GetTimerEventPlatformId ()
virtual void SetInteractorStyle (vtkInteractorObserver *)
virtual vtkInteractorObserverGetInteractorStyle ()
virtual void SetLightFollowCamera (int)
virtual int GetLightFollowCamera ()
virtual void LightFollowCameraOn ()
virtual void LightFollowCameraOff ()
virtual void SetDesiredUpdateRate (double)
virtual double GetDesiredUpdateRate ()
virtual void SetStillUpdateRate (double)
virtual double GetStillUpdateRate ()
virtual int GetInitialized ()
virtual void SetPicker (vtkAbstractPicker *)
virtual vtkAbstractPickerGetPicker ()
virtual void ExitCallback ()
virtual void UserCallback ()
virtual void StartPickCallback ()
virtual void EndPickCallback ()
void HideCursor ()
void ShowCursor ()
void FlyTo (vtkRenderer *ren, double x, double y, double z)
void FlyTo (vtkRenderer *ren, double *x)
void FlyToImage (vtkRenderer *ren, double x, double y)
void FlyToImage (vtkRenderer *ren, double *x)
virtual void SetNumberOfFlyFrames (int)
virtual int GetNumberOfFlyFrames ()
virtual void SetDolly (double)
virtual double GetDolly ()
virtual int * GetEventPosition ()
virtual void GetEventPosition (int &, int &)
virtual void GetEventPosition (int[2])
virtual int * GetLastEventPosition ()
virtual void GetLastEventPosition (int &, int &)
virtual void GetLastEventPosition (int[2])
virtual void SetLastEventPosition (int, int)
void SetLastEventPosition (int[2])
virtual void SetEventPosition (int x, int y)
virtual void SetEventPosition (int pos[2])
virtual void SetEventPositionFlipY (int x, int y)
virtual void SetEventPositionFlipY (int pos[2])
virtual void SetAltKey (int)
virtual int GetAltKey ()
virtual void SetControlKey (int)
virtual int GetControlKey ()
virtual void SetShiftKey (int)
virtual int GetShiftKey ()
virtual void SetKeyCode (char)
virtual char GetKeyCode ()
virtual void SetRepeatCount (int)
virtual int GetRepeatCount ()
virtual void SetKeySym (const char *)
virtual char * GetKeySym ()
void SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
void SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
void SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
virtual void SetSize (int, int)
void SetSize (int[2])
virtual int * GetSize ()
virtual void GetSize (int &, int &)
virtual void GetSize (int[2])
virtual void SetEventSize (int, int)
void SetEventSize (int[2])
virtual int * GetEventSize ()
virtual void GetEventSize (int &, int &)
virtual void GetEventSize (int[2])
virtual void SetUseTDx (bool)
virtual bool GetUseTDx ()
virtual void MouseMoveEvent ()
virtual void RightButtonPressEvent ()
virtual void RightButtonReleaseEvent ()
virtual void LeftButtonPressEvent ()
virtual void LeftButtonReleaseEvent ()
virtual void MiddleButtonPressEvent ()
virtual void MiddleButtonReleaseEvent ()
virtual void MouseWheelForwardEvent ()
virtual void MouseWheelBackwardEvent ()
virtual void ExposeEvent ()
virtual void ConfigureEvent ()
virtual void EnterEvent ()
virtual void LeaveEvent ()
virtual void KeyPressEvent ()
virtual void KeyReleaseEvent ()
virtual void CharEvent ()
virtual void ExitEvent ()
- 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)
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
vtkXRenderWindowTclInteractor
New ()
static int IsTypeOf (const char *type)
static
vtkXRenderWindowTclInteractor
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkXRenderWindowTclInteractor ()
 ~vtkXRenderWindowTclInteractor ()
virtual int InternalCreateTimer (int timerId, int timerType, unsigned long duration)
virtual int InternalDestroyTimer (int platformTimerId)
- Protected Member Functions inherited from vtkXRenderWindowInteractor
 vtkXRenderWindowInteractor ()
 ~vtkXRenderWindowInteractor ()
XtIntervalId AddTimeOut (XtAppContext app_context, unsigned long interval, XtTimerCallbackProc proc, XtPointer client_data)
void Timer (XtPointer client_data, XtIntervalId *id)
void Callback (Widget w, XtPointer client_data, XEvent *event, Boolean *ctd)
- Protected Member Functions inherited from vtkRenderWindowInteractor
 vtkRenderWindowInteractor ()
 ~vtkRenderWindowInteractor ()
int GetCurrentTimerId ()
void GrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void ReleaseFocus ()
- 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 &)

Additional Inherited Members

- Protected Attributes inherited from vtkXRenderWindowInteractor
Display * DisplayId
Window WindowId
Atom KillAtom
Widget Top
int OwnTop
int OwnApp
int PositionBeforeStereo [2]
Widget TopLevelShell
int TimerId
vtkXRenderWindowInteractorInternals * Internal
- Static Protected Attributes inherited from vtkXRenderWindowInteractor
static XtAppContext App
static int NumAppInitialized
static int BreakLoopFlag

Detailed Description

a TCL event driven interface for a RenderWindow

vtkXRenderWindowTclInteractor is a convenience object that provides event bindings to common graphics functions. For example, camera and actor functions such as zoom-in/zoom-out, azimuth, roll, and pan. It is one of the window system specific subclasses of vtkRenderWindowInteractor. Please see vtkRenderWindowInteractor documentation for event bindings.

See Also
vtkRenderWindowInteractor vtkXRenderWindowInteractor vtkXRenderWindow
Events:
vtkCommand::StartEvent vtkCommand::TimerEvent

Definition at line 38 of file vtkXRenderWindowTclInteractor.h.

Member Typedef Documentation

Definition at line 42 of file vtkXRenderWindowTclInteractor.h.

Constructor & Destructor Documentation

vtkXRenderWindowTclInteractor::vtkXRenderWindowTclInteractor ( )
protected
vtkXRenderWindowTclInteractor::~vtkXRenderWindowTclInteractor ( )
protected

Member Function Documentation

static vtkXRenderWindowTclInteractor* vtkXRenderWindowTclInteractor::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkXRenderWindowInteractor.

virtual const char* vtkXRenderWindowTclInteractor::GetClassName ( )
virtual

Reimplemented from vtkXRenderWindowInteractor.

static int vtkXRenderWindowTclInteractor::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 vtkXRenderWindowInteractor.

virtual int vtkXRenderWindowTclInteractor::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 vtkXRenderWindowInteractor.

static vtkXRenderWindowTclInteractor* vtkXRenderWindowTclInteractor::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkXRenderWindowInteractor.

void vtkXRenderWindowTclInteractor::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 vtkXRenderWindowInteractor.

virtual void vtkXRenderWindowTclInteractor::Initialize ( )
virtual

Initializes a Tcl/Tk specific event handler.

Reimplemented from vtkXRenderWindowInteractor.

virtual void vtkXRenderWindowTclInteractor::Initialize ( XtAppContext  app)
virtual

Overridden only to eliminate the "virtual function hidden" warning. Implementation delegates directly to the Superclass.

Reimplemented from vtkXRenderWindowInteractor.

virtual void vtkXRenderWindowTclInteractor::Enable ( )
virtual

Enable/Disable interactions. By default interactors are enabled when initialized. Initialize() must be called prior to enabling/disabling interaction. These methods are used when a window/widget is being shared by multiple renderers and interactors. This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.

Reimplemented from vtkXRenderWindowInteractor.

virtual void vtkXRenderWindowTclInteractor::Disable ( )
virtual

Enable/Disable interactions. By default interactors are enabled when initialized. Initialize() must be called prior to enabling/disabling interaction. These methods are used when a window/widget is being shared by multiple renderers and interactors. This allows a "modal" display where one interactor is active when its data is to be displayed and all other interactors associated with the widget are disabled when their data is not displayed.

Reimplemented from vtkXRenderWindowInteractor.

virtual void vtkXRenderWindowTclInteractor::Start ( )
virtual

This will start a Tcl/Tk event loop that only returns when the user presses the 'q' or 'e' key or when some other event observer calls our ExitCallback method.

Reimplemented from vtkXRenderWindowInteractor.

virtual int vtkXRenderWindowTclInteractor::InternalCreateTimer ( int  timerId,
int  timerType,
unsigned long  duration 
)
protectedvirtual

Tcl/Tk specific internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkXRenderWindowInteractor.

virtual int vtkXRenderWindowTclInteractor::InternalDestroyTimer ( int  platformTimerId)
protectedvirtual

Tcl/Tk specific internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkXRenderWindowInteractor.


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