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

#include <vtkCocoaRenderWindowInteractor.h>

Inheritance diagram for vtkCocoaRenderWindowInteractor:

Collaboration diagram for vtkCocoaRenderWindowInteractor:

Public Types
typedef vtkRenderWindowInteractor	Superclass

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

typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	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) override
	Methods invoked by print to print information about the object including superclasses. More...

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

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

void	Disable () override

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

void	ProcessEvents () override
	Run the event loop and return. More...

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

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

void	ReInitialize ()

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

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

virtual bool	GetDone ()
	Is the interactor loop done. More...

virtual void	SetDone (bool)

virtual int	GetEnabled ()

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

virtual void	EnableRenderOff ()

virtual void	SetEnableRender (bool)

virtual bool	GetEnableRender ()

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

virtual vtkRenderWindow *	GetRenderWindow ()

void	SetHardwareWindow (vtkHardwareWindow *aren)
	Set/Get the hardware window being controlled by this object. More...

virtual vtkHardwareWindow *	GetHardwareWindow ()

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 duration (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 void	SetTimerDuration (unsigned long)
	Specify the default timer interval (in milliseconds). More...

virtual unsigned long	GetTimerDuration ()

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

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 *)
	External switching between joystick/trackball/new? modes. More...

virtual vtkInteractorObserver *	GetInteractorStyle ()

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

virtual vtkTypeBool	GetLightFollowCamera ()

virtual void	LightFollowCameraOn ()

virtual void	LightFollowCameraOff ()

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

virtual double	GetDesiredUpdateRate ()

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

virtual double	GetStillUpdateRate ()

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

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

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

virtual vtkPickingManager *	GetPickingManager ()

virtual void	UserCallback ()

virtual void	StartPickCallback ()

virtual void	EndPickCallback ()

virtual void	GetMousePosition (int x, int y)
	Get the current position of the mouse. 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 ()

virtual void	Render ()
	Render the scene. 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)

void	FlyToImage (vtkRenderer *ren, double x, double y)

void	FlyToImage (vtkRenderer ren, double x)

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

virtual int	GetNumberOfFlyFrames ()

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

virtual double	GetDolly ()

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

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 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 void	SetAltKey (int)
	Set/get whether alt modifier key was pressed. More...

virtual int	GetAltKey ()

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

virtual int	GetControlKey ()

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

virtual int	GetShiftKey ()

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

virtual char	GetKeyCode ()

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

virtual int	GetRepeatCount ()

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

virtual char *	GetKeySym ()

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

virtual int	GetPointerIndex ()

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

virtual double	GetRotation ()

virtual double	GetLastRotation ()

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

virtual double	GetScale ()

virtual double	GetLastScale ()

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

virtual double *	GetTranslation ()

virtual void	GetTranslation (double &, double &)

virtual void	GetTranslation (double[2])

virtual double *	GetLastTranslation ()

virtual void	GetLastTranslation (double &, double &)

virtual void	GetLastTranslation (double[2])

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=nullptr)

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=nullptr)

void	SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=nullptr)
	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])

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

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

virtual bool	GetUseTDx ()

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

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	MouseWheelLeftEvent ()

virtual void	MouseWheelRightEvent ()

virtual void	ExposeEvent ()

virtual void	ConfigureEvent ()

virtual void	EnterEvent ()

virtual void	LeaveEvent ()

virtual void	KeyPressEvent ()

virtual void	KeyReleaseEvent ()

virtual void	CharEvent ()

virtual void	ExitEvent ()

virtual void	FourthButtonPressEvent ()

virtual void	FourthButtonReleaseEvent ()

virtual void	FifthButtonPressEvent ()

virtual void	FifthButtonReleaseEvent ()

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

virtual void	PinchEvent ()

virtual void	EndPinchEvent ()

virtual void	StartRotateEvent ()

virtual void	RotateEvent ()

virtual void	EndRotateEvent ()

virtual void	StartPanEvent ()

virtual void	PanEvent ()

virtual void	EndPanEvent ()

virtual void	TapEvent ()

virtual void	LongTapEvent ()

virtual void	SwipeEvent ()

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

virtual bool	GetRecognizeGestures ()

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)

int	GetPointerIndexForExistingContact (size_t contactID)

bool	IsPointerIndexSet (int i)

void	ClearPointerIndex (int i)

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

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)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

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)

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

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

static vtkTypeBool	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 ))

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

static vtkTypeBool	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 ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCocoaRenderWindowInteractor ()

	~vtkCocoaRenderWindowInteractor () override

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

void *	GetTimerDictionary ()

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

int	InternalDestroyTimer (int platformTimerId) override

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

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

void *	GetCocoaManager ()

Protected Member Functions inherited from vtkRenderWindowInteractor
	vtkRenderWindowInteractor ()

	~vtkRenderWindowInteractor () override

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

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)

void	ReleaseFocus ()

int	GetCurrentTimerId ()

virtual void	RecognizeGesture (vtkCommand::EventIds)

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

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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 *)

