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

#include <vtkCarbonRenderWindowInteractor.h>

Inheritance diagram for vtkCarbonRenderWindowInteractor:

Collaboration diagram for vtkCarbonRenderWindowInteractor:

Public Types
typedef vtkRenderWindowInteractor	Superclass

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

typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkCarbonRenderWindowInteractor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Initialize ()

void	TerminateApp (void)

virtual void	ExitCallback ()


virtual void	Enable ()

virtual void	Disable ()


void	GetLastMouseDelta (int delta[2])

void	SetLastMouseDelta (int deltaX, int deltaY)


void	SetMouseInsideWindow (int val)

int	GetMouseInsideWindow ()


void	SetMouseButtonDown (int val)

int	GetMouseButtonDown ()

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

virtual void	UnRegister (vtkObjectBase *o)

virtual void	Start ()

virtual void	UpdateSize (int x, int y)

int	CreateRepeatingTimer (unsigned long duration)

int	CreateOneShotTimer (unsigned long duration)

int	IsOneShotTimer (int timerId)

unsigned long	GetTimerDuration (int timerId)

int	ResetTimer (int timerId)

int	DestroyTimer (int timerId)

virtual int	GetVTKTimerId (int platformTimerId)

virtual vtkAbstractPropPicker *	CreateDefaultPicker ()

virtual void	GetMousePosition (int x, int y)

virtual void	Render ()

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)

vtkObserverMediator *	GetObserverMediator ()

void	ReInitialize ()

virtual int	GetEnabled ()

virtual void	EnableRenderOn ()

virtual void	EnableRenderOff ()

virtual void	SetEnableRender (bool)

virtual bool	GetEnableRender ()

void	SetRenderWindow (vtkRenderWindow *aren)

virtual vtkRenderWindow *	GetRenderWindow ()

virtual int	CreateTimer (int timerType)

virtual int	DestroyTimer ()

virtual void	SetTimerDuration (unsigned long)

virtual unsigned long	GetTimerDuration ()

virtual void	SetTimerEventId (int)

virtual int	GetTimerEventId ()

virtual void	SetTimerEventType (int)

virtual int	GetTimerEventType ()

virtual void	SetTimerEventDuration (int)

virtual int	GetTimerEventDuration ()

virtual void	SetTimerEventPlatformId (int)

virtual int	GetTimerEventPlatformId ()

virtual void	SetInteractorStyle (vtkInteractorObserver *)

virtual vtkInteractorObserver *	GetInteractorStyle ()

virtual void	SetLightFollowCamera (int)

virtual int	GetLightFollowCamera ()

virtual void	LightFollowCameraOn ()

virtual void	LightFollowCameraOff ()

virtual void	SetDesiredUpdateRate (double)

virtual double	GetDesiredUpdateRate ()

virtual void	SetStillUpdateRate (double)

virtual double	GetStillUpdateRate ()

virtual int	GetInitialized ()

virtual void	SetPicker (vtkAbstractPicker *)

virtual vtkAbstractPicker *	GetPicker ()

virtual void	SetPickingManager (vtkPickingManager *)

virtual vtkPickingManager *	GetPickingManager ()

virtual void	UserCallback ()

virtual void	StartPickCallback ()

virtual void	EndPickCallback ()

void	HideCursor ()

void	ShowCursor ()

void	FlyTo (vtkRenderer *ren, double x, double y, double z)

void	FlyTo (vtkRenderer ren, double x)

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

void	FlyToImage (vtkRenderer ren, double x)

virtual void	SetNumberOfFlyFrames (int)

virtual int	GetNumberOfFlyFrames ()

virtual void	SetDolly (double)

virtual double	GetDolly ()

virtual int *	GetEventPosition ()

virtual void	GetEventPosition (int &, int &)

virtual void	GetEventPosition (int[2])

virtual int *	GetLastEventPosition ()

virtual void	GetLastEventPosition (int &, int &)

virtual void	GetLastEventPosition (int[2])

virtual void	SetLastEventPosition (int, int)

void	SetLastEventPosition (int[2])

virtual void	SetEventPosition (int x, int y)

virtual void	SetEventPosition (int pos[2])

virtual void	SetEventPositionFlipY (int x, int y)

virtual void	SetEventPositionFlipY (int pos[2])

virtual void	SetAltKey (int)

virtual int	GetAltKey ()

virtual void	SetControlKey (int)

virtual int	GetControlKey ()

virtual void	SetShiftKey (int)

virtual int	GetShiftKey ()

virtual void	SetKeyCode (char)

virtual char	GetKeyCode ()

virtual void	SetRepeatCount (int)

virtual int	GetRepeatCount ()

virtual void	SetKeySym (const char *)

virtual char *	GetKeySym ()

virtual void	SetPointerIndex (int)

virtual int	GetPointerIndex ()

void	SetEventInformation (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)

void	SetEventInformation (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)

void	SetEventInformationFlipY (int x, int y, int ctrl, int shift, char keycode, int repeatcount, const char *keysym, int pointerIndex)

void	SetEventInformationFlipY (int x, int y, int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)

void	SetKeyEventInformation (int ctrl=0, int shift=0, char keycode=0, int repeatcount=0, const char *keysym=0)

virtual void	SetSize (int, int)

void	SetSize (int[2])

virtual int *	GetSize ()

virtual void	GetSize (int &, int &)

virtual void	GetSize (int[2])

virtual void	SetEventSize (int, int)

void	SetEventSize (int[2])

virtual int *	GetEventSize ()

virtual void	GetEventSize (int &, int &)

virtual void	GetEventSize (int[2])

virtual void	SetUseTDx (bool)

virtual bool	GetUseTDx ()

virtual void	MouseMoveEvent ()

virtual void	RightButtonPressEvent ()

virtual void	RightButtonReleaseEvent ()

virtual void	LeftButtonPressEvent ()

virtual void	LeftButtonReleaseEvent ()

virtual void	MiddleButtonPressEvent ()

virtual void	MiddleButtonReleaseEvent ()

virtual void	MouseWheelForwardEvent ()

virtual void	MouseWheelBackwardEvent ()

virtual void	ExposeEvent ()

virtual void	ConfigureEvent ()

virtual void	EnterEvent ()

virtual void	LeaveEvent ()

virtual void	KeyPressEvent ()

virtual void	KeyReleaseEvent ()

virtual void	CharEvent ()

virtual void	ExitEvent ()

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkCarbonRenderWindowInteractor *	New ()

static int	IsTypeOf (const char *type)

static vtkCarbonRenderWindowInteractor *	SafeDownCast (vtkObjectBase *o)


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

static void	SetClassExitMethodArgDelete (void(f)(void ))

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 int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCarbonRenderWindowInteractor ()

	~vtkCarbonRenderWindowInteractor ()

virtual void	StartEventLoop ()


virtual int	InternalCreateTimer (int timerId, int timerType, unsigned long duration)

virtual int	InternalDestroyTimer (int platformTimerId)

Protected Member Functions inherited from vtkRenderWindowInteractor
	vtkRenderWindowInteractor ()

	~vtkRenderWindowInteractor ()

virtual vtkPickingManager *	CreateDefaultPickingManager ()

int	GetCurrentTimerId ()

void	GrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	ReleaseFocus ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
EventHandlerUPP	ViewProcUPP

EventHandlerUPP	WindowProcUPP

int	LastMouseDelta [2]

int	LeaveCheckId

int	MouseInsideWindow

int	MouseButtonDown

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

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

int	NumberOfFlyFrames

double	Dolly

vtkObserverMediator *	ObserverMediator

vtkTimerIdMap *	TimerMap

unsigned long	TimerDuration

int	HandleEventLoop

bool	UseTDx

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Static Protected Attributes

static void(*	ClassExitMethod )(void *)

static void(*	ClassExitMethodArgDelete )(void *)

static void *	ClassExitMethodArg

Detailed Description

implements Carbon specific functions required by vtkRenderWindowInteractor.

The interactor interfaces with vtkCarbonWindow to trap messages from the Carbon 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.

Events:: vtkCommand::ConfigureEvent vtkCommand::CharEvent vtkCommand::RightButtonReleaseEvent vtkCommand::LeftButtonReleaseEvent vtkCommand::ExitEvent vtkCommand::LeaveEvent vtkCommand::MouseWheelBackwardEvent vtkCommand::MiddleButtonPressEvent vtkCommand::MouseMoveEvent vtkCommand::MiddleButtonReleaseEvent vtkCommand::KeyReleaseEvent vtkCommand::MouseWheelForwardEvent vtkCommand::KeyPressEvent vtkCommand::LeftButtonPressEvent vtkCommand::EnterEvent vtkCommand::TimerEvent vtkCommand::RightButtonPressEvent

Definition at line 44 of file vtkCarbonRenderWindowInteractor.h.

Member Typedef Documentation

typedef vtkRenderWindowInteractor vtkCarbonRenderWindowInteractor::Superclass

Definition at line 50 of file vtkCarbonRenderWindowInteractor.h.

