SignCommand Class Reference

#include <SignCommand.h>

List of all members.

---

Detailed Description

Event names and callback registration.

SignCommand mainly defines names for VTK events in The SIGN. It also provides a convenience function for registering observers and their callback functions.

Author:

Eigil Samset and Arne Hans

Public Types
enum	SignEventIds {   NoEvent = vtkCommand::UserEvent, ContextUpEvent, Zoom2DViewerEvent, Annotation2DEvent,   Annotation3DEvent, SaveMRMLEvent, EditTransferFunctionEvent, SaveStateEvent,   LoadVolumeEvent, UnloadVolumeEvent, RecoverStateEvent, DeleteStateEvent,   DICOMReaderProgressEvent, MRMLVolumeProgressEvent, TrackerButtonPressEvent, TrackerButtonReleaseEvent,   TrackerEvent, TrackerZeroConfidenceEvent, VolumePropertyChangedEvent, UpdateViewerEvent,   Slice2DViewerEvent, ElementCompleteEvent, ElementDeCompleteEvent, ElementActivated,   ElementDeActivated, ECGTriggerEvent, MRMLVolumeAddedEvent, MRMLVolumeRemovedEvent,   MRMLModelAddedEvent, MRMLModelRemovedEvent, MRMLVolumeModifiedEvent, MRMLModelModifiedEvent,   MRMLModifiedEvent, EventFromThreadEvent, ValidVolumeSelection, InvalidVolumeSelection }
Static Public Member Functions
static unsigned long	RegisterCallback (vtkObject *observedObject, unsigned long event, void(*function)(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata), void *clientData, float priority=0.0)
	Registers an observer and its associated callback function with VTK.
Protected Member Functions
	SignCommand ()
	~SignCommand ()
	SignCommand (const SignCommand &c)
void	operator= (const SignCommand &)

---

Member Enumeration Documentation

enum SignCommand::SignEventIds

Enumerator: NoEvent  ContextUpEvent  Invoked on the context once it is up and running. Zoom2DViewerEvent  Invoked on the Sign2DViewer(s) when the user zooms in the window. Annotation2DEvent  Invoked on the gui's main window's view menu when the user selects or deselects 2D annotation. Annotation3DEvent  Invoked on the gui's main window's view menu when the user selects or deselects 3D annotation. SaveMRMLEvent  Invoked on the gui's main window's view menu when the user selects 'save mrml' from the menu. EditTransferFunctionEvent  Invoked on the gui's main window's view menu when the user selects 'edit transfer function' from the menu. SaveStateEvent  Invoked on the gui's main window's view menu when the user selects 'save state' from the menu. LoadVolumeEvent  Invoked on the gui's main window's view menu when the user selects 'load dicom volume' from the menu. UnloadVolumeEvent  Invoked on the gui's main window's view menu when the user selects 'close dicom volume' from the menu,. RecoverStateEvent  Invoked on the gui's main window's view menu when the user selects 'recover state' from the menu. DeleteStateEvent  Invoked on the gui's main window's view menu then the user selects 'delete state' from the menu. DICOMReaderProgressEvent  Invoked on the MRML volume node's dicom reader during reading of dicom images. MRMLVolumeProgressEvent  Invoked on the MRML manager during reading of dicom images. TrackerButtonPressEvent  Invoked on the sink when a tracker button is pressed. TrackerButtonReleaseEvent  Invoked on the sink when a tracker button is released. TrackerEvent  Invoked on the sink when a tracker event is received. TrackerZeroConfidenceEvent  Invoked on the sink when a tracker event has zero confidence. VolumePropertyChangedEvent  Invoked when the volume properties have changed (e.g. in the transfer function editor). UpdateViewerEvent  Invoked on the context when a viewer has been changed (zoom, pan,..). Slice2DViewerEvent  Invoked on the viewer when the slice is changed. ElementCompleteEvent  Invoked when a workflow element is complete. ElementDeCompleteEvent  Invoked when a workflow element was complete, but is not complete anymore. ElementActivated  Invoked when a workflow element is activated. ElementDeActivated  Invoked when a workflow element is deactivated. ECGTriggerEvent  Invoked by the SignECGSink. MRMLVolumeAddedEvent  MRML events invoked on the MRML manager. MRMLVolumeRemovedEvent  MRML events invoked on the MRML manager. MRMLModelAddedEvent  MRML events invoked on the MRML manager. MRMLModelRemovedEvent  MRML events invoked on the MRML manager. MRMLVolumeModifiedEvent  MRML events invoked on the MRML manager. MRMLModelModifiedEvent  MRML events invoked on the MRML manager. MRMLModifiedEvent  MRML events invoked on the MRML manager. EventFromThreadEvent  Invoked on the context to indicate an incoming event from another thread. ValidVolumeSelection  Invoked when the user has made a valid volume selection. InvalidVolumeSelection  Invoked when the user has made an invalid volume selection.

---

Constructor & Destructor Documentation

SignCommand::SignCommand (   )  [inline, protected]

SignCommand::~SignCommand (   )  [inline, protected]

SignCommand::SignCommand (  const SignCommand &  c  )  [inline, protected]

---

Member Function Documentation

void SignCommand::operator= (  const SignCommand &   )  [inline, protected]

unsigned long SignCommand::RegisterCallback (  vtkObject *  observedObject, unsigned long  event, void(*)(vtkObject *caller, unsigned long eid, void *clientdata, void *calldata)  function, void *  clientData, float  priority = 0.0 )  [static]

Registers an observer and its associated callback function with VTK. Parameters: observedObject  the vtkObject that will be observed event  the ID of the observed event function  pointer to the callback function clientData  pointer to data that will be passed on to the callback function when the event is triggered priority  priority of the observer (0.0 to 1.0)

---

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

• core/SignCommand.h
• core/SignCommand.cxx

---