static void *	ClassExitMethodArg

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkRenderWindowInteractor
vtkRenderWindow *	RenderWindow

vtkHardwareWindow *	HardwareWindow

vtkInteractorObserver *	InteractorStyle

vtkAbstractPicker *	Picker

vtkPickingManager *	PickingManager

bool	Done

int	Initialized

int	Enabled

bool	EnableRender

int	Style

vtkTypeBool	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
std::atomic< int32_t >	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

◆ Superclass

typedef vtkRenderWindowInteractor vtkCocoaRenderWindowInteractor::Superclass

Definition at line 51 of file vtkCocoaRenderWindowInteractor.h.

Constructor & Destructor Documentation

◆ vtkCocoaRenderWindowInteractor()

vtkCocoaRenderWindowInteractor::vtkCocoaRenderWindowInteractor ( )

protected

◆ ~vtkCocoaRenderWindowInteractor()

vtkCocoaRenderWindowInteractor::~vtkCocoaRenderWindowInteractor ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::New ( )

static

Construct object so that light follows camera motion.

◆ IsTypeOf()

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

static

◆ IsA()

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCocoaRenderWindowInteractor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

◆ NewInstance()

vtkCocoaRenderWindowInteractor* vtkCocoaRenderWindowInteractor::NewInstance ( ) const

◆ PrintSelf()

void vtkCocoaRenderWindowInteractor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

◆ Initialize()

void vtkCocoaRenderWindowInteractor::Initialize ( )

overridevirtual

Initialize the even handler.

Reimplemented from vtkRenderWindowInteractor.

◆ Enable()

void vtkCocoaRenderWindowInteractor::Enable ( )

overridevirtual

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.

◆ Disable()

void vtkCocoaRenderWindowInteractor::Disable ( )

overridevirtual

Reimplemented from vtkRenderWindowInteractor.

◆ TerminateApp()

void vtkCocoaRenderWindowInteractor::TerminateApp ( )

overridevirtual

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.

◆ ProcessEvents()

void vtkCocoaRenderWindowInteractor::ProcessEvents ( )

overridevirtual

Run the event loop and return.

This is provided so that you can implement your own event loop but yet use the vtk event handling as well.

Reimplemented from vtkRenderWindowInteractor.

◆ SetClassExitMethod()

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 (Cocoa, etc.).

◆ SetClassExitMethodArgDelete()

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

static

◆ ExitCallback()

void vtkCocoaRenderWindowInteractor::ExitCallback ( )

overridevirtual

These methods correspond to the Exit, User and Pick callbacks.

They allow for the Style to invoke them.

Reimplemented from vtkRenderWindowInteractor.

◆ SetTimerDictionary()

void vtkCocoaRenderWindowInteractor::SetTimerDictionary ( void * dictionary )

protected

Accessors for the Cocoa member variables.

These should be used at all time, even by this class.

◆ GetTimerDictionary()

void* vtkCocoaRenderWindowInteractor::GetTimerDictionary ( )

protected

◆ InternalCreateTimer()

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

overrideprotectedvirtual

Cocoa-specific internal timer methods.

See the superclass for detailed documentation.

Reimplemented from vtkRenderWindowInteractor.

◆ InternalDestroyTimer()

int vtkCocoaRenderWindowInteractor::InternalDestroyTimer ( int platformTimerId )

overrideprotectedvirtual

Reimplemented from vtkRenderWindowInteractor.

◆ StartEventLoop()

void vtkCocoaRenderWindowInteractor::StartEventLoop ( )

overrideprotectedvirtual

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.

◆ SetCocoaManager()

void vtkCocoaRenderWindowInteractor::SetCocoaManager ( void * manager )

protected

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

It manages all Cocoa objects in this C++ class.

◆ GetCocoaManager()

void* vtkCocoaRenderWindowInteractor::GetCocoaManager ( )

protected

Member Data Documentation

◆ ClassExitMethod

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.

java, Cocoa)

Definition at line 124 of file vtkCocoaRenderWindowInteractor.h.

◆ ClassExitMethodArgDelete

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

staticprotected

Definition at line 125 of file vtkCocoaRenderWindowInteractor.h.

◆ ClassExitMethodArg

void* vtkCocoaRenderWindowInteractor::ClassExitMethodArg

staticprotected

Definition at line 126 of file vtkCocoaRenderWindowInteractor.h.

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

Rendering/UI/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

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCocoaRenderWindowInteractor()

◆ ~vtkCocoaRenderWindowInteractor()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Initialize()

◆ Enable()

◆ Disable()

◆ TerminateApp()

◆ ProcessEvents()

◆ SetClassExitMethod()

◆ SetClassExitMethodArgDelete()

◆ ExitCallback()

◆ SetTimerDictionary()

◆ GetTimerDictionary()

◆ InternalCreateTimer()

◆ InternalDestroyTimer()

◆ StartEventLoop()

◆ SetCocoaManager()

◆ GetCocoaManager()

Member Data Documentation

◆ ClassExitMethod

◆ ClassExitMethodArgDelete

◆ ClassExitMethodArg