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

#include <vtkCocoaRenderWindowInteractor.h>

Inheritance diagram for vtkCocoaRenderWindowInteractor:

Collaboration diagram for vtkCocoaRenderWindowInteractor:

Public Types
typedef vtkRenderWindowInteractor	Superclass

typedef vtkRenderWindowInteractor	Superclass

Public Types inherited from vtkRenderWindowInteractor
enum	{ OneShotTimer =1, RepeatingTimer }

typedef vtkObject	Superclass

Public Member Functions
virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCocoaRenderWindowInteractor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Initialize ()
	Initialize the even handler. More...

void	TerminateApp ()
	Cocoa specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate app. More...

virtual void	ExitCallback ()
	These methods correspond to the the Exit, User and Pick callbacks. More...

virtual int	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCocoaRenderWindowInteractor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	Initialize ()
	Initialize the even handler. More...

void	TerminateApp ()
	Cocoa specific application terminate, calls ClassExitMethod then calls PostQuitMessage(0) to terminate app. More...

virtual void	ExitCallback ()
	These methods correspond to the the Exit, User and Pick callbacks. More...


virtual void	Enable ()
	Enable/Disable interactions. More...

virtual void	Disable ()
	Enable/Disable interactions. More...


virtual void	Enable ()
	Enable/Disable interactions. More...

virtual void	Disable ()
	Enable/Disable interactions. More...

Public Member Functions inherited from vtkRenderWindowInteractor
vtkRenderWindowInteractor *	NewInstance () const

virtual void	UnRegister (vtkObjectBase *o)
	This Method detects loops of RenderWindow-Interactor, so objects are freed properly. More...

virtual void	Start ()
	Start the event loop. More...

virtual int	GetEnabled ()

virtual void	UpdateSize (int x, int y)
	Event loop notification member for window size change. More...

virtual int	CreateTimer (int timerType)
	This class provides two groups of methods for manipulating timers. More...

virtual int	DestroyTimer ()

int	CreateRepeatingTimer (unsigned long duration)
	Create a repeating timer, with the specified duration (in milliseconds). More...

int	CreateOneShotTimer (unsigned long duration)
	Create a one shot timer, with the specified duretion (in milliseconds). More...

int	IsOneShotTimer (int timerId)
	Query whether the specified timerId is a one shot timer. More...

unsigned long	GetTimerDuration (int timerId)
	Get the duration (in milliseconds) for the specified timerId. More...

int	ResetTimer (int timerId)
	Reset the specified timer. More...

int	DestroyTimer (int timerId)
	Destroy the timer specified by timerId. More...

virtual int	GetVTKTimerId (int platformTimerId)
	Get the VTK timer ID that corresponds to the supplied platform ID. More...

virtual vtkAbstractPropPicker *	CreateDefaultPicker ()
	Create default picker. More...

virtual void	GetMousePosition (int x, int y)
	Get the current position of the mouse. More...

virtual void	Render ()
	Render the scene. More...

virtual int *	GetEventPositions (int pointerIndex)

virtual int *	GetLastEventPositions (int pointerIndex)

virtual void	SetEventPosition (int x, int y, int pointerIndex)

virtual void	SetEventPosition (int pos[2], int pointerIndex)

virtual void	SetEventPositionFlipY (int x, int y, int pointerIndex)

virtual void	SetEventPositionFlipY (int pos[2], int pointerIndex)

virtual vtkRenderer *	FindPokedRenderer (int, int)
	When an event occurs, we must determine which Renderer the event occurred within, since one RenderWindow may contain multiple renderers. More...

vtkObserverMediator *	GetObserverMediator ()
	Return the object used to mediate between vtkInteractorObservers contending for resources. More...

void	ReInitialize ()
	Prepare for handling events and set the Enabled flag to true. More...

virtual void	EnableRenderOn ()
	Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render(). More...

virtual void	EnableRenderOff ()
	Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render(). More...

virtual void	SetEnableRender (bool)
	Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render(). More...

virtual bool	GetEnableRender ()
	Enable/Disable whether vtkRenderWindowInteractor::Render() calls this->RenderWindow->Render(). More...

void	SetRenderWindow (vtkRenderWindow *aren)
	Set/Get the rendering window being controlled by this object. More...

virtual vtkRenderWindow *	GetRenderWindow ()
	Set/Get the rendering window being controlled by this object. More...