Constructor & Destructor Documentation

vtkCarbonRenderWindowInteractor::vtkCarbonRenderWindowInteractor ( )

protected

vtkCarbonRenderWindowInteractor::~vtkCarbonRenderWindowInteractor ( )

protected

Member Function Documentation

static vtkCarbonRenderWindowInteractor* vtkCarbonRenderWindowInteractor::New ( )

static

Construct object so that light follows camera motion.

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

static

virtual int vtkCarbonRenderWindowInteractor::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 vtkCarbonRenderWindowInteractor* vtkCarbonRenderWindowInteractor::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkCarbonRenderWindowInteractor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderWindowInteractor.

vtkCarbonRenderWindowInteractor* vtkCarbonRenderWindowInteractor::NewInstance ( ) const

void vtkCarbonRenderWindowInteractor::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 vtkCarbonRenderWindowInteractor::Initialize ( )

virtual

Initialize the even handler

Reimplemented from vtkRenderWindowInteractor.

virtual void vtkCarbonRenderWindowInteractor::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 vtkCarbonRenderWindowInteractor::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 vtkCarbonRenderWindowInteractor::TerminateApp ( void )

virtual

Carbon 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 vtkCarbonRenderWindowInteractor::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, Carbon, etc.).

static void vtkCarbonRenderWindowInteractor::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, Carbon, etc.).

virtual void vtkCarbonRenderWindowInteractor::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 vtkCarbonRenderWindowInteractor::GetLastMouseDelta ( int delta[2] )

inline

This method is for internal use only. Track the Carbon mouse deltas Carbon events that don't provide mouse position directly.

Definition at line 90 of file vtkCarbonRenderWindowInteractor.h.

void vtkCarbonRenderWindowInteractor::SetLastMouseDelta	(	int	deltaX,
		int	deltaY
	)

inline

This method is for internal use only. Track the Carbon mouse deltas Carbon events that don't provide mouse position directly.

Definition at line 92 of file vtkCarbonRenderWindowInteractor.h.

void vtkCarbonRenderWindowInteractor::SetMouseInsideWindow ( int val )

inline

This method is for internal use only. This is a state variable used for Enter/Leave events. If the mouse is dragged outside of the window, MouseInsideWindow will remain set until the mouse button is released outside of the window.

Definition at line 101 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::GetMouseInsideWindow ( )

inline

This method is for internal use only. This is a state variable used for Enter/Leave events. If the mouse is dragged outside of the window, MouseInsideWindow will remain set until the mouse button is released outside of the window.

Definition at line 103 of file vtkCarbonRenderWindowInteractor.h.

void vtkCarbonRenderWindowInteractor::SetMouseButtonDown ( int val )

inline

This method is for internal use only. This is a state variable used for Enter/Leave events. It keeps track of whether a mouse button is down.

Definition at line 111 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::GetMouseButtonDown ( )

inline

This method is for internal use only. This is a state variable used for Enter/Leave events. It keeps track of whether a mouse button is down.

Definition at line 113 of file vtkCarbonRenderWindowInteractor.h.

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

protectedvirtual

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

Reimplemented from vtkRenderWindowInteractor.

virtual int vtkCarbonRenderWindowInteractor::InternalDestroyTimer ( int platformTimerId )

protectedvirtual

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

Reimplemented from vtkRenderWindowInteractor.

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

Member Data Documentation

EventHandlerUPP vtkCarbonRenderWindowInteractor::ViewProcUPP

protected

Definition at line 121 of file vtkCarbonRenderWindowInteractor.h.

EventHandlerUPP vtkCarbonRenderWindowInteractor::WindowProcUPP

protected

Definition at line 122 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::LastMouseDelta[2]

protected

Definition at line 125 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::LeaveCheckId

protected

Definition at line 126 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::MouseInsideWindow

protected

Definition at line 127 of file vtkCarbonRenderWindowInteractor.h.

int vtkCarbonRenderWindowInteractor::MouseButtonDown

protected

Definition at line 128 of file vtkCarbonRenderWindowInteractor.h.

void(* vtkCarbonRenderWindowInteractor::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, Carbon)

Definition at line 135 of file vtkCarbonRenderWindowInteractor.h.

void(* vtkCarbonRenderWindowInteractor::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, Carbon)

Definition at line 136 of file vtkCarbonRenderWindowInteractor.h.

void* vtkCarbonRenderWindowInteractor::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, Carbon)

Definition at line 137 of file vtkCarbonRenderWindowInteractor.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkCarbonRenderWindowInteractor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation