vtkMRMLRobotNode Class Reference

#include <vtkMRMLRobotNode.h>

Inheritance diagram for vtkMRMLRobotNode:

Classes
struct	StatusDescriptor
Public Types
enum	{ ChangeStatusEvent = 200907, ChangeTargetEvent = 200908, RobotMovedEvent = 200910 }
enum	STATUS_ID { StatusOff = 0, StatusOk, StatusWarning, StatusError }
Public Member Functions
virtual void	ApplyTransform (vtkMatrix4x4 *transformMatrix)
virtual void	ApplyTransform (vtkAbstractTransform *transform)
virtual bool	CanApplyNonLinearTransforms ()
virtual void	Copy (vtkMRMLNode *node)
virtual vtkMRMLNode *	CreateNodeInstance ()
virtual const char *	GetCalibrationObjectModelId ()
virtual const char *	GetCalibrationObjectTransformId ()
virtual bool	GetNeedleDirectionAtTarget (vtkProstateNavTargetDescriptor targetDesc, NeedleDescriptorStruct needle, double *needleDirection)
virtual const char *	GetNodeTagName ()
virtual bool	GetRobotBaseTransform (vtkMatrix4x4 *transform)
virtual const char *	GetRobotModelId ()
int	GetStatusDescriptor (unsigned int index, std::string &text, STATUS_ID &indicator)
int	GetStatusDescriptorCount ()
virtual std::string	GetTargetInfoText (vtkProstateNavTargetDescriptor targetDesc, NeedleDescriptorStruct needle)
vtkMRMLTransformNode *	GetTargetTransformNode ()
virtual const char *	GetWorkflowStepsString ()
virtual const char *	GetWorkspaceObjectModelId ()
virtual int	Init (vtkSlicerApplication app, const char moduleShareDir)
virtual int	MoveTo (const char *transformNodeId)
virtual int	OnTimer ()
virtual int	PerformRegistration (vtkMRMLScalarVolumeNode *volumeNode, int param1, int param2)
virtual int	PerformRegistration (vtkMRMLScalarVolumeNode *volumeNode)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData)
virtual void	ReadXMLAttributes (const char **atts)
virtual void	RemoveChildNodes ()
void	SetAndObserveTargetTransformNodeID (const char *transformNodeID)
virtual bool	ShowRobotAtTarget (vtkProstateNavTargetDescriptor targetDesc, NeedleDescriptorStruct needle)
virtual void	SwitchStep (const char *stepName)
virtual void	UpdateReferenceID (const char oldID, const char newID)
virtual void	UpdateReferences ()
virtual void	UpdateScene (vtkMRMLScene *)
	vtkGetStringMacro (TargetTransformNodeID)
	vtkTypeMacro (vtkMRMLRobotNode, vtkMRMLTransformableNode)
virtual void	WriteXML (ostream &of, int indent)
Static Public Member Functions
static std::string	GetTargetInfoSectionSeparator ()
static vtkMRMLRobotNode *	New ()
static void	SplitTargetInfoText (const std::string targetInfoText, std::string &mainInfo, std::string &additionalInfo)
Protected Member Functions
void	operator= (const vtkMRMLRobotNode &)
	vtkMRMLRobotNode (const vtkMRMLRobotNode &)
	vtkMRMLRobotNode ()
	vtkSetReferenceStringMacro (TargetTransformNodeID)
virtual	~vtkMRMLRobotNode ()
Protected Attributes
std::string	ModuleShareDirectory
std::vector< StatusDescriptor >	StatusDescriptors
vtkMRMLTransformNode *	TargetTransformNode
char *	TargetTransformNodeID

Member Enumeration Documentation

anonymous enum

Enumerator:

ChangeStatusEvent
ChangeTargetEvent
RobotMovedEvent

enum vtkMRMLRobotNode::STATUS_ID

Enumerator:

StatusOff
StatusOk
StatusWarning
StatusError

Constructor & Destructor Documentation

vtkMRMLRobotNode::vtkMRMLRobotNode ( ) [protected]

References vtkMRMLNode::HideFromEditors, TargetTransformNode, and TargetTransformNodeID.

vtkMRMLRobotNode::~vtkMRMLRobotNode ( ) [protected, virtual]

References SetAndObserveTargetTransformNodeID(), and TargetTransformNodeID.

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

Member Function Documentation

void vtkMRMLRobotNode::ApplyTransform ( vtkMatrix4x4 * transformMatrix ) [virtual]

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

References ApplyTransform().

void vtkMRMLRobotNode::ApplyTransform ( vtkAbstractTransform * transform ) [virtual]

Implements vtkMRMLTransformableNode.

Referenced by ApplyTransform().

bool vtkMRMLRobotNode::CanApplyNonLinearTransforms ( ) [virtual]

Transformable node methods Only linear transforms are supported

Implements vtkMRMLTransformableNode.

void vtkMRMLRobotNode::Copy ( vtkMRMLNode * node ) [virtual]

