supports legacy function callbacks for VTK More...

#include <vtkOldStyleCallbackCommand.h>

Inheritance diagram for vtkOldStyleCallbackCommand:

Collaboration diagram for vtkOldStyleCallbackCommand:

Public Types
typedef vtkCommand	Superclass

Public Types inherited from vtkCommand
enum	EventIds { NoEvent = 0, AnyEvent, DeleteEvent, StartEvent, EndEvent, RenderEvent, ProgressEvent, PickEvent, StartPickEvent, EndPickEvent, AbortCheckEvent, ExitEvent, LeftButtonPressEvent, LeftButtonReleaseEvent, MiddleButtonPressEvent, MiddleButtonReleaseEvent, RightButtonPressEvent, RightButtonReleaseEvent, EnterEvent, LeaveEvent, KeyPressEvent, KeyReleaseEvent, CharEvent, ExposeEvent, ConfigureEvent, TimerEvent, MouseMoveEvent, MouseWheelForwardEvent, MouseWheelBackwardEvent, ActiveCameraEvent, CreateCameraEvent, ResetCameraEvent, ResetCameraClippingRangeEvent, ModifiedEvent, WindowLevelEvent, StartWindowLevelEvent, EndWindowLevelEvent, ResetWindowLevelEvent, SetOutputEvent, ErrorEvent, WarningEvent, StartInteractionEvent, InteractionEvent, EndInteractionEvent, EnableEvent, DisableEvent, CreateTimerEvent, DestroyTimerEvent, PlacePointEvent, DeletePointEvent, PlaceWidgetEvent, CursorChangedEvent, ExecuteInformationEvent, RenderWindowMessageEvent, WrongTagEvent, StartAnimationCueEvent, ResliceAxesChangedEvent, AnimationCueTickEvent, EndAnimationCueEvent, VolumeMapperRenderEndEvent, VolumeMapperRenderProgressEvent, VolumeMapperRenderStartEvent, VolumeMapperComputeGradientsEndEvent, VolumeMapperComputeGradientsProgressEvent, VolumeMapperComputeGradientsStartEvent, WidgetModifiedEvent, WidgetValueChangedEvent, WidgetActivateEvent, ConnectionCreatedEvent, ConnectionClosedEvent, DomainModifiedEvent, PropertyModifiedEvent, UpdateEvent, RegisterEvent, UnRegisterEvent, UpdateInformationEvent, AnnotationChangedEvent, SelectionChangedEvent, UpdatePropertyEvent, ViewProgressEvent, UpdateDataEvent, CurrentChangedEvent, ComputeVisiblePropBoundsEvent, TDxMotionEvent, TDxButtonPressEvent, TDxButtonReleaseEvent, HoverEvent, LoadStateEvent, SaveStateEvent, StateChangedEvent, WindowMakeCurrentEvent, WindowIsCurrentEvent, WindowFrameEvent, HighlightEvent, WindowSupportsOpenGLEvent, WindowIsDirectEvent, WindowStereoTypeChangedEvent, WindowResizeEvent, UncheckedPropertyModifiedEvent, UpdateShaderEvent, MessageEvent, StartPinchEvent, PinchEvent, EndPinchEvent, StartRotateEvent, RotateEvent, EndRotateEvent, StartPanEvent, PanEvent, EndPanEvent, TapEvent, LongTapEvent, SwipeEvent, FourthButtonPressEvent, FourthButtonReleaseEvent, FifthButtonPressEvent, FifthButtonReleaseEvent, Move3DEvent, Button3DEvent, TextEvent, UserEvent = 1000 }

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

vtkOldStyleCallbackCommand *	NewInstance () const

void	Execute (vtkObject invoker, unsigned long eid, void calldata) override
	Satisfy the superclass API for callbacks. More...


void	SetClientData (void *cd)
	Methods to set and get client and callback information. More...

void	SetCallback (void(f)(void clientdata))
	Methods to set and get client and callback information. More...

void	SetClientDataDeleteCallback (void(f)(void ))
	Methods to set and get client and callback information. More...

Public Member Functions inherited from vtkCommand
	vtkBaseTypeMacro (vtkCommand, vtkObjectBase)

void	UnRegister ()
	Decrease the reference count (release by another object). More...

void	UnRegister (vtkObjectBase *) override
	Decrease the reference count (release by another object). More...

void	SetAbortFlag (int f)
	Set/Get the abort flag. More...

int	GetAbortFlag ()

void	AbortFlagOn ()

void	AbortFlagOff ()

void	SetPassiveObserver (int f)
	Set/Get the passive observer flag. More...

int	GetPassiveObserver ()

void	PassiveObserverOn ()

void	PassiveObserverOff ()

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	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...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkOldStyleCallbackCommand *	SafeDownCast (vtkObjectBase *o)

static vtkOldStyleCallbackCommand *	New ()

Static Public Member Functions inherited from vtkCommand
static bool	EventHasData (unsigned long event)
	Does this event type contain vtkEventData. More...

static const char *	GetStringFromEventId (unsigned long event)
	Convenience methods for translating between event names and event ids. More...

static unsigned long	GetEventIdFromString (const char *event)
	Convenience methods for translating between event names and event ids. More...

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Public Attributes
void *	ClientData

void(*	Callback )(void *)

void(*	ClientDataDeleteCallback )(void *)

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOldStyleCallbackCommand ()

	~vtkOldStyleCallbackCommand () override

Protected Member Functions inherited from vtkCommand
	vtkCommand ()

	~vtkCommand () override

	vtkCommand (const vtkCommand &c)

void	operator= (const vtkCommand &)

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkCommand
int	AbortFlag

int	PassiveObserver

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

supports legacy function callbacks for VTK

vtkOldStyleCallbackCommand is a callback that supports the legacy callback methods found in VTK. For example, the legacy method vtkProcessObject::SetStartMethod() is actually invoked using the command/observer design pattern of VTK, and the vtkOldStyleCallbackCommand is used to provide the legacy functionality. The callback function should have the form void func(void *clientdata), where clientdata is special data that should is associated with this instance of vtkCallbackCommand.