vtkCallbackCommand Class Reference

#include <vtkCallbackCommand.h>

Inheritance diagram for vtkCallbackCommand:

[legend]

Collaboration diagram for vtkCallbackCommand:

[legend]

List of all members.

Detailed Description

supports function callbacks

Use vtkCallbackCommand for generic function callbacks. That is, this class can be used when you wish to execute a function (of the signature described below) using the Command/Observer design pattern in VTK. The callback function should have the form

 void func(vtkObject*, unsigned long eid, void* clientdata, void *calldata)

where the parameter vtkObject* is the object invoking the event; eid is the event id (see vtkCommand.h); clientdata is special data that should is associated with this instance of vtkCallbackCommand; and calldata is data that the vtkObject::InvokeEvent() may send with the callback. For example, the invocation of the ProgressEvent sends along the progress value as calldata.

See also:: vtkCommand vtkOldStyleCallbackCommand

Tests:: vtkCallbackCommand (Tests)

Definition at line 45 of file vtkCallbackCommand.h.


Public Member Functions
virtual void	Execute (vtkObject caller, unsigned long eid, void callData)

virtual void	SetClientData (void *cd)
virtual void *	GetClientData ()
virtual void	SetCallback (void(f)(vtkObject caller, unsigned long eid, void clientdata, void calldata))
virtual void	SetClientDataDeleteCallback (void(f)(void ))

void	SetAbortFlagOnExecute (int f)
int	GetAbortFlagOnExecute ()
void	AbortFlagOnExecuteOn ()
void	AbortFlagOnExecuteOff ()
Static Public Member Functions
static vtkCallbackCommand *	New ()
Public Attributes
void(*	Callback )(vtkObject , unsigned long, void , void *)
void(*	ClientDataDeleteCallback )(void *)
Protected Member Functions
	vtkCallbackCommand ()
	~vtkCallbackCommand ()
Protected Attributes
int	AbortFlagOnExecute
void *	ClientData

Constructor & Destructor Documentation

vtkCallbackCommand::vtkCallbackCommand ( ) [protected]

vtkCallbackCommand::~vtkCallbackCommand ( ) [protected]

Member Function Documentation

static vtkCallbackCommand* vtkCallbackCommand::New ( ) [inline, static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObjectBase.

Definition at line 48 of file vtkCallbackCommand.h.

virtual void vtkCallbackCommand::Execute	(	vtkObject *	caller,
		unsigned long	eid,
		void *	callData
	)			`[virtual]`

Satisfy the superclass API for callbacks. Recall that the caller is the instance invoking the event; eid is the event id (see vtkCommand.h); and calldata is information sent when the callback was invoked (e.g., progress value in the vtkCommand::ProgressEvent).

Implements vtkCommand.

virtual void vtkCallbackCommand::SetClientData ( void * cd ) [inline, virtual]

Methods to set and get client and callback information, and the callback function.

Definition at line 60 of file vtkCallbackCommand.h.

virtual void* vtkCallbackCommand::GetClientData ( ) [inline, virtual]

Methods to set and get client and callback information, and the callback function.

Definition at line 62 of file vtkCallbackCommand.h.

virtual void vtkCallbackCommand::SetCallback ( void(*)(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata) f ) [inline, virtual]

Methods to set and get client and callback information, and the callback function.

Definition at line 64 of file vtkCallbackCommand.h.

virtual void vtkCallbackCommand::SetClientDataDeleteCallback ( void(*)(void *) f ) [inline, virtual]

Methods to set and get client and callback information, and the callback function.

Definition at line 67 of file vtkCallbackCommand.h.

void vtkCallbackCommand::SetAbortFlagOnExecute ( int f ) [inline]

Set/Get the abort flag on execute. If this is set to true the AbortFlag will be set to On automatically when the Execute method is triggered *and* a callback is set.

Definition at line 75 of file vtkCallbackCommand.h.

int vtkCallbackCommand::GetAbortFlagOnExecute ( ) [inline]

Set/Get the abort flag on execute. If this is set to true the AbortFlag will be set to On automatically when the Execute method is triggered *and* a callback is set.

Definition at line 77 of file vtkCallbackCommand.h.

void vtkCallbackCommand::AbortFlagOnExecuteOn ( ) [inline]

Set/Get the abort flag on execute. If this is set to true the AbortFlag will be set to On automatically when the Execute method is triggered *and* a callback is set.

Definition at line 79 of file vtkCallbackCommand.h.

void vtkCallbackCommand::AbortFlagOnExecuteOff ( ) [inline]

Set/Get the abort flag on execute. If this is set to true the AbortFlag will be set to On automatically when the Execute method is triggered *and* a callback is set.

Definition at line 81 of file vtkCallbackCommand.h.