Copy the node's attributes to this object

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References vtkMRMLNode::EndModify(), SetAndObserveTargetTransformNodeID(), vtkMRMLNode::StartModify(), and TargetTransformNodeID.

vtkMRMLNode * vtkMRMLRobotNode::CreateNodeInstance ( ) [virtual]

Create instance of the default node. Like New only virtual NOTE: Subclasses should implement this method

Implements vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References autoSlicerTracto2regions::ret.

virtual const char* vtkMRMLRobotNode::GetCalibrationObjectModelId ( ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

virtual const char* vtkMRMLRobotNode::GetCalibrationObjectTransformId ( ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

virtual bool vtkMRMLRobotNode::GetNeedleDirectionAtTarget	(	vtkProstateNavTargetDescriptor *	targetDesc,
		NeedleDescriptorStruct *	needle,
		double *	needleDirection
	)			`[inline, virtual]`

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkProstateNavGUI::BringTargetToViewIn2DViews().

virtual const char* vtkMRMLRobotNode::GetNodeTagName ( ) [inline, virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

virtual bool vtkMRMLRobotNode::GetRobotBaseTransform ( vtkMatrix4x4 * transform ) [inline, virtual]

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkProstateNavGUI::BringTargetToViewIn2DViews().

virtual const char* vtkMRMLRobotNode::GetRobotModelId ( ) [inline, virtual]

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkProstateNavLogic::IsRobotModelShown(), and vtkProstateNavLogic::ShowRobotModel().

int vtkMRMLRobotNode::GetStatusDescriptor	(	unsigned int	index,
		std::string &	text,
		STATUS_ID &	indicator
	)

References StatusDescriptors.

Referenced by vtkProstateNavGUI::UpdateStatusButtons().

int vtkMRMLRobotNode::GetStatusDescriptorCount ( )

References StatusDescriptors.

Referenced by vtkProstateNavGUI::UpdateStatusButtons().

static std::string vtkMRMLRobotNode::GetTargetInfoSectionSeparator ( ) [inline, static]

Referenced by vtkMRMLTransRectalProstateRobotNode::GetTargetInfoText(), and SplitTargetInfoText().

virtual std::string vtkMRMLRobotNode::GetTargetInfoText	(	vtkProstateNavTargetDescriptor *	targetDesc,
		NeedleDescriptorStruct *	needle
	)			`[inline, virtual]`

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkProstateNavGUI::UpdateCurrentTargetDisplayInSecondaryWindow(), and vtkProstateNavTargetingStep::UpdateGUI().

vtkMRMLTransformNode * vtkMRMLRobotNode::GetTargetTransformNode ( )

References vtkMRMLScene::GetNodeByID(), vtkMRMLNode::GetScene(), and TargetTransformNodeID.

Referenced by Init(), RemoveChildNodes(), and SetAndObserveTargetTransformNodeID().

virtual const char* vtkMRMLRobotNode::GetWorkflowStepsString ( ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkMRMLProstateNavManagerNode::SetAndObserveRobotNodeID().

virtual const char* vtkMRMLRobotNode::GetWorkspaceObjectModelId ( ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkProstateNavLogic::IsWorkspaceModelShown(), and vtkProstateNavLogic::ShowWorkspaceModel().

int vtkMRMLRobotNode::Init	(	vtkSlicerApplication *	app,
		const char *	moduleShareDir
	)			`[virtual]`

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References vtkMRMLScene::AddNode(), vtkMRMLNode::GetScene(), GetTargetTransformNode(), ModuleShareDirectory, New(), and SetAndObserveTargetTransformNodeID().

Referenced by vtkProstateNavGUI::SetAndObserveRobotNodeID().

virtual int vtkMRMLRobotNode::MoveTo ( const char * transformNodeId ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

Referenced by vtkProstateNavLogic::RobotMoveTo().

vtkMRMLRobotNode * vtkMRMLRobotNode::New ( ) [static]

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References autoSlicerTracto2regions::ret.

Referenced by Init(), and SetAndObserveTargetTransformNodeID().

virtual int vtkMRMLRobotNode::OnTimer ( ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

Referenced by vtkProstateNavLogic::TimerHandler().

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

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

virtual int vtkMRMLRobotNode::PerformRegistration	(	vtkMRMLScalarVolumeNode *	volumeNode,
		int	param1,
		int	param2
	)			`[inline, virtual]`

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

virtual int vtkMRMLRobotNode::PerformRegistration ( vtkMRMLScalarVolumeNode * volumeNode ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

void vtkMRMLRobotNode::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References TargetTransformNodeID.

void vtkMRMLRobotNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned long	long,
		void *
	)			`[virtual]`

alternative method to propagate events generated in Transform nodes

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

void vtkMRMLRobotNode::ReadXMLAttributes ( const char ** atts ) [virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References SetAndObserveTargetTransformNodeID().

void vtkMRMLRobotNode::RemoveChildNodes ( ) [virtual]

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

References vtkMRMLNode::GetScene(), GetTargetTransformNode(), vtkMRMLScene::RemoveNode(), and TargetTransformNodeID.

Referenced by vtkProstateNavGUI::ProcessMRMLEvents().

void vtkMRMLRobotNode::SetAndObserveTargetTransformNodeID ( const char * transformNodeID )

References GetTargetTransformNode(), New(), TargetTransformNode, vtkMRMLTransformableNode::TransformModifiedEvent, vtkSetAndObserveMRMLObjectEventsMacro, and vtkSetAndObserveMRMLObjectMacro.

Referenced by Copy(), Init(), ReadXMLAttributes(), UpdateReferenceID(), UpdateReferences(), UpdateScene(), and ~vtkMRMLRobotNode().

virtual bool vtkMRMLRobotNode::ShowRobotAtTarget	(	vtkProstateNavTargetDescriptor *	targetDesc,
		NeedleDescriptorStruct *	needle
	)			`[inline, virtual]`

Reimplemented in vtkMRMLTransRectalProstateRobotNode.

Referenced by vtkMRMLProstateNavManagerNode::SetCurrentTargetIndex().

void vtkMRMLRobotNode::SplitTargetInfoText	(	const std::string	targetInfoText,
		std::string &	mainInfo,
		std::string &	additionalInfo
	)			`[static]`

References GetTargetInfoSectionSeparator(), treechecker::info, and slicerget::size.

Referenced by vtkProstateNavGUI::UpdateCurrentTargetDisplayInSecondaryWindow(), and vtkProstateNavTargetingStep::UpdateGUI().

virtual void vtkMRMLRobotNode::SwitchStep ( const char * stepName ) [inline, virtual]

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, and vtkMRMLTransPerinealProstateTemplateNode.

Referenced by vtkMRMLProstateNavManagerNode::SwitchStep().

void vtkMRMLRobotNode::UpdateReferenceID	(	const char *	oldID,
		const char *	newID
	)			`[virtual]`

Update the stored reference to another node in the scene

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References SetAndObserveTargetTransformNodeID(), and TargetTransformNodeID.

void vtkMRMLRobotNode::UpdateReferences ( ) [virtual]

Updates this node if it depends on other nodes when the node is deleted in the scene

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References vtkMRMLScene::GetNodeByID(), vtkMRMLNode::Scene, SetAndObserveTargetTransformNodeID(), and TargetTransformNodeID.

void vtkMRMLRobotNode::UpdateScene ( vtkMRMLScene * scene ) [virtual]

Observe the reference transform node

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References SetAndObserveTargetTransformNodeID(), and TargetTransformNodeID.

vtkMRMLRobotNode::vtkGetStringMacro ( TargetTransformNodeID )

vtkMRMLRobotNode::vtkSetReferenceStringMacro ( TargetTransformNodeID ) [protected]

vtkMRMLRobotNode::vtkTypeMacro	(	vtkMRMLRobotNode	,
		vtkMRMLTransformableNode
	)

void vtkMRMLRobotNode::WriteXML	(	ostream &	of,
		int	indent
	)			`[virtual]`

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLTransPerinealProstateRobotNode, vtkMRMLTransPerinealProstateTemplateNode, and vtkMRMLTransRectalProstateRobotNode.

References TargetTransformNodeID.

Member Data Documentation

std::string vtkMRMLRobotNode::ModuleShareDirectory [protected]

Referenced by Init(), vtkMRMLTransRectalProstateRobotNode::UpdateRobotModelProbe(), and vtkMRMLTransRectalProstateRobotNode::UpdateWorkspaceModel().

std::vector<StatusDescriptor> vtkMRMLRobotNode::StatusDescriptors [protected]

Referenced by vtkMRMLTransPerinealProstateTemplateNode::Copy(), vtkMRMLTransPerinealProstateRobotNode::Copy(), GetStatusDescriptor(), GetStatusDescriptorCount(), vtkMRMLTransPerinealProstateTemplateNode::ProcessMRMLEvents(), vtkMRMLTransPerinealProstateRobotNode::ProcessMRMLEvents(), vtkMRMLTransPerinealProstateRobotNode::vtkMRMLTransPerinealProstateRobotNode(), and vtkMRMLTransPerinealProstateTemplateNode::vtkMRMLTransPerinealProstateTemplateNode().

vtkMRMLTransformNode* vtkMRMLRobotNode::TargetTransformNode [protected]

Referenced by SetAndObserveTargetTransformNodeID(), and vtkMRMLRobotNode().

char* vtkMRMLRobotNode::TargetTransformNodeID [protected]

Referenced by Copy(), GetTargetTransformNode(), PrintSelf(), RemoveChildNodes(), UpdateReferenceID(), UpdateReferences(), UpdateScene(), vtkMRMLRobotNode(), WriteXML(), and ~vtkMRMLRobotNode().

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

Modules/ProstateNav/vtkMRMLRobotNode.h
Modules/ProstateNav/vtkMRMLRobotNode.cxx

vtkMRMLRobotNode Class Reference

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation