VTK
|
supports function callbacks More...
#include <vtkCallbackCommand.h>
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
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 () |
![]() | |
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 () |
![]() | |
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 &os) |
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 (vtkObject *o) |
static vtkCallbackCommand * | New () |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkCommand * | SafeDownCast (vtkObject *o) |
static const char * | GetStringFromEventId (unsigned long event) |
static unsigned long | GetEventIdFromString (const char *event) |
![]() | |
static int | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
Public Attributes | |
void(* | Callback )(vtkObject *, unsigned long, void *, void *) |
void(* | ClientDataDeleteCallback )(void *) |
Protected Member Functions | |
vtkCallbackCommand () | |
~vtkCallbackCommand () | |
![]() | |
vtkCommand () | |
virtual | ~vtkCommand () |
vtkCommand (const vtkCommand &c) | |
void | operator= (const vtkCommand &) |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &os) |
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 |
![]() | |
int | AbortFlag |
int | PassiveObserver |
![]() | |
int | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 48 of file vtkCallbackCommand.h.
Definition at line 51 of file vtkCallbackCommand.h.
|
protected |
|
protected |
|
virtual |
Reimplemented from vtkCommand.
|
static |
|
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 |
|
inlinestatic |
Definition at line 53 of file vtkCallbackCommand.h.
|
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.
|
inlinevirtual |
Methods to set and get client and callback information, and the callback function.
Definition at line 65 of file vtkCallbackCommand.h.
|
inlinevirtual |
Methods to set and get client and callback information, and the callback function.
Definition at line 67 of file vtkCallbackCommand.h.
|
inlinevirtual |
Methods to set and get client and callback information, and the callback function.
Definition at line 69 of file vtkCallbackCommand.h.
|
inlinevirtual |
Methods to set and get client and callback information, and the callback function.
Definition at line 72 of file vtkCallbackCommand.h.
|
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 80 of file vtkCallbackCommand.h.
|
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 82 of file vtkCallbackCommand.h.
|
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 84 of file vtkCallbackCommand.h.
|
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 86 of file vtkCallbackCommand.h.
void(* vtkCallbackCommand::Callback)(vtkObject *, unsigned long, void *, void *) |
Definition at line 90 of file vtkCallbackCommand.h.
void(* vtkCallbackCommand::ClientDataDeleteCallback)(void *) |
Definition at line 91 of file vtkCallbackCommand.h.
|
protected |
Definition at line 95 of file vtkCallbackCommand.h.
|
protected |
Definition at line 96 of file vtkCallbackCommand.h.