virtual void	SetTimerDuration (unsigned long)
	Specify the default timer interval (in milliseconds). More...

virtual unsigned long	GetTimerDuration ()
	Specify the default timer interval (in milliseconds). More...

virtual void	SetTimerEventId (int)
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual int	GetTimerEventId ()
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual void	SetTimerEventType (int)
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual int	GetTimerEventType ()
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual void	SetTimerEventDuration (int)
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual int	GetTimerEventDuration ()
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual void	SetTimerEventPlatformId (int)
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual int	GetTimerEventPlatformId ()
	These methods are used to communicate information about the currently firing CreateTimerEvent or DestroyTimerEvent. More...

virtual void	SetInteractorStyle (vtkInteractorObserver *)
	External switching between joystick/trackball/new? modes. More...

virtual vtkInteractorObserver *	GetInteractorStyle ()
	External switching between joystick/trackball/new? modes. More...

virtual void	SetLightFollowCamera (int)
	Turn on/off the automatic repositioning of lights as the camera moves. More...

virtual int	GetLightFollowCamera ()
	Turn on/off the automatic repositioning of lights as the camera moves. More...

virtual void	LightFollowCameraOn ()
	Turn on/off the automatic repositioning of lights as the camera moves. More...

virtual void	LightFollowCameraOff ()
	Turn on/off the automatic repositioning of lights as the camera moves. More...

virtual void	SetDesiredUpdateRate (double)
	Set/Get the desired update rate. More...

virtual double	GetDesiredUpdateRate ()
	Set/Get the desired update rate. More...

virtual void	SetStillUpdateRate (double)
	Set/Get the desired update rate when movement has stopped. More...

virtual double	GetStillUpdateRate ()
	Set/Get the desired update rate when movement has stopped. More...

virtual int	GetInitialized ()
	See whether interactor has been initialized yet. More...

virtual void	SetPicker (vtkAbstractPicker *)
	Set/Get the object used to perform pick operations. More...

virtual vtkAbstractPicker *	GetPicker ()
	Set/Get the object used to perform pick operations. More...

virtual void	SetPickingManager (vtkPickingManager *)
	Set the picking manager. More...

virtual vtkPickingManager *	GetPickingManager ()
	Set the picking manager. More...

virtual void	UserCallback ()
	These methods correspond to the the Exit, User and Pick callbacks. More...

virtual void	StartPickCallback ()
	These methods correspond to the the Exit, User and Pick callbacks. More...

virtual void	EndPickCallback ()
	These methods correspond to the the Exit, User and Pick callbacks. More...

void	HideCursor ()
	Hide or show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. More...

void	ShowCursor ()
	Hide or show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead. More...

void	FlyTo (vtkRenderer *ren, double x, double y, double z)
	Given a position x, move the current camera's focal point to x. More...

void	FlyTo (vtkRenderer ren, double x)
	Given a position x, move the current camera's focal point to x. More...

void	FlyToImage (vtkRenderer *ren, double x, double y)
	Given a position x, move the current camera's focal point to x. More...

void	FlyToImage (vtkRenderer ren, double x)
	Given a position x, move the current camera's focal point to x. More...

virtual void	SetNumberOfFlyFrames (int)
	Set the number of frames to fly to when FlyTo is invoked. More...

virtual int	GetNumberOfFlyFrames ()
	Set the number of frames to fly to when FlyTo is invoked. More...

virtual void	SetDolly (double)
	Set the total Dolly value to use when flying to (FlyTo()) a specified point. More...

virtual double	GetDolly ()
	Set the total Dolly value to use when flying to (FlyTo()) a specified point. More...

virtual int *	GetEventPosition ()
	Set/Get information about the current event. More...

virtual void	GetEventPosition (int &, int &)
	Set/Get information about the current event. More...

virtual void	GetEventPosition (int[2])
	Set/Get information about the current event. More...

virtual int *	GetLastEventPosition ()
	Set/Get information about the current event. More...

virtual void	GetLastEventPosition (int &, int &)
	Set/Get information about the current event. More...

virtual void	GetLastEventPosition (int[2])
	Set/Get information about the current event. More...

virtual void	SetLastEventPosition (int, int)
	Set/Get information about the current event. More...

void	SetLastEventPosition (int[2])
	Set/Get information about the current event. More...

virtual void	SetEventPosition (int x, int y)
	Set/Get information about the current event. More...

virtual void	SetEventPosition (int pos[2])
	Set/Get information about the current event. More...

