vtkOldStyleCallbackCommand Class Reference

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 , DropFilesEvent , UpdateDropLocationEvent ,   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 , StartSwipeEvent ,   SwipeEvent , EndSwipeEvent , StartPinchEvent , PinchEvent ,   EndPinchEvent , StartRotateEvent , RotateEvent , EndRotateEvent ,   StartPanEvent , PanEvent , EndPanEvent , TapEvent ,   LongTapEvent , FourthButtonPressEvent , FourthButtonReleaseEvent , FifthButtonPressEvent ,   FifthButtonReleaseEvent , Move3DEvent , Button3DEvent , TextEvent ,   LeftButtonDoubleClickEvent , MiddleButtonDoubleClickEvent , RightButtonDoubleClickEvent , MouseWheelLeftEvent ,   MouseWheelRightEvent , ViewerMovement3DEvent , Menu3DEvent , NextPose3DEvent ,   Clip3DEvent , PositionProp3DEvent , Pick3DEvent , Select3DEvent ,   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.
vtkOldStyleCallbackCommand *	NewInstance () const
void	Execute (vtkObject *invoker, unsigned long eid, void *calldata) override
	Satisfy the superclass API for callbacks.
void	SetClientData (void *cd)
	Methods to set and get client and callback information.
void	SetCallback (void(*f)(void *clientdata))
	Methods to set and get client and callback information.
void	SetClientDataDeleteCallback (void(*f)(void *))
	Methods to set and get client and callback information.
Public Member Functions inherited from vtkCommand
	vtkBaseTypeMacro (vtkCommand, vtkObjectBase)
void	UnRegister ()
	Decrease the reference count (release by another object).
void	UnRegister (vtkObjectBase *) override
	Decrease the reference count (release by another object).
virtual void	Execute (vtkObject *caller, unsigned long eventId, void *callData)=0
	All derived classes of vtkCommand must implement this method.
void	SetAbortFlag (int f)
	Set/Get the abort flag.
int	GetAbortFlag ()
void	AbortFlagOn ()
void	AbortFlagOff ()
void	SetPassiveObserver (int f)
	Set/Get the passive observer flag.
int	GetPassiveObserver ()
void	PassiveObserverOn ()
void	PassiveObserverOff ()
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

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.
static const char *	GetStringFromEventId (unsigned long event)
	Convenience methods for translating between event names and event ids.
static unsigned long	GetEventIdFromString (const char *event)
	Convenience methods for translating between event names and event ids.
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.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

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=default
	vtkCommand (const vtkCommand &c)
void	operator= (const vtkCommand &)
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
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
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()
Protected Attributes inherited from vtkCommand
int	AbortFlag
int	PassiveObserver
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	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.

Warning

This is legacy glue. Please do not use; it will be eventually eliminated.

See also

vtkCommand vtkCallbackCommand

Definition at line 41 of file vtkOldStyleCallbackCommand.h.

Member Typedef Documentation

Superclass

typedef vtkCommand vtkOldStyleCallbackCommand::Superclass

Definition at line 44 of file vtkOldStyleCallbackCommand.h.

Constructor & Destructor Documentation

vtkOldStyleCallbackCommand()

vtkOldStyleCallbackCommand::vtkOldStyleCallbackCommand ( )

protected

~vtkOldStyleCallbackCommand()

vtkOldStyleCallbackCommand::~vtkOldStyleCallbackCommand ( )

overrideprotected

Member Function Documentation

IsTypeOf()

static vtkTypeBool vtkOldStyleCallbackCommand::IsTypeOf ( const char *  type )

static

IsA()

virtual vtkTypeBool vtkOldStyleCallbackCommand::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 vtkObjectBase.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkOldStyleCallbackCommand::NewInstanceInternal ( ) const

protectedvirtual

NewInstance()

vtkOldStyleCallbackCommand * vtkOldStyleCallbackCommand::NewInstance

(

)

const

New()

static vtkOldStyleCallbackCommand * vtkOldStyleCallbackCommand::New ( )

inlinestatic

Definition at line 46 of file vtkOldStyleCallbackCommand.h.

Execute()

void vtkOldStyleCallbackCommand::Execute ( vtkObject *  invoker, unsigned long  eid, void *  calldata  )

overridevirtual

Satisfy the superclass API for callbacks.

Implements vtkCommand.

SetClientData()

void vtkOldStyleCallbackCommand::SetClientData ( void *  cd )

inline

Methods to set and get client and callback information.

Definition at line 57 of file vtkOldStyleCallbackCommand.h.

SetCallback()

void vtkOldStyleCallbackCommand::SetCallback ( void(*)(void *clientdata)  f )

inline

Methods to set and get client and callback information.

Definition at line 58 of file vtkOldStyleCallbackCommand.h.

SetClientDataDeleteCallback()

void vtkOldStyleCallbackCommand::SetClientDataDeleteCallback ( void(*)(void *)  f )

inline

Methods to set and get client and callback information.

Definition at line 59 of file vtkOldStyleCallbackCommand.h.

Member Data Documentation

ClientData

void* vtkOldStyleCallbackCommand::ClientData

Definition at line 62 of file vtkOldStyleCallbackCommand.h.

Callback

void(* vtkOldStyleCallbackCommand::Callback) (void *)

Definition at line 63 of file vtkOldStyleCallbackCommand.h.

ClientDataDeleteCallback

void(* vtkOldStyleCallbackCommand::ClientDataDeleteCallback) (void *)

Definition at line 64 of file vtkOldStyleCallbackCommand.h.

---

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

• Common/Core/vtkOldStyleCallbackCommand.h