SignSink Class Reference

#include <SignSink.h>

Inheritance diagram for SignSink:

[legend]Collaboration diagram for SignSink:

[legend]List of all members.

---

Detailed Description

Superclass for OpenTracker sinks.

SignSink is an abstract superclass for all OpenTracker sinks used in The SIGN. It provides basic functionality such as setting the station name, connecting the sink to viewers and MRML nodes, and defining a user transform for position and orientation data.

Author:

Eigil Samset

Public Member Functions
	vtkTypeRevisionMacro (SignSink, vtkObject)
void	SetName (std::string stationName)
	Sets the station name.
virtual void	AddViewer (SignViewer *viewer)
	Adds a viewer that will be updated after an event was received.
virtual vtkTransform *	GetTransform ()
	Returns the user transform.
virtual void	setMrmlNode (vtkMRMLNode *mn)
	Sets the MRML node this sink is connected to.
virtual void	setViewer (Sign2DViewer *viewer)
	Sets the main 2D viewer this sink is connected to.
Public Attributes
SignStationEventInfo	state
	Event information for SIGN classes, generated from OpenTracker event info.
bool	connect_to_user_transform
	Flag indicating if tracker will be connected to node's user transform.
ot::Event	stored_event
	Event information coming from OpenTracker.
Protected Member Functions
	SignSink ()
	Constructor.
	~SignSink ()
	Destructor.
	SignSink (const SignSink &)
void	operator= (const SignSink &)
Protected Attributes
ViewerVector	viewers
	Vector of viewers connected to this sink.

---

Constructor & Destructor Documentation

SignSink::SignSink (   )  [inline, protected]

Constructor.

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

Destructor.

SignSink::SignSink (  const SignSink &   )  [protected]

---

Member Function Documentation

void SignSink::AddViewer (  SignViewer *  viewer  )  [virtual]

Adds a viewer that will be updated after an event was received.

virtual vtkTransform* SignSink::GetTransform (   )  [inline, virtual]

Returns the user transform. Reimplemented in SignImageSink, and SignOTSink.

void SignSink::operator= (  const SignSink &   )  [protected]

virtual void SignSink::setMrmlNode (  vtkMRMLNode *  mn  )  [inline, virtual]

Sets the MRML node this sink is connected to.

void SignSink::SetName (  std::string  stationName  )  [inline]

Sets the station name.

virtual void SignSink::setViewer (  Sign2DViewer *  viewer  )  [inline, virtual]

Sets the main 2D viewer this sink is connected to. Reimplemented in SignImageSink.

SignSink::vtkTypeRevisionMacro (  SignSink  , vtkObject  )

---

Member Data Documentation

bool SignSink::connect_to_user_transform

Flag indicating if tracker will be connected to node's user transform.

SignStationEventInfo SignSink::state

Event information for SIGN classes, generated from OpenTracker event info.

ot::Event SignSink::stored_event

Event information coming from OpenTracker.

ViewerVector SignSink::viewers [protected]

Vector of viewers connected to this sink.

---

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

• ot/SignSink.h
• ot/SignSink.cxx

---