virtual void	SetEventPositionFlipY (int x, int y)
	Set/Get information about the current event. More...

virtual void	SetEventPositionFlipY (int pos[2])
	Set/Get information about the current event. More...

virtual void	SetAltKey (int)
	Set/get whether alt modifier key was pressed. More...

virtual int	GetAltKey ()
	Set/get whether alt modifier key was pressed. More...

virtual void	SetControlKey (int)
	Set/get whether control modifier key was pressed. More...

virtual int	GetControlKey ()
	Set/get whether control modifier key was pressed. More...

virtual void	SetShiftKey (int)
	Set/get whether shift modifier key was pressed. More...

virtual int	GetShiftKey ()
	Set/get whether shift modifier key was pressed. More...

virtual void	SetKeyCode (char)
	Set/get the key code for the key that was pressed. More...

virtual char	GetKeyCode ()
	Set/get the key code for the key that was pressed. More...

virtual void	SetRepeatCount (int)
	Set/get the repear count for the key or mouse event. More...

virtual int	GetRepeatCount ()
	Set/get the repear count for the key or mouse event. More...

virtual void	SetKeySym (const char *)
	Set/get the key symbol for the key that was pressed. More...

virtual char *	GetKeySym ()
	Set/get the key symbol for the key that was pressed. More...

virtual void	SetPointerIndex (int)
	Set/get the index of the most recent pointer to have an event. More...

virtual int	GetPointerIndex ()
	Set/get the index of the most recent pointer to have an event. More...

void	SetRotation (double val)
	Set/get the rotation for the gesture in degrees, update LastRotation. More...

virtual double	GetRotation ()
	Set/get the rotation for the gesture in degrees, update LastRotation. More...

virtual double	GetLastRotation ()
	Set/get the rotation for the gesture in degrees, update LastRotation. More...

void	SetScale (double val)
	Set/get the scale for the gesture, updates LastScale. More...

virtual double	GetScale ()
	Set/get the scale for the gesture, updates LastScale. More...

virtual double	GetLastScale ()
	Set/get the scale for the gesture, updates LastScale. More...

void	SetTranslation (double val[2])
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual double *	GetTranslation ()
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual void	GetTranslation (double &, double &)
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual void	GetTranslation (double[2])
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual double *	GetLastTranslation ()
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual void	GetLastTranslation (double &, double &)
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

virtual void	GetLastTranslation (double[2])
	Set/get the tranlation for pan/swipe gestures, update LastTranslation. More...

void	SetEventInformation (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)
	Set all the event information in one call. More...

void	SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
	Set all the event information in one call. More...

void	SetEventInformationFlipY (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)
	Calls SetEventInformation, but flips the Y based on the current Size[1] value (i.e. More...

void	SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
	Calls SetEventInformation, but flips the Y based on the current Size[1] value (i.e. More...

void	SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)
	Set all the keyboard-related event information in one call. More...

virtual void	SetSize (int, int)
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

void	SetSize (int[2])
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual int *	GetSize ()
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	GetSize (int &, int &)
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	GetSize (int[2])
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	SetEventSize (int, int)
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

void	SetEventSize (int[2])
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual int *	GetEventSize ()
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	GetEventSize (int &, int &)
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	GetEventSize (int[2])
	This methods sets the Size ivar of the interactor without actually changing the size of the window. More...

virtual void	SetUseTDx (bool)
	Use a 3DConnexion device. More...

virtual bool	GetUseTDx ()
	Use a 3DConnexion device. More...

virtual void	MouseMoveEvent ()
	Fire various events. More...

virtual void	RightButtonPressEvent ()
	Fire various events. More...

virtual void	RightButtonReleaseEvent ()
	Fire various events. More...

virtual void	LeftButtonPressEvent ()
	Fire various events. More...

virtual void	LeftButtonReleaseEvent ()
	Fire various events. More...

virtual void	MiddleButtonPressEvent ()
	Fire various events. More...

virtual void	MiddleButtonReleaseEvent ()
	Fire various events. More...

virtual void	MouseWheelForwardEvent ()
	Fire various events. More...

virtual void	MouseWheelBackwardEvent ()
	Fire various events. More...

virtual void	ExposeEvent ()
	Fire various events. More...

virtual void	ConfigureEvent ()
	Fire various events. More...

virtual void	EnterEvent ()
	Fire various events. More...

virtual void	LeaveEvent ()
	Fire various events. More...

virtual void	KeyPressEvent ()
	Fire various events. More...

virtual void	KeyReleaseEvent ()
	Fire various events. More...

virtual void	CharEvent ()
	Fire various events. More...

virtual void	ExitEvent ()
	Fire various events. More...

virtual void	StartPinchEvent ()
	Fire various gesture based events. More...

virtual void	PinchEvent ()
	Fire various gesture based events. More...

virtual void	EndPinchEvent ()
	Fire various gesture based events. More...

virtual void	StartRotateEvent ()
	Fire various gesture based events. More...

virtual void	RotateEvent ()
	Fire various gesture based events. More...

virtual void	EndRotateEvent ()
	Fire various gesture based events. More...

virtual void	StartPanEvent ()
	Fire various gesture based events. More...

virtual void	PanEvent ()
	Fire various gesture based events. More...

virtual void	EndPanEvent ()
	Fire various gesture based events. More...

virtual void	TapEvent ()
	Fire various gesture based events. More...

virtual void	LongTapEvent ()
	Fire various gesture based events. More...

virtual void	SwipeEvent ()
	Fire various gesture based events. More...

virtual void	SetRecognizeGestures (bool)
	Convert multitouch events into gestures. More...

virtual bool	GetRecognizeGestures ()
	Convert multitouch events into gestures. More...

virtual int	GetPointersDownCount ()
	When handling gestures you can query this value to determine how many pointers are down for the gesture this is useful for pan gestures for example. More...

void	ClearContact (size_t contactID)
	Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...

int	GetPointerIndexForContact (size_t contactID)
	Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...

int	GetPointerIndexForExistingContact (size_t contactID)
	Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...

bool	IsPointerIndexSet (int i)
	Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...

void	ClearPointerIndex (int i)
	Most multitouch systems use persistent contact/pointer ids to track events/motion during multitouch events. More...

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...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

int	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

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	Register (vtkObjectBase *o)
	Increase the reference count (mark as used 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...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkCocoaRenderWindowInteractor *	New ()
	Construct object so that light follows camera motion. More...

static int	IsTypeOf (const char *type)

static vtkCocoaRenderWindowInteractor *	SafeDownCast (vtkObjectBase *o)

static vtkCocoaRenderWindowInteractor *	New ()
	Construct object so that light follows camera motion. More...

static int	IsTypeOf (const char *type)

static vtkCocoaRenderWindowInteractor *	SafeDownCast (vtkObjectBase *o)


static void	SetClassExitMethod (void(f)(void ), void *arg)
	Methods to set the default exit method for the class. More...

static void	SetClassExitMethodArgDelete (void(f)(void ))
	Methods to set the default exit method for the class. More...


static void	SetClassExitMethod (void(f)(void ), void *arg)
	Methods to set the default exit method for the class. More...

static void	SetClassExitMethodArgDelete (void(f)(void ))
	Methods to set the default exit method for the class. More...

Static Public Member Functions inherited from vtkRenderWindowInteractor
static vtkRenderWindowInteractor *	New ()

static int	IsTypeOf (const char *type)

static vtkRenderWindowInteractor *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCocoaRenderWindowInteractor ()

	~vtkCocoaRenderWindowInteractor ()

void	SetTimerDictionary (void *dictionary)
	Accessors for the Cocoa member variables. More...

void *	GetTimerDictionary ()

virtual void	StartEventLoop ()
	This will start up the event loop and never return. More...

virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCocoaRenderWindowInteractor ()

	~vtkCocoaRenderWindowInteractor ()

void	SetTimerDictionary (void *dictionary)
	Accessors for the Cocoa member variables. More...

void *	GetTimerDictionary ()

virtual void	StartEventLoop ()
	This will start up the event loop and never return. More...


virtual int	InternalCreateTimer (int timerId, int timerType, unsigned long duration)
	Cocoa-specific internal timer methods. More...

virtual int	InternalDestroyTimer (int platformTimerId)
	Cocoa-specific internal timer methods. More...


void	SetCocoaManager (void *manager)
	Accessors for the cocoa manager (Really an NSMutableDictionary*). More...

void *	GetCocoaManager ()
	Accessors for the cocoa manager (Really an NSMutableDictionary*). More...


virtual int	InternalCreateTimer (int timerId, int timerType, unsigned long duration)
	Cocoa-specific internal timer methods. More...

virtual int	InternalDestroyTimer (int platformTimerId)
	Cocoa-specific internal timer methods. More...


void	SetCocoaManager (void *manager)
	Accessors for the cocoa manager (Really an NSMutableDictionary*). More...

void *	GetCocoaManager ()
	Accessors for the cocoa manager (Really an NSMutableDictionary*). More...

Protected Member Functions inherited from vtkRenderWindowInteractor
	vtkRenderWindowInteractor ()

	~vtkRenderWindowInteractor ()

virtual vtkPickingManager *	CreateDefaultPickingManager ()
	Create default pickingManager. More...

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

virtual void	RecognizeGesture (vtkCommand::EventIds)

int	GetCurrentTimerId ()
	Internal methods for creating and destroying timers that must be implemented by subclasses. More...

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=NULL)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Attributes

static void(*	ClassExitMethod )(void *)
	Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. More...

static void(*	ClassExitMethodArgDelete )(void *)
	Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. More...

static void *	ClassExitMethodArg
	Class variables so an exit method can be defined for this class (used to set different exit methods for various language bindings, i.e. More...

Additional Inherited Members
Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindow *	RenderWindow

vtkInteractorObserver *	InteractorStyle

vtkAbstractPicker *	Picker

vtkPickingManager *	PickingManager

int	Initialized

int	Enabled

bool	EnableRender

int	Style

int	LightFollowCamera

int	ActorMode

double	DesiredUpdateRate

double	StillUpdateRate

int	AltKey

int	ControlKey

int	ShiftKey

char	KeyCode

double	Rotation

double	LastRotation

double	Scale

double	LastScale

double	Translation [2]

double	LastTranslation [2]

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	EventPositions [VTKI_MAX_POINTERS][2]

int	LastEventPositions [VTKI_MAX_POINTERS][2]

int	PointerIndex

size_t	PointerIndexLookup [VTKI_MAX_POINTERS]

int	NumberOfFlyFrames

double	Dolly

vtkObserverMediator *	ObserverMediator
	Widget mediators are used to resolve contention for cursors and other resources. More...

vtkTimerIdMap *	TimerMap

unsigned long	TimerDuration

int	HandleEventLoop

bool	UseTDx

bool	RecognizeGestures

int	PointersDownCount

int	PointersDown [VTKI_MAX_POINTERS]

int	StartingEventPositions [VTKI_MAX_POINTERS][2]

vtkCommand::EventIds	CurrentGesture

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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. Since OS X applications typically use the Command key where UNIX and Windows applications would use the Ctrl key, this interactor maps the Command key to Ctrl. In versions of VTK prior to VTK 6.2, it was mapped to Alt. On OS X, the Option key can be used as Alt.

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.

Definition at line 43 of file vtkCocoaRenderWindowInteractor.h.

Member Typedef Documentation

typedef vtkRenderWindowInteractor vtkCocoaRenderWindowInteractor::Superclass

Definition at line 51 of file vtkCocoaRenderWindowInteractor.h.

typedef vtkRenderWindowInteractor vtkCocoaRenderWindowInteractor::Superclass

Definition at line 51 of file vtkCocoaRenderWindowInteractor.h.

Constructor & Destructor Documentation

vtkCocoaRenderWindowInteractor::vtkCocoaRenderWindowInteractor ( )

protected

vtkCocoaRenderWindowInteractor::~vtkCocoaRenderWindowInteractor ( )

protected

vtkCocoaRenderWindowInteractor::vtkCocoaRenderWindowInteractor ( )

protected

vtkCocoaRenderWindowInteractor::~vtkCocoaRenderWindowInteractor ( )

protected

Member Function Documentation

static vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::New ( )

static

Construct object so that light follows camera motion.

static int vtkCocoaRenderWindowInteractor::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCocoaRenderWindowInteractor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::NewInstance ( ) const

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.

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

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.

virtual void vtkCocoaRenderWindowInteractor::StartEventLoop ( )

protectedvirtual

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.

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.

static vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::New ( )

static

Construct object so that light follows camera motion.

static int vtkCocoaRenderWindowInteractor::IsTypeOf ( const char * type )

static

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 ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCocoaRenderWindowInteractor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::NewInstance ( ) const

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.

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

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.

virtual void vtkCocoaRenderWindowInteractor::StartEventLoop ( )

protectedvirtual

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.

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

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

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

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

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkCocoaRenderWindowInteractor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation