VTK  9.0.20201128
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
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, 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...
vtkOldStyleCallbackCommandNewInstance () 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))
void SetClientDataDeleteCallback (void(*f)(void *))
- 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 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). 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 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)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
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...
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
static vtkOldStyleCallbackCommandSafeDownCast (vtkObjectBase *o)
static vtkOldStyleCallbackCommandNew ()
- Static Public Member Functions inherited from vtkCommand
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)
static bool EventHasData (unsigned long event)
 Does this event type contain vtkEventData. 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 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). More...
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
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. More...

Public Attributes

void * ClientData
void(* Callback )(void *)
void(* ClientDataDeleteCallback )(void *)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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.

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

Definition at line 44 of file vtkOldStyleCallbackCommand.h.

Constructor & Destructor Documentation

◆ vtkOldStyleCallbackCommand()

vtkOldStyleCallbackCommand::vtkOldStyleCallbackCommand ( )

◆ ~vtkOldStyleCallbackCommand()

vtkOldStyleCallbackCommand::~vtkOldStyleCallbackCommand ( )

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkOldStyleCallbackCommand::IsA ( const char *  name)

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)

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOldStyleCallbackCommand::NewInstanceInternal ( ) const

◆ NewInstance()

vtkOldStyleCallbackCommand* vtkOldStyleCallbackCommand::NewInstance ( ) const

◆ New()

static vtkOldStyleCallbackCommand* vtkOldStyleCallbackCommand::New ( )

Definition at line 46 of file vtkOldStyleCallbackCommand.h.

◆ Execute()

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

Satisfy the superclass API for callbacks.

Implements vtkCommand.

◆ SetClientData()

void vtkOldStyleCallbackCommand::SetClientData ( void *  cd)

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)

Definition at line 58 of file vtkOldStyleCallbackCommand.h.

◆ SetClientDataDeleteCallback()

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

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: