supports function callbacks More...

#include <vtkCallbackCommand.h>

Inheritance diagram for vtkCallbackCommand:

Collaboration diagram for vtkCallbackCommand:

Public Types
typedef vtkCommand	Superclass

Public Types inherited from vtkCommand
typedef vtkObjectBase	Superclass

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

vtkCallbackCommand *	NewInstance () const

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

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

void	UnRegister ()

virtual void	UnRegister (vtkObjectBase *)

void	SetAbortFlag (int f)

int	GetAbortFlag ()

void	AbortFlagOn ()

void	AbortFlagOff ()

void	SetPassiveObserver (int f)

int	GetPassiveObserver ()

void	PassiveObserverOn ()

void	PassiveObserverOff ()

	vtkCommand ()

virtual	~vtkCommand ()

	vtkCommand (const vtkCommand &c)

void	operator= (const vtkCommand &)

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	PrintSelf (ostream &os, vtkIndent indent)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkCallbackCommand *	SafeDownCast (vtkObjectBase *o)

static vtkCallbackCommand *	New ()

Static Public Member Functions inherited from vtkCommand
static int	IsTypeOf (const char *type)

static vtkCommand *	SafeDownCast (vtkObjectBase *o)

static const char *	GetStringFromEventId (unsigned long event)

static unsigned long	GetEventIdFromString (const char *event)

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

static vtkObjectBase *	New ()

Public Attributes
void(*	Callback )(vtkObject , unsigned long, void , void *)

void(*	ClientDataDeleteCallback )(void *)

Public Attributes inherited from vtkCommand
vtkEventDeclarationMacro(EventIds) protected int	PassiveObserver

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCallbackCommand ()

	~vtkCallbackCommand ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	AbortFlagOnExecute

void *	ClientData

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Examples:: vtkCallbackCommand (Examples)

Tests:: vtkCallbackCommand (Tests)

Definition at line 49 of file vtkCallbackCommand.h.

Member Typedef Documentation

typedef vtkCommand vtkCallbackCommand::Superclass

Definition at line 52 of file vtkCallbackCommand.h.

Constructor & Destructor Documentation

vtkCallbackCommand::vtkCallbackCommand ( )

protected

vtkCallbackCommand::~vtkCallbackCommand ( )

protected

Member Function Documentation

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

static

virtual int vtkCallbackCommand::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 vtkCommand.

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

static

virtual vtkObjectBase* vtkCallbackCommand::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCommand.

vtkCallbackCommand* vtkCallbackCommand::NewInstance ( ) const

static vtkCallbackCommand* vtkCallbackCommand::New ( )

inlinestatic

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

inlinevirtual

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

Definition at line 66 of file vtkCallbackCommand.h.

virtual void* vtkCallbackCommand::GetClientData ( )

inlinevirtual

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

Definition at line 68 of file vtkCallbackCommand.h.

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

inlinevirtual

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

Definition at line 70 of file vtkCallbackCommand.h.

virtual void vtkCallbackCommand::SetClientDataDeleteCallback ( void(*)(void *) f )

inlinevirtual

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

Definition at line 73 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 81 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 83 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 85 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 87 of file vtkCallbackCommand.h.

Member Data Documentation

void(* vtkCallbackCommand::Callback) (vtkObject *, unsigned long, void *, void *)

Definition at line 91 of file vtkCallbackCommand.h.

void(* vtkCallbackCommand::ClientDataDeleteCallback) (void *)

Definition at line 92 of file vtkCallbackCommand.h.

int vtkCallbackCommand::AbortFlagOnExecute

protected

Definition at line 96 of file vtkCallbackCommand.h.

void* vtkCallbackCommand::ClientData

protected

Definition at line 97 of file vtkCallbackCommand.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkCallbackCommand.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation