vtkCocoaRenderWindowInteractor Class Reference

#include <vtkCocoaRenderWindowInteractor.h>

Inheritance diagram for vtkCocoaRenderWindowInteractor:

Inheritance graph
[legend]
Collaboration diagram for vtkCocoaRenderWindowInteractor:

Collaboration graph
[legend]

List of all members.


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 34 of file vtkCocoaRenderWindowInteractor.h.


Public Types

typedef vtkRenderWindowInteractor 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 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 ()

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 Attributes

int InstallMessageProc

Static Protected Attributes

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

Member Typedef Documentation

Reimplemented from vtkRenderWindowInteractor.

Definition at line 40 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro 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 
) [protected, virtual]

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

Reimplemented from vtkRenderWindowInteractor.

virtual int vtkCocoaRenderWindowInteractor::InternalDestroyTimer ( int  platformTimerId  )  [protected, virtual]

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

Definition at line 100 of file vtkCocoaRenderWindowInteractor.h.

void(* vtkCocoaRenderWindowInteractor::ClassExitMethod)(void *) [static, protected]

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)

void(* vtkCocoaRenderWindowInteractor::ClassExitMethodArgDelete)(void *) [static, protected]

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)

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 118 of file vtkCocoaRenderWindowInteractor.h.


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

Generated on Wed Jun 3 18:57:15 2009 for VTK by  doxygen 1.5.6