VTK
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:
[legend]
Collaboration diagram for vtkOldStyleCallbackCommand:
[legend]

Public Types

typedef vtkCommand Superclass
 
- Public Types inherited from vtkCommand
typedef vtkObjectBase Superclass
 
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, PlaceWidgetEvent, CursorChangedEvent, ExecuteInformationEvent,
  RenderWindowMessageEvent, WrongTagEvent, StartAnimationCueEvent, 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, UserEvent = 1000
}
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void Execute (vtkObject *invoker, unsigned long eid, void *calldata)
 
void SetClientData (void *cd)
 
void SetCallback (void(*f)(void *clientdata))
 
void SetClientDataDeleteCallback (void(*f)(void *))
 
- Public Member Functions inherited from vtkCommand
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 ()
 
- 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 &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 vtkOldStyleCallbackCommandSafeDownCast (vtkObject *o)
 
static vtkOldStyleCallbackCommandNew ()
 
- Static Public Member Functions inherited from vtkCommand
static int IsTypeOf (const char *type)
 
static vtkCommandSafeDownCast (vtkObject *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 vtkObjectBaseNew ()
 

Public Attributes

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

Protected Member Functions

 vtkOldStyleCallbackCommand ()
 
 ~vtkOldStyleCallbackCommand ()
 
- Protected Member Functions inherited from vtkCommand
 vtkCommand ()
 
virtual ~vtkCommand ()
 
 vtkCommand (const vtkCommand &c)
 
void operator= (const vtkCommand &)
 
- Protected Member Functions inherited from vtkObjectBase
 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 &)
 

Additional Inherited Members

- Protected Attributes inherited from vtkCommand
int AbortFlag
 
int PassiveObserver
 
- Protected Attributes inherited from vtkObjectBase
int 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 39 of file vtkOldStyleCallbackCommand.h.

Member Typedef Documentation

Definition at line 42 of file vtkOldStyleCallbackCommand.h.

Constructor & Destructor Documentation

vtkOldStyleCallbackCommand::vtkOldStyleCallbackCommand ( )
protected
vtkOldStyleCallbackCommand::~vtkOldStyleCallbackCommand ( )
protected

Member Function Documentation

virtual const char* vtkOldStyleCallbackCommand::GetClassName ( )
virtual

Reimplemented from vtkCommand.

static int vtkOldStyleCallbackCommand::IsTypeOf ( const char *  type)
static
virtual int 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 vtkCommand.

static vtkOldStyleCallbackCommand* vtkOldStyleCallbackCommand::SafeDownCast ( vtkObject o)
static
static vtkOldStyleCallbackCommand* vtkOldStyleCallbackCommand::New ( )
inlinestatic

Definition at line 44 of file vtkOldStyleCallbackCommand.h.

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

Satisfy the superclass API for callbacks.

Implements vtkCommand.

void vtkOldStyleCallbackCommand::SetClientData ( void *  cd)
inline

Methods to set and get client and callback information.

Definition at line 52 of file vtkOldStyleCallbackCommand.h.

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

Methods to set and get client and callback information.

Definition at line 54 of file vtkOldStyleCallbackCommand.h.

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

Methods to set and get client and callback information.

Definition at line 56 of file vtkOldStyleCallbackCommand.h.

Member Data Documentation

void* vtkOldStyleCallbackCommand::ClientData

Definition at line 57 of file vtkOldStyleCallbackCommand.h.

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

Definition at line 61 of file vtkOldStyleCallbackCommand.h.

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

Definition at line 62 of file vtkOldStyleCallbackCommand.h.


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