Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# vtkCocoaRenderWindowInteractor Class Reference

`#include <vtkCocoaRenderWindowInteractor.h>`

Inheritance diagram for vtkCocoaRenderWindowInteractor:

[legend]
Collaboration diagram for vtkCocoaRenderWindowInteractor:

[legend]
List of all members.

## Detailed Description

implements Cocoa specific functions

Date:
  2002/08/22 19:27:36

Revision:
  1.2

required by vtkRenderWindowInteractor.

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

Created by:
  - Starreveld, Yves

CVS contributions (if > 5%):
  - Starreveld, Yves (99%)

CVS logs (CVSweb):
  - .`mm` (`/Rendering/vtkCocoaRenderWindowInteractor.mm)`
  - .`h` (`/Rendering/vtkCocoaRenderWindowInteractor.h)`

Definition at line 55 of file vtkCocoaRenderWindowInteractor.h.

## Public Types

typedef vtkRenderWindowInteractor | Superclass

## Public Methods

virtual const char * | GetClassName ()
virtual int | IsA (const char *type)
void | PrintSelf (ostream &os, vtkIndent indent)
virtual void | Initialize ()
virtual void | Start ()
void | TerminateApp (void)
virtual void | ExitCallback ()
virtual void | Enable ()
virtual void | Disable ()
virtual void | SetInstallMessageProc (int)
virtual int | GetInstallMessageProc ()
virtual void | InstallMessageProcOn ()
virtual void | InstallMessageProcOff ()
int | CreateTimer (int timertype)
int | DestroyTimer (void)

## Static Public Methods

vtkCocoaRenderWindowInteractor * | New ()
int | IsTypeOf (const char *type)
vtkCocoaRenderWindowInteractor * | SafeDownCast (vtkObject *o)
void | SetClassExitMethod (void(*f)(void *), void *arg)
void | SetClassExitMethodArgDelete (void(*f)(void *))

## Protected Methods

| vtkCocoaRenderWindowInteractor ()
| ~vtkCocoaRenderWindowInteractor ()

## Protected Attributes

void * | WindowId
void * | ApplicationId
int | TimerId
void * | OldProc
int | InstallMessageProc

## Static Protected Attributes

void(* | ClassExitMethod )(void *)
void(* | ClassExitMethodArgDelete )(void *)
void * | ClassExitMethodArg

## Member Typedef Documentation

typedef vtkRenderWindowInteractor vtkCocoaRenderWindowInteractor::Superclass

| Reimplemented from vtkRenderWindowInteractor. Definition at line 60 of file vtkCocoaRenderWindowInteractor.h.

## Constructor & Destructor Documentation

vtkCocoaRenderWindowInteractor::vtkCocoaRenderWindowInteractor | ( |  | ) | `[protected]`

vtkCocoaRenderWindowInteractor::~vtkCocoaRenderWindowInteractor | ( |  | ) | `[protected]`

## Member Function Documentation

vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::New | ( |  | ) | `[static]`

| Construct object so that light follows camera motion. Reimplemented from vtkRenderWindowInteractor.

virtual const char* vtkCocoaRenderWindowInteractor::GetClassName | ( |  | ) | `[virtual]`

| Reimplemented from vtkRenderWindowInteractor.

int vtkCocoaRenderWindowInteractor::IsTypeOf | ( | const char * | type | ) | `[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 * | type | ) | `[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.

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 | ( | void |  | ) | `[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.

int vtkCocoaRenderWindowInteractor::CreateTimer | ( | int | timertype | ) | `[virtual]`

| Cocoa timer methods Reimplemented from vtkRenderWindowInteractor.

int vtkCocoaRenderWindowInteractor::DestroyTimer | ( | void |  | ) | `[virtual]`

| Cocoa timer methods Reimplemented from vtkRenderWindowInteractor.

void vtkCocoaRenderWindowInteractor::SetClassExitMethod | ( | void(* | f)(void *),
|  | 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.).

void vtkCocoaRenderWindowInteractor::SetClassExitMethodArgDelete | ( | void(* | f)(void *) | ) | `[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.

## Member Data Documentation

void* vtkCocoaRenderWindowInteractor::WindowId`[protected]`

| Definition at line 126 of file vtkCocoaRenderWindowInteractor.h.

void* vtkCocoaRenderWindowInteractor::ApplicationId`[protected]`

| Definition at line 127 of file vtkCocoaRenderWindowInteractor.h.

int vtkCocoaRenderWindowInteractor::TimerId`[protected]`

| Definition at line 128 of file vtkCocoaRenderWindowInteractor.h.

void* vtkCocoaRenderWindowInteractor::OldProc`[protected]`

| Definition at line 129 of file vtkCocoaRenderWindowInteractor.h.

int vtkCocoaRenderWindowInteractor::InstallMessageProc`[protected]`

| Definition at line 130 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)

void* vtkCocoaRenderWindowInteractor::ClassExitMethodArg`[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) Definition at line 139 of file vtkCocoaRenderWindowInteractor.h.

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

- Rendering/vtkCocoaRenderWindowInteractor.h