---

vtkCommand Class Reference

superclass for callback/observer methods. More...

#include <vtkCommand.h>

Inheritance diagram for vtkCommand:

[legend]Collaboration diagram for vtkCommand:

[legend]List of all members.

Public Types
enum	EventIds {   NoEvent = 0, AnyEvent, DeleteEvent, StartEvent,   EndEvent, ProgressEvent, PickEvent, StartPickEvent,   EndPickEvent, AbortCheckEvent, ExitEvent, LeftButtonPressEvent,   LeftButtonReleaseEvent, MiddleButtonPressEvent, MiddleButtonReleaseEvent, RightButtonPressEvent,   RightButtonReleaseEvent, EnterEvent, LeaveEvent, KeyPressEvent,   KeyReleaseEvent, CharEvent, ConfigureEvent, TimerEvent,   MouseMoveEvent, ResetCameraEvent, ResetCameraClippingRangeEvent, ModifiedEvent,   WindowLevelEvent, NextDataEvent, PushDataStartEvent, SetOutputEvent,   EndOfDataEvent, ErrorEvent, WarningEvent, UserEvent = 1000 }
Public Methods
void	Delete ()
virtual void	Execute (vtkObject *caller, unsigned long, void *callData)=0
void	Register ()
void	Register (vtkObject *)
void	UnRegister ()
void	UnRegister (vtkObject *)
Static Public Methods
const char *	GetStringFromEventId (unsigned long event)
unsigned long	GetEventIdFromString (const char *event)
Protected Methods
	vtkCommand ()
virtual	~vtkCommand ()
Protected Attributes
int	ReferenceCount

---

Detailed Description

superclass for callback/observer methods.

Date:

2002/01/24 16:05:58

Revision:

1.19.2.1

vtkCommand is an implementation of the command design pattern that is used in callbacks (such as StartMethod(), ProgressMethod(), and EndMethod()) in VTK. vtkObject implements a Subject/Observer pattern. When a subject needs to notify a observer, it does so using a vtkCommand.

Definition at line 36 of file vtkCommand.h.

---

Member Enumeration Documentation

enum vtkCommand::EventIds

Enumeration values: NoEvent  AnyEvent  DeleteEvent  StartEvent  EndEvent  ProgressEvent  PickEvent  StartPickEvent  EndPickEvent  AbortCheckEvent  ExitEvent  LeftButtonPressEvent  LeftButtonReleaseEvent  MiddleButtonPressEvent  MiddleButtonReleaseEvent  RightButtonPressEvent  RightButtonReleaseEvent  EnterEvent  LeaveEvent  KeyPressEvent  KeyReleaseEvent  CharEvent  ConfigureEvent  TimerEvent  MouseMoveEvent  ResetCameraEvent  ResetCameraClippingRangeEvent  ModifiedEvent  WindowLevelEvent  NextDataEvent  PushDataStartEvent  SetOutputEvent  EndOfDataEvent  ErrorEvent  WarningEvent  UserEvent  Definition at line 68 of file vtkCommand.h.

---

Constructor & Destructor Documentation

vtkCommand::vtkCommand (    )  [inline, protected]

Definition at line 109 of file vtkCommand.h.

virtual vtkCommand::~vtkCommand (    )  [inline, protected, virtual]

Definition at line 110 of file vtkCommand.h.

---

Member Function Documentation

void vtkCommand::Delete (    )  [inline]

Definition at line 39 of file vtkCommand.h.

void vtkCommand::Register (    )

Increase the reference count (mark as used by another object).

void vtkCommand::Register (  vtkObject *    )  [inline]

Increase the reference count (mark as used by another object). Definition at line 45 of file vtkCommand.h.

void vtkCommand::UnRegister (    )

Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

void vtkCommand::UnRegister (  vtkObject *    )  [inline]

Decrease the reference count (release by another object). This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1). Definition at line 54 of file vtkCommand.h.

virtual void vtkCommand::Execute (  vtkObject *    ptr, unsigned long    eventtype, void *    callData )  [pure virtual]

Reimplemented in vtkCallbackCommand, vtkJavaCommand, vtkOldStyleCallbackCommand, vtkPythonCommand, and vtkTclCommand.

const char* vtkCommand::GetStringFromEventId (  unsigned long    event )  [static]

unsigned long vtkCommand::GetEventIdFromString (  const char *    event )  [static]

---

Member Data Documentation

int vtkCommand::ReferenceCount [protected]

Definition at line 108 of file vtkCommand.h.

---

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

• Common/vtkCommand.h

---