VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkCocoaRenderWindowInteractor Class Reference

implements Cocoa specific functions required by vtkRenderWindowInteractor. More...

#include <vtkCocoaRenderWindowInteractor.h>

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

List of all members.

Public Types

typedef vtkRenderWindowInteractor Superclass
- Public Types inherited from vtkRenderWindowInteractor
enum  { OneShotTimer = 1, RepeatingTimer }
- 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 Initialize ()
virtual void Start ()
void TerminateApp ()
virtual void ExitCallback ()
virtual void Enable ()
virtual void Disable ()
virtual void SetInstallMessageProc (int)
virtual int GetInstallMessageProc ()
virtual void InstallMessageProcOn ()
virtual void InstallMessageProcOff ()
- Public Member Functions inherited from vtkRenderWindowInteractor
virtual void UnRegister (vtkObjectBase *o)
virtual void UpdateSize (int x, int y)
virtual vtkAbstractPropPickerCreateDefaultPicker ()
virtual void GetMousePosition (int *x, int *y)
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 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
vtkCocoaRenderWindowInteractor
New ()
static int IsTypeOf (const char *type)
static
vtkCocoaRenderWindowInteractor
SafeDownCast (vtkObject *o)
static void SetClassExitMethod (void(*f)(void *), void *arg)
static void SetClassExitMethodArgDelete (void(*f)(void *))

Protected Member Functions

 vtkCocoaRenderWindowInteractor ()
 ~vtkCocoaRenderWindowInteractor ()
void SetTimerDictionary (void *dictionary)
void * GetTimerDictionary ()
void SetCocoaServer (void *server)
void * GetCocoaServer ()
virtual int InternalCreateTimer (int timerId, int timerType, unsigned long duration)
virtual int InternalDestroyTimer (int platformTimerId)
void SetCocoaManager (void *manager)
void * GetCocoaManager ()
- 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 &)

Protected Attributes

int InstallMessageProc
- Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindowRenderWindow
vtkInteractorObserverInteractorStyle
vtkAbstractPickerPicker
int Initialized
int Enabled
bool EnableRender
int Style
int LightFollowCamera
int ActorMode
double DesiredUpdateRate
double StillUpdateRate
int AltKey
int ControlKey
int ShiftKey
char KeyCode
int RepeatCount
char * KeySym
int EventPosition [2]
int LastEventPosition [2]
int EventSize [2]
int Size [2]
int TimerEventId
int TimerEventType
int TimerEventDuration
int TimerEventPlatformId
int NumberOfFlyFrames
double Dolly
vtkObserverMediatorObserverMediator
vtkTimerIdMap * TimerMap
unsigned long TimerDuration
int HandleEventLoop
bool UseTDx
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

Static Protected Attributes

static void(* ClassExitMethod )(void *)
static void(* ClassExitMethodArgDelete )(void *)
static void * ClassExitMethodArg

Detailed Description

implements Cocoa specific functions required by vtkRenderWindowInteractor.

The interactor interfaces with vtkCocoaRenderWindow and vtkCocoaGLView to trap messages from the Cocoa window manager and send them to vtk.

IMPORTANT: This header must be in C++ only because it is included by .cxx files. That means no Objective C may be used. That's why some instance variables are void* instead of what they really should be. Pitty.

Definition at line 37 of file vtkCocoaRenderWindowInteractor.h.


Member Typedef Documentation

Reimplemented from vtkRenderWindowInteractor.

Definition at line 43 of file vtkCocoaRenderWindowInteractor.h.


Constructor & Destructor Documentation

vtkCocoaRenderWindowInteractor::vtkCocoaRenderWindowInteractor ( )
protected
vtkCocoaRenderWindowInteractor::~vtkCocoaRenderWindowInteractor ( )
protected

Member Function Documentation

static vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::New ( )
static

Construct object so that light follows camera motion.

Reimplemented from vtkRenderWindowInteractor.

virtual const char* vtkCocoaRenderWindowInteractor::GetClassName ( )
virtual

Reimplemented from vtkRenderWindowInteractor.

static int vtkCocoaRenderWindowInteractor::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 vtkRenderWindowInteractor.

virtual int vtkCocoaRenderWindowInteractor::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 vtkRenderWindowInteractor.

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

Reimplemented from vtkRenderWindowInteractor.

void vtkCocoaRenderWindowInteractor::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 vtkRenderWindowInteractor.

virtual void vtkCocoaRenderWindowInteractor::Initialize ( )
virtual

Initialize the even handler

Reimplemented from vtkRenderWindowInteractor.

virtual void vtkCocoaRenderWindowInteractor::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 vtkRenderWindowInteractor.

virtual void vtkCocoaRenderWindowInteractor::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 vtkRenderWindowInteractor.

virtual void vtkCocoaRenderWindowInteractor::Start ( )
virtual

This will start up the event loop and never return. If you call this method it will loop processing events until the application is exited.

Reimplemented from vtkRenderWindowInteractor.

virtual void vtkCocoaRenderWindowInteractor::SetInstallMessageProc ( int  )
virtual

By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.

virtual int vtkCocoaRenderWindowInteractor::GetInstallMessageProc ( )
virtual

By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.

virtual void vtkCocoaRenderWindowInteractor::InstallMessageProcOn ( )
virtual

By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.

virtual void vtkCocoaRenderWindowInteractor::InstallMessageProcOff ( )
virtual

By default the interactor installs a MessageProc callback which intercepts windows messages to the window and controls interactions. MFC or BCB programs can prevent this and instead directly route any mouse/key messages into the event bindings by setting InstallMessgeProc to false.

void vtkCocoaRenderWindowInteractor::TerminateApp ( )
virtual

Cocoa specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate app. An application can Specify ExitMethod for alternative behaviour (i.e. suppresion of keyboard exit)

Reimplemented from vtkRenderWindowInteractor.

static void vtkCocoaRenderWindowInteractor::SetClassExitMethod ( void(*)(void *)  f,
void *  arg 
)
static

Methods to set the default exit method for the class. This method is only used if no instance level ExitMethod has been defined. It is provided as a means to control how an interactor is exited given the various language bindings (tcl, Cocoa, etc.).

static void vtkCocoaRenderWindowInteractor::SetClassExitMethodArgDelete ( void(*)(void *)  f)
static

Methods to set the default exit method for the class. This method is only used if no instance level ExitMethod has been defined. It is provided as a means to control how an interactor is exited given the various language bindings (tcl, Cocoa, etc.).

virtual void vtkCocoaRenderWindowInteractor::ExitCallback ( )
virtual

These methods correspond to the the Exit, User and Pick callbacks. They allow for the Style to invoke them.

Reimplemented from vtkRenderWindowInteractor.

void vtkCocoaRenderWindowInteractor::SetTimerDictionary ( void *  dictionary)
protected

Accessors for the Cocoa member variables. These should be used at all time, even by this class.

void* vtkCocoaRenderWindowInteractor::GetTimerDictionary ( )
protected

Accessors for the Cocoa member variables. These should be used at all time, even by this class.

void vtkCocoaRenderWindowInteractor::SetCocoaServer ( void *  server)
protected

Accessors for the Cocoa member variables. These should be used at all time, even by this class.

void* vtkCocoaRenderWindowInteractor::GetCocoaServer ( )
protected

Accessors for the Cocoa member variables. These should be used at all time, even by this class.

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

Cocoa-specific internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

virtual int vtkCocoaRenderWindowInteractor::InternalDestroyTimer ( int  platformTimerId)
protectedvirtual

Cocoa-specific internal timer methods. See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

void vtkCocoaRenderWindowInteractor::SetCocoaManager ( void *  manager)
protected

Accessors for the cocoa manager (Really an NSMutableDictionary*). It manages all Cocoa objects in this C++ class.

void* vtkCocoaRenderWindowInteractor::GetCocoaManager ( )
protected

Accessors for the cocoa manager (Really an NSMutableDictionary*). It manages all Cocoa objects in this C++ class.


Member Data Documentation

int vtkCocoaRenderWindowInteractor::InstallMessageProc
protected

Definition at line 103 of file vtkCocoaRenderWindowInteractor.h.

void(* vtkCocoaRenderWindowInteractor::ClassExitMethod)(void *)
staticprotected

Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Cocoa)

Definition at line 119 of file vtkCocoaRenderWindowInteractor.h.

void(* vtkCocoaRenderWindowInteractor::ClassExitMethodArgDelete)(void *)
staticprotected

Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Cocoa)

Definition at line 120 of file vtkCocoaRenderWindowInteractor.h.

void* vtkCocoaRenderWindowInteractor::ClassExitMethodArg
staticprotected

Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. tcl, java, Cocoa)

Definition at line 121 of file vtkCocoaRenderWindowInteractor.h.


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