vtkMRMLFiducialListNode Class Reference

#include <vtkMRMLFiducialListNode.h>

Inheritance diagram for vtkMRMLFiducialListNode:

List of all members.

Public Types
enum	{ DisplayModifiedEvent = 19000, PolyDataModifiedEvent = 19001, FiducialModifiedEvent = 19002, FiducialIndexModifiedEvent = 19003 }
enum	GlyphShapes {   GlyphMin = 1, Vertex2D = GlyphMin, Dash2D, Cross2D,   ThickCross2D, Triangle2D, Square2D, Circle2D,   Diamond2D, Arrow2D, ThickArrow2D, HookedArrow2D,   StarBurst2D, Sphere3D, Diamond3D, GlyphMax = Diamond3D }
enum	NumberingSchemes {   SchemeMin = 0, UseID = SchemeMin, UseIndex, UsePrevious,   SchemeMax = UsePrevious }
	flags to determine how the next fiducial added to the list is labelled More...
Public Member Functions
int	AddFiducial ()
	Add a fiducial point to the list with default values.
int	AddFiducialWithLabelXYZSelectedVisibility (const char *label, float x, float y, float z, int selected, int visibility)
	Add a fiducial point to the list with a label, x,y,z, selected flag, visibility.
int	AddFiducialWithXYZ (float x, float y, float z, int selected)
	Add a fiducial point to the list x, y, z.
virtual void	ApplyTransform (vtkAbstractTransform *transform)
virtual void	ApplyTransform (vtkMatrix4x4 *transformMatrix)
virtual bool	CanApplyNonLinearTransforms ()
	transform utility functions
virtual void	Copy (vtkMRMLNode *node)
	Copy the node's attributes to this object.
virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()
	Create default storage node or NULL if does not have one.
virtual vtkMRMLNode *	CreateNodeInstance ()
int	GetFiducialIndex (std::string fiducialID)
const char *	GetGlyphTypeAsString (int g)
const char *	GetGlyphTypeAsString ()
	Return a string representing the glyph type, set it from a string.
int	GetMaximumGlyphType ()
int	GetMinimumGlyphType ()
	Return the min/max glyph types, for iterating over them in tcl.
virtual const char *	GetNodeTagName ()
	Get node XML tag name (like Volume, Model).
const char *	GetNthFiducialID (int n)
	get the id of the nth fiducial
const char *	GetNthFiducialLabelText (int n)
	get the label text of the nth fiducial
float *	GetNthFiducialOrientation (int n)
	get the orientation of the nth fiducial
int	GetNthFiducialSelected (int n)
	get the selected state on the nth fiducial
int	GetNthFiducialVisibility (int n)
	get the visible state on the nth fiducial
float *	GetNthFiducialXYZ (int n)
int	GetNthFiducialXYZWorld (int n, double *worldxyz)
const char *	GetNumberingSchemeAsString (int g)
const char *	GetNumberingSchemeAsString ()
	Return a string representing the numbering scheme, set it from a string.
int	GetNumberOfFiducials ()
	Get the number of fiducials in the list.
int	GlyphTypeIs3D ()
int	GlyphTypeIs3D (int glyphType)
	Returns 1 if the type is a 3d one, 0 else.
int	IsFiducialPresent (vtkMRMLFiducial *o)
	is this fiducial on the list?
int	MoveFiducialDown (int fidIndex)
int	MoveFiducialUp (int fidIndex)
void	PrintSelf (ostream &os, vtkIndent indent)
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
	Process events from the MRML scene.
virtual void	ReadXMLAttributes (const char **atts)
	Set node attributes.
void	RemoveAllFiducials ()
	remove all fiducials from the list
void	RemoveFiducial (int i)
	remove the fiducial at index i
void	RemoveFiducial (vtkMRMLFiducial *o)
	remove the passed in fiducial from the list
void	RenameFiducials (const char *newName)
void	RenumberFiducials (int startFrom=0)
int	SetAllFiducialsSelected (int flag)
	Set all fiducials selected state to flag.
int	SetAllFiducialsVisibility (int flag)
	Set all fiducials visible state to flag.
void	SetAmbient (double val)
	Ambient of the fiducial surface expressed as a number from 0 to 1.
void	SetColor (double c[3])
void	SetColor (double r, double g, double b)
void	SetDiffuse (double val)
	Diffuse of the fiducial surface expressed as a number from 0 to 1.
void	SetFiducialLabelTextFromID (vtkMRMLFiducial *fid)
int	SetFiducialXYZ (std::string fiducialID, float x, float y, float z)
void	SetGlyphType (int type)
	The glyph type used to display this fiducial.
void	SetGlyphTypeFromString (const char *glyphString)
void	SetLocked (int locked)
	When fiducial lists are locked, they cannot be manipulated using the interactive widgets.
int	SetNthFiducialID (int n, const char *id)
int	SetNthFiducialLabelText (int n, const char *text)
int	SetNthFiducialOrientation (int n, float w, float x, float y, float z)
int	SetNthFiducialSelected (int n, int flag)
int	SetNthFiducialSelectedNoModified (int n, int flag)
int	SetNthFiducialVisibility (int n, int flag)
int	SetNthFiducialVisibilityNoModified (int n, int flag)
int	SetNthFiducialXYZ (int n, float x, float y, float z)
int	SetNthFiducialXYZWorld (int n, float x, float y, float z)
void	SetNumberingSchemeFromString (const char *schemeString)
void	SetOpacity (double opacity)
	Opacity of the fiducial surface expressed as a number from 0 to 1.
void	SetPower (double val)
	Power of the fiducial surface expressed as a number from 0 to 1.
void	SetSelectedColor (double c[3])
void	SetSelectedColor (double r, double g, double b)
	Get/Set for colour for when a fiducial is selected.
void	SetSpecular (double val)
	Specular of the fiducial surface expressed as a number from 0 to 1.
void	SetSymbolScale (double scale)
	vtkSetMacro(SymbolScale,double);
void	SetTextScale (double scale)
void	SetVisibility (int visible)
void	UpdateReferences ()
	update display node ids
virtual void	UpdateScene (vtkMRMLScene *scene)
	vtkGetMacro (NumberingScheme, int)
	vtkGetMacro (GlyphType, int)
	vtkGetMacro (Locked, int)
	vtkGetMacro (Power, double)
	vtkGetMacro (Specular, double)
	vtkGetMacro (Diffuse, double)
	vtkGetMacro (Ambient, double)
	vtkGetMacro (Opacity, double)
	vtkGetMacro (TextScale, double)
	vtkGetMacro (Visibility, int)
	vtkGetMacro (SymbolScale, double)
	vtkGetVectorMacro (SelectedColor, double, 3)
	vtkGetVectorMacro (Color, double, 3)
	vtkSetMacro (NumberingScheme, int)
	Flag determining how to number the next added fiducial.
	vtkTypeMacro (vtkMRMLFiducialListNode, vtkMRMLStorableNode)
virtual void	WriteXML (ostream &of, int indent)
	Write this node's information to a MRML file in XML format.
Static Public Member Functions
static vtkMRMLFiducialListNode *	New ()
Protected Member Functions
vtkMRMLFiducial *	GetNthFiducial (int n)
void	operator= (const vtkMRMLFiducialListNode &)
	vtkMRMLFiducialListNode (const vtkMRMLFiducialListNode &)
	vtkMRMLFiducialListNode ()
	~vtkMRMLFiducialListNode ()
Protected Attributes
double	Ambient
double	Color [3]
double	Diffuse
vtkCollection *	FiducialList
	The collection of fiducial points that make up this list.
int	GlyphType
int	Locked
int	NumberingScheme
	How the next added fiducial will be numbered in it's LabelText field.
double	Opacity
	Numbers relating to the display of the fiducials.
double	Power
double	SelectedColor [3]
double	Specular
double	SymbolScale
double	TextScale
int	Visibility

---

Member Enumeration Documentation

anonymous enum

DisplayModifiedEvent is generated when display node parameters is changed PolyDataModifiedEvent is generated when something else is changed

Enumerator:

DisplayModifiedEvent
PolyDataModifiedEvent
FiducialModifiedEvent
FiducialIndexModifiedEvent

enum vtkMRMLFiducialListNode::GlyphShapes

Which kind of glyph should be used to display this fiducial? Vertex2D is supposed to start at 1

Enumerator:

GlyphMin
Vertex2D
Dash2D
Cross2D
ThickCross2D
Triangle2D
Square2D
Circle2D
Diamond2D
Arrow2D
ThickArrow2D
HookedArrow2D
StarBurst2D
Sphere3D
Diamond3D
GlyphMax

enum vtkMRMLFiducialListNode::NumberingSchemes

flags to determine how the next fiducial added to the list is labelled

Enumerator:

SchemeMin
UseID
UseIndex
UsePrevious
SchemeMax

---

Constructor & Destructor Documentation

vtkMRMLFiducialListNode::vtkMRMLFiducialListNode

(

)

[protected]

References Ambient, Color, Diffuse, FiducialList, GlyphType, Locked, vtkMRMLNode::Name, New(), NumberingScheme, Opacity, Power, SelectedColor, Specular, StarBurst2D, SymbolScale, TextScale, UseID, and Visibility.

vtkMRMLFiducialListNode::~vtkMRMLFiducialListNode

(

)

[protected]

References FiducialList, and vtkMRMLNode::Name.

vtkMRMLFiducialListNode::vtkMRMLFiducialListNode

(

const vtkMRMLFiducialListNode &

)

[protected]

---

Member Function Documentation

int vtkMRMLFiducialListNode::AddFiducial

(

)

Add a fiducial point to the list with default values.

References FiducialList, vtkMRMLNode::GetScene(), New(), vtkMRMLScene::NodeAddedEvent, vtkMRMLNode::Scene, and SetFiducialLabelTextFromID().

Referenced by ReadXMLAttributes().

int vtkMRMLFiducialListNode::AddFiducialWithLabelXYZSelectedVisibility	(	const char *	label,
		float	x,
		float	y,
		float	z,
		int	selected,
		int	visibility
	)

Add a fiducial point to the list with a label, x,y,z, selected flag, visibility.

References FiducialList, vtkMRMLNode::GetScene(), IsFiducialPresent(), New(), vtkMRMLScene::NodeAddedEvent, and vtkMRMLNode::Scene.

Referenced by vtkCollectFiducialsLogic::AddFiducial(), vtkProstateNavStepVerification::DisplayVerificationResultsForCurrentTarget(), and vtkMRMLFiducialListStorageNode::ReadData().

int vtkMRMLFiducialListNode::AddFiducialWithXYZ	(	float	x,
		float	y,
		float	z,
		int	selected
	)

Add a fiducial point to the list x, y, z.

References FiducialList, vtkMRMLNode::GetScene(), IsFiducialPresent(), New(), vtkMRMLScene::NodeAddedEvent, vtkMRMLNode::Scene, and SetFiducialLabelTextFromID().

Referenced by vtkSlicerFiducialsLogic::AddFiducialSelected(), vtkMRMLProstateNavManagerNode::AddTargetToFiducialList(), and vtkSlicerFiducialsSeedWidgetCallback::Execute().

void vtkMRMLFiducialListNode::ApplyTransform

(

vtkAbstractTransform *

transform

)

[virtual]

Implements vtkMRMLTransformableNode.

References GetNthFiducial(), GetNumberOfFiducials(), and mathExample::n.

void vtkMRMLFiducialListNode::ApplyTransform

(

vtkMatrix4x4 *

transformMatrix

)

[virtual]

Reimplemented from vtkMRMLTransformableNode.

References double(), GetNthFiducial(), GetNumberOfFiducials(), mathExample::n, New(), and vtkMRMLFiducial::SetOrientationWXYZFromMatrix4x4().

virtual bool vtkMRMLFiducialListNode::CanApplyNonLinearTransforms

(

)

[inline, virtual]

transform utility functions

Implements vtkMRMLTransformableNode.

void vtkMRMLFiducialListNode::Copy

(

vtkMRMLNode *

node

)

[virtual]

Copy the node's attributes to this object.

Reimplemented from vtkMRMLStorableNode.

References Ambient, Color, Diffuse, vtkMRMLNode::EndModify(), FiducialList, FiducialModifiedEvent, GetNumberOfFiducials(), Locked, vtkMRMLNode::Modified(), vtkMRMLNode::Name, New(), NumberingScheme, Opacity, Power, RemoveAllFiducials(), SelectedColor, SetAmbient(), SetColor(), SetDiffuse(), SetLocked(), SetOpacity(), SetPower(), SetSelectedColor(), SetSpecular(), SetSymbolScale(), SetTextScale(), SetVisibility(), Specular, vtkMRMLNode::StartModify(), SymbolScale, TextScale, and Visibility.

virtual vtkMRMLStorageNode* vtkMRMLFiducialListNode::CreateDefaultStorageNode

(

)

[inline, virtual]

Create default storage node or NULL if does not have one.

Reimplemented from vtkMRMLStorableNode.

References vtkMRMLFiducialListStorageNode::New().

Referenced by vtkSlicerFiducialsLogic::LoadFiducialList().

vtkMRMLNode * vtkMRMLFiducialListNode::CreateNodeInstance

(

void

)

[virtual]

-------------------------------------------------------------------------- MRMLNode methods --------------------------------------------------------------------------

Implements vtkMRMLStorableNode.

References autoSlicerTracto2regions::ret.

int vtkMRMLFiducialListNode::GetFiducialIndex

(

std::string

fiducialID

)

Look through the list of fiducials for fiducialID and return the current zero based index. Useful when delete fiducials from the list, as the index will change. Returns -1 if none found.

References GetNthFiducialID(), GetNumberOfFiducials(), and mathExample::n.

Referenced by vtkSlicerFiducialListWidget::AddSeed(), vtkSlicerFiducialsSeedWidgetCallback::Execute(), vtkProstateNavTargetingStep::ProcessGUIEvents(), vtkProstateNavStepTargetingTemplate::ProcessGUIEvents(), vtkSlicerFiducialsGUI::ProcessMRMLEvents(), SetFiducialLabelTextFromID(), SetFiducialXYZ(), vtkSlicerFiducialListWidget::UpdateSeed(), and vtkProstateNavLogic::UpdateTargetListFromMRML().

const char * vtkMRMLFiducialListNode::GetGlyphTypeAsString

(

int

g

)

References Arrow2D, Circle2D, Cross2D, Dash2D, Diamond2D, Diamond3D, HookedArrow2D, Sphere3D, Square2D, StarBurst2D, ThickArrow2D, ThickCross2D, Triangle2D, and Vertex2D.

const char * vtkMRMLFiducialListNode::GetGlyphTypeAsString

(

)

Return a string representing the glyph type, set it from a string.

References GlyphType.

Referenced by PrintSelf(), and vtkSlicerFiducialsGUI::SetGUIDisplayFrameFromList().

int vtkMRMLFiducialListNode::GetMaximumGlyphType

(

)

[inline]

References GlyphMax.

int vtkMRMLFiducialListNode::GetMinimumGlyphType

(

)

[inline]

Return the min/max glyph types, for iterating over them in tcl.

References GlyphMin.

virtual const char* vtkMRMLFiducialListNode::GetNodeTagName

(

)

[inline, virtual]

Get node XML tag name (like Volume, Model).

Implements vtkMRMLStorableNode.

vtkMRMLFiducial * vtkMRMLFiducialListNode::GetNthFiducial

(

int

n

)

[protected]

disallow access to the fiducial points by outside classes, have them use SetNthFiducial

References FiducialList.

Referenced by ApplyTransform(), GetNthFiducialID(), GetNthFiducialLabelText(), GetNthFiducialOrientation(), GetNthFiducialSelected(), GetNthFiducialVisibility(), GetNthFiducialXYZ(), MoveFiducialDown(), MoveFiducialUp(), PrintSelf(), ReadXMLAttributes(), RemoveFiducial(), SetNthFiducialID(), SetNthFiducialLabelText(), SetNthFiducialOrientation(), SetNthFiducialSelected(), SetNthFiducialSelectedNoModified(), SetNthFiducialVisibility(), SetNthFiducialVisibilityNoModified(), SetNthFiducialXYZ(), and WriteXML().

const char * vtkMRMLFiducialListNode::GetNthFiducialID

(

int

n

)

get the id of the nth fiducial

References GetNthFiducial().

Referenced by vtkSlicerFiducialListWidget::AddSeed(), vtkSlicerFiducialListWidget::AddSeedWidget(), GetFiducialIndex(), vtkProstateNavLogic::LinkTargetsToFiducials(), vtkSlicerFiducialListWidget::ProcessMRMLEvents(), vtkSlicerFiducialListWidget::Swap(), vtkSlicerFiducialListWidget::Update3DWidget(), vtkProstateNavGUI::UpdateCurrentTargetDisplay(), vtkSlicerFiducialListWidget::UpdateFiducialListFromMRML(), and vtkProstateNavLogic::UpdateTargetListFromMRML().

const char * vtkMRMLFiducialListNode::GetNthFiducialLabelText

(

int

n

)

get the label text of the nth fiducial

References GetNthFiducial().

Referenced by vtkProstateNavLogic::LinkTargetsToFiducials(), RenameFiducials(), RenumberFiducials(), SetFiducialLabelTextFromID(), vtkSlicerFiducialListWidget::Update3DWidgetText(), vtkMRMLTransRectalProstateRobotNode::UpdateCalibration(), vtkSlicerFiducialsGUI::UpdateElement(), vtkSlicerFiducialsGUI::UpdateMeasurementLabels(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), vtkSlicerFiducialListWidget::UpdateSeed(), vtkProstateNavLogic::UpdateTargetListFromMRML(), vtkProstateNavStepVerification::UpdateVerificationResultsForCurrentTarget(), and vtkMRMLFiducialListStorageNode::WriteData().

float * vtkMRMLFiducialListNode::GetNthFiducialOrientation

(

int

n

)

get the orientation of the nth fiducial

References GetNthFiducial().

Referenced by vtkProstateNavTargetingStep::OnMultiColumnListUpdate(), vtkProstateNavStepTargetingTemplate::OnMultiColumnListUpdate(), vtkSlicerFiducialsGUI::UpdateElement(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), and vtkProstateNavLogic::UpdateTargetListFromMRML().

int vtkMRMLFiducialListNode::GetNthFiducialSelected

(

int

n

)

get the selected state on the nth fiducial

References GetNthFiducial().

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkSlicerTractographyFiducialSeedingLogic::CreateTracts(), vtkSlicerFiducialListWidget::Update3DWidgetColour(), vtkSlicerFiducialListWidget::Update3DWidgetSelected(), vtkProstateNavGUI::UpdateCurrentTargetDisplay(), vtkSlicerFiducialsGUI::UpdateMeasurementLabels(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), vtkSlicerFiducialListWidget::UpdateSeed(), and vtkMRMLFiducialListStorageNode::WriteData().

int vtkMRMLFiducialListNode::GetNthFiducialVisibility

(

int

n

)

get the visible state on the nth fiducial

References GetNthFiducial().

Referenced by vtkSlicerFiducialsGUI::ModifyIndividualFiducialsVisibilityGUI(), vtkSlicerFiducialListWidget::Update3DWidgetVisibility(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), vtkSlicerFiducialListWidget::UpdateSeed(), vtkSlicerFiducialsGUI::VisibilityOrLockToggleCallback(), and vtkMRMLFiducialListStorageNode::WriteData().

float * vtkMRMLFiducialListNode::GetNthFiducialXYZ

(

int

n

)

Get the elements of the fiducial points Return a three element float holding the position

References GetNthFiducial().

Referenced by vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), vtkSlicerTractographyFiducialSeedingLogic::CreateTracts(), vtkProstateNavStepVerification::DisplayVerificationResultsForCurrentTarget(), GetNthFiducialXYZWorld(), vtkMRMLProstateNavManagerNode::GetTargetFromFiducialList(), vtkProstateNavFiducialCalibrationStep::JumpToFiducial(), vtkProstateNavLogic::LinkTargetsToFiducials(), vtkMeasurementsLogic::NewRulerBetweenFiducials(), vtkProstateNavTargetingStep::OnMultiColumnListUpdate(), vtkProstateNavStepTargetingTemplate::OnMultiColumnListUpdate(), vtkMRMLTransRectalProstateRobotNode::UpdateCalibration(), vtkSlicerFiducialsGUI::UpdateElement(), vtkSlicerFiducialsGUI::UpdateMeasurementLabels(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), vtkProstateNavLogic::UpdateTargetListFromMRML(), vtkProstateNavStepVerification::UpdateVerificationResultsForCurrentTarget(), and vtkMRMLFiducialListStorageNode::WriteData().

int vtkMRMLFiducialListNode::GetNthFiducialXYZWorld	(	int	n,
		double *	worldxyz
	)

Return a three element double giving the world position (any parent transform on the list applied to the return of GetNthFiducialXYZ. worldxyz is a 4 item array, xyzw returns 0 on failure, 1 on success.

References vtkMRMLLinearTransformNode::GetMatrixTransformToWorld(), GetNthFiducialXYZ(), vtkMRMLTransformableNode::GetParentTransformNode(), vtkMRMLTransformNode::IsLinear(), and New().

Referenced by vtkSlicerFiducialListWidget::AddSeed(), vtkSlicerFiducialListWidget::Update3DWidgetPositions(), and vtkSlicerFiducialListWidget::UpdateSeed().

const char * vtkMRMLFiducialListNode::GetNumberingSchemeAsString

(

int

g

)

References UseID, UseIndex, and UsePrevious.

const char * vtkMRMLFiducialListNode::GetNumberingSchemeAsString

(

)

Return a string representing the numbering scheme, set it from a string.

References NumberingScheme.

Referenced by PrintSelf(), and vtkSlicerFiducialsGUI::SetGUIFromList().

int vtkMRMLFiducialListNode::GetNumberOfFiducials

(

)

Get the number of fiducials in the list.

References FiducialList.

Referenced by vtkSlicerFiducialListWidget::AddSeed(), vtkSlicerFiducialListWidget::AddSeedWidget(), vtkCommandLineModuleLogic::ApplyTask(), vtkSlicerCLIModuleLogic::ApplyTask(), ApplyTransform(), Copy(), vtkSlicerTractographyFiducialSeedingLogic::CreateTracts(), vtkProstateNavStepVerification::DisplayVerificationResultsForCurrentTarget(), vtkProstateNavFiducialCalibrationStep::EnableMarkerPositionEdit(), GetFiducialIndex(), vtkProstateNavFiducialCalibrationStep::JumpToFiducial(), vtkProstateNavLogic::LinkTargetsToFiducials(), MoveFiducialDown(), MoveFiducialUp(), vtkMeasurementsLogic::NewRulerBetweenFiducials(), PrintSelf(), vtkProstateNavStepVerification::ProcessMRMLEvents(), vtkProstateNavFiducialCalibrationStep::ProcessMRMLEvents(), vtkSlicerFiducialListWidget::ProcessMRMLEvents(), vtkMRMLFiducialListStorageNode::ReadData(), RemoveAllFiducials(), RenameFiducials(), RenumberFiducials(), SetAllFiducialsSelected(), SetAllFiducialsVisibility(), vtkSlicerFiducialsGUI::SetGUIFromList(), vtkSlicerFiducialListWidget::Update3DWidget(), vtkSlicerFiducialListWidget::Update3DWidgetColour(), vtkSlicerFiducialListWidget::Update3DWidgetGlyphType(), vtkSlicerFiducialListWidget::Update3DWidgetPositions(), vtkSlicerFiducialListWidget::Update3DWidgetSelected(), vtkSlicerFiducialListWidget::Update3DWidgetText(), vtkSlicerFiducialListWidget::Update3DWidgetVisibility(), vtkMRMLTransRectalProstateRobotNode::UpdateCalibration(), vtkProstateNavGUI::UpdateCurrentTargetDisplay(), vtkSlicerFiducialListWidget::UpdateFiducialListFromMRML(), vtkSlicerFiducialsGUI::UpdateMeasurementLabels(), vtkSlicerFiducialsGUI::UpdateRowFromNthFiducial(), vtkProstateNavLogic::UpdateTargetListFromMRML(), vtkProstateNavStepVerification::UpdateVerificationResultsForCurrentTarget(), vtkMRMLFiducialListStorageNode::WriteData(), and WriteXML().

int vtkMRMLFiducialListNode::GlyphTypeIs3D

(

)

[inline]

References GlyphTypeIs3D().

Referenced by GlyphTypeIs3D().

int vtkMRMLFiducialListNode::GlyphTypeIs3D

(

int

glyphType

)

Returns 1 if the type is a 3d one, 0 else.

References Sphere3D.

int vtkMRMLFiducialListNode::IsFiducialPresent

(

vtkMRMLFiducial *

o

)

is this fiducial on the list?

References FiducialList.

Referenced by AddFiducialWithLabelXYZSelectedVisibility(), and AddFiducialWithXYZ().

int vtkMRMLFiducialListNode::MoveFiducialDown

(

int

fidIndex

)

References FiducialIndexModifiedEvent, FiducialList, FiducialListSwappedIndices::first, GetNthFiducial(), GetNumberOfFiducials(), New(), FiducialListSwappedIndices::second, and swap().

int vtkMRMLFiducialListNode::MoveFiducialUp

(

int

fidIndex

)

move a fiducial point in the collection, one up/down returns -1 on failure (current index is out of bounds, the fid is already at the top or bottom of the list), the new fiducial index on success

References FiducialIndexModifiedEvent, FiducialList, FiducialListSwappedIndices::first, GetNthFiducial(), GetNumberOfFiducials(), New(), FiducialListSwappedIndices::second, and swap().

vtkMRMLFiducialListNode * vtkMRMLFiducialListNode::New

(

)

[static]

Reimplemented from vtkMRMLStorableNode.

References autoSlicerTracto2regions::ret.

Referenced by AddFiducial(), AddFiducialWithLabelXYZSelectedVisibility(), AddFiducialWithXYZ(), ApplyTransform(), Copy(), GetNthFiducialXYZWorld(), MoveFiducialDown(), MoveFiducialUp(), SetNthFiducialXYZWorld(), and vtkMRMLFiducialListNode().

void vtkMRMLFiducialListNode::operator=

(

const vtkMRMLFiducialListNode &

)

[protected]

Reimplemented from vtkMRMLStorableNode.

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

Reimplemented from vtkMRMLStorableNode.

References Ambient, Color, Diffuse, GetGlyphTypeAsString(), GetNthFiducial(), GetNumberingSchemeAsString(), GetNumberOfFiducials(), GlyphType, Locked, NumberingScheme, Opacity, Power, vtkMRMLFiducial::PrintSelf(), SelectedColor, Specular, SymbolScale, TextScale, and Visibility.

void vtkMRMLFiducialListNode::ProcessMRMLEvents	(	vtkObject *	caller,
		unsigned long	event,
		void *	callData
	)			[virtual]

Process events from the MRML scene.

Reimplemented from vtkMRMLStorableNode.

void vtkMRMLFiducialListNode::ReadXMLAttributes

(

const char **

atts

)

[virtual]

Set node attributes.

Reimplemented from vtkMRMLStorableNode.

References AddFiducial(), Ambient, Color, Diffuse, vtkMRMLNode::EndModify(), GetNthFiducial(), vtkMRMLNode::GetScene(), GlyphType, Locked, NumberingScheme, Opacity, Power, vtkMRMLFiducial::ReadXMLString(), SelectedColor, Specular, vtkMRMLNode::StartModify(), SymbolScale, TextScale, and Visibility.

void vtkMRMLFiducialListNode::RemoveAllFiducials

(

)

remove all fiducials from the list

References FiducialList, GetNumberOfFiducials(), vtkMRMLNode::Modified(), and vtkMRMLScene::NodeRemovedEvent.

Referenced by Copy(), vtkProstateNavStepVerification::ProcessGUIEvents(), vtkMRMLFiducialListStorageNode::ReadData(), vtkMRMLTransRectalProstateRobotNode::RemoveAllCalibrationMarkers(), vtkCollectFiducialsLogic::ResetAllFiducials(), vtkProstateNavStepVerification::StartVerification(), and vtkProstateNavStepVerification::UpdateVerificationResultsForCurrentTarget().

void vtkMRMLFiducialListNode::RemoveFiducial

(

int

i

)

remove the fiducial at index i

References FiducialList, GetNthFiducial(), and vtkMRMLScene::NodeRemovedEvent.

void vtkMRMLFiducialListNode::RemoveFiducial

(

vtkMRMLFiducial *

o

)

remove the passed in fiducial from the list

References FiducialList, and vtkMRMLScene::NodeRemovedEvent.

Referenced by vtkMeasurementsLogic::NewRulerBetweenFiducials(), vtkProstateNavTargetingStep::ProcessGUIEvents(), vtkProstateNavStepTargetingTemplate::ProcessGUIEvents(), and vtkMRMLTransRectalProstateRobotNode::UpdateCalibration().

void vtkMRMLFiducialListNode::RenameFiducials

(

const char *

newName

)

Reanme all the fiducials in the active list. It preserves any numbers already on the ends of the labels.

References GetNthFiducialLabelText(), GetNumberOfFiducials(), vtkMRMLNode::GetScene(), p, vtkMRMLScene::SaveStateForUndo(), and SetNthFiducialLabelText().

void vtkMRMLFiducialListNode::RenumberFiducials

(

int

startFrom = 0

)

Renumber all the fiducials in the active list. It first removes any numbers from the ends of the label texts and then appends numbers starting from 0 by default.

References GetNthFiducialLabelText(), GetNumberOfFiducials(), vtkMRMLNode::GetScene(), mathExample::n, p, vtkMRMLScene::SaveStateForUndo(), and SetNthFiducialLabelText().

int vtkMRMLFiducialListNode::SetAllFiducialsSelected

(

int

flag

)

Set all fiducials selected state to flag.

References FiducialModifiedEvent, GetNumberOfFiducials(), and SetNthFiducialSelectedNoModified().

int vtkMRMLFiducialListNode::SetAllFiducialsVisibility

(

int

flag

)

Set all fiducials visible state to flag.

References FiducialModifiedEvent, GetNumberOfFiducials(), and SetNthFiducialVisibilityNoModified().

Referenced by vtkProstateNavStepVerification::DisplayVerificationResultsForCurrentTarget(), vtkProstateNavFiducialCalibrationStep::HideUserInterface(), vtkSlicerFiducialsGUI::ModifyAllFiducialVisibility(), vtkSlicerFiducialsGUI::ModifyFiducialsInListVisibility(), and vtkProstateNavFiducialCalibrationStep::ShowUserInterface().

void vtkMRMLFiducialListNode::SetAmbient

(

double

val

)

Ambient of the fiducial surface expressed as a number from 0 to 1.

References Ambient, and DisplayModifiedEvent.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetColor

(

double

c[3]

)

References SetColor().

void vtkMRMLFiducialListNode::SetColor	(	double	r,
		double	g,
		double	b
	)

Get/Set for Glyph and Text color vtkSetVector3Macro(Color,double);

References Color, and DisplayModifiedEvent.

Referenced by Copy(), vtkMRMLFiducialListStorageNode::ReadData(), and SetColor().

void vtkMRMLFiducialListNode::SetDiffuse

(

double

val

)

Diffuse of the fiducial surface expressed as a number from 0 to 1.

References Diffuse, and DisplayModifiedEvent.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetFiducialLabelTextFromID

(

vtkMRMLFiducial *

fid

)

Generate the label text for a fiducial from it's id. If NumberingScheme is UseID, uses the ID (default). If NumberingScheme is UseIndex, strips the ID of any trailing numbers and appends the fiducial's index to it. If NumberingScheme is UsePrevious, checks the previous fiducial in the list for a trailing number and increments it by 1, and appends the new number. If it's the first fiducial, uses 0. If the previous fiducial has no trailing number in it's label text, will use 1.

References GetFiducialIndex(), GetNthFiducialLabelText(), NumberingScheme, UseID, UseIndex, and UsePrevious.

Referenced by AddFiducial(), and AddFiducialWithXYZ().

int vtkMRMLFiducialListNode::SetFiducialXYZ	(	std::string	fiducialID,
		float	x,
		float	y,
		float	z
	)

Restrict access to the fiducial points, access the fiducial by id (used by the vtkSlicerFiducialListWidget). Returns 0 on success.

References GetFiducialIndex(), mathExample::n, and SetNthFiducialXYZ().

void vtkMRMLFiducialListNode::SetGlyphType

(

int

type

)

The glyph type used to display this fiducial.

References DisplayModifiedEvent, and GlyphType.

Referenced by vtkMRMLFiducialListStorageNode::ReadData(), and SetGlyphTypeFromString().

void vtkMRMLFiducialListNode::SetGlyphTypeFromString

(

const char *

glyphString

)

References Arrow2D, Circle2D, Cross2D, Dash2D, Diamond2D, Diamond3D, HookedArrow2D, SetGlyphType(), Sphere3D, Square2D, StarBurst2D, ThickArrow2D, ThickCross2D, Triangle2D, and Vertex2D.

void vtkMRMLFiducialListNode::SetLocked

(

int

locked

)

When fiducial lists are locked, they cannot be manipulated using the interactive widgets.

References DisplayModifiedEvent, and Locked.

Referenced by Copy(), vtkProstateNavFiducialCalibrationStep::EnableMarkerPositionEdit(), vtkSlicerFiducialsGUI::ModifyAllLock(), vtkSlicerFiducialsGUI::ModifyListLock(), vtkMRMLFiducialListStorageNode::ReadData(), vtkProstateNavStepVerification::StartVerification(), and vtkProstateNavStepVerification::StopVerification().

int vtkMRMLFiducialListNode::SetNthFiducialID	(	int	n,
		const char *	id
	)

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkMRMLProstateNavManagerNode::AddTargetToFiducialList().

int vtkMRMLFiducialListNode::SetNthFiducialLabelText	(	int	n,
		const char *	text
	)

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkMRMLProstateNavManagerNode::AddTargetToFiducialList(), vtkProstateNavTargetingStep::OnMultiColumnListUpdate(), vtkProstateNavStepTargetingTemplate::OnMultiColumnListUpdate(), RenameFiducials(), RenumberFiducials(), vtkMRMLTransRectalProstateRobotNode::UpdateCalibration(), vtkSlicerFiducialsGUI::UpdateElement(), and vtkProstateNavStepVerification::UpdateVerificationResultsForCurrentTarget().

int vtkMRMLFiducialListNode::SetNthFiducialOrientation	(	int	n,
		float	w,
		float	x,
		float	y,
		float	z
	)

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkProstateNavTargetingStep::OnMultiColumnListUpdate(), vtkProstateNavStepTargetingTemplate::OnMultiColumnListUpdate(), and vtkSlicerFiducialsGUI::UpdateElement().

int vtkMRMLFiducialListNode::SetNthFiducialSelected	(	int	n,
		int	flag
	)

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkMRMLProstateNavManagerNode::SetFiducialColor(), vtkProstateNavGUI::UpdateCurrentTargetDisplay(), and vtkSlicerFiducialsGUI::UpdateElement().

int vtkMRMLFiducialListNode::SetNthFiducialSelectedNoModified	(	int	n,
		int	flag
	)

References GetNthFiducial().

Referenced by SetAllFiducialsSelected().

int vtkMRMLFiducialListNode::SetNthFiducialVisibility	(	int	n,
		int	flag
	)

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkMRMLProstateNavManagerNode::AddTargetToFiducialList(), and vtkSlicerFiducialsGUI::VisibilityOrLockToggleCallback().

int vtkMRMLFiducialListNode::SetNthFiducialVisibilityNoModified	(	int	n,
		int	flag
	)

References GetNthFiducial().

Referenced by SetAllFiducialsVisibility().

int vtkMRMLFiducialListNode::SetNthFiducialXYZ	(	int	n,
		float	x,
		float	y,
		float	z
	)

Restrict access to the fiducial points, pass in a value via the list so that the appropriate events can be invoked. Returns 0 on success

References FiducialModifiedEvent, and GetNthFiducial().

Referenced by vtkProstateNavStepVerification::DisplayVerificationResultsForCurrentTarget(), vtkSlicerFiducialsSeedWidgetCallback::Execute(), vtkProstateNavTargetingStep::OnMultiColumnListUpdate(), vtkProstateNavStepTargetingTemplate::OnMultiColumnListUpdate(), SetFiducialXYZ(), SetNthFiducialXYZWorld(), vtkSlicerFiducialsGUI::UpdateElement(), and vtkNeuroNavLogic::UpdateFiducialSeeding().

int vtkMRMLFiducialListNode::SetNthFiducialXYZWorld	(	int	n,
		float	x,
		float	y,
		float	z
	)

Set the nth fiducial to xyz transformed by the inverse of the transform to world for the list. Calls SetNthFiducialXYZ after transforming the passed in coordinates and returns the result of that call.

References vtkMRMLLinearTransformNode::GetMatrixTransformToWorld(), vtkMRMLTransformableNode::GetParentTransformNode(), vtkMRMLTransformNode::IsLinear(), New(), and SetNthFiducialXYZ().

void vtkMRMLFiducialListNode::SetNumberingSchemeFromString

(

const char *

schemeString

)

References UseID, UseIndex, and UsePrevious.

void vtkMRMLFiducialListNode::SetOpacity

(

double

opacity

)

Opacity of the fiducial surface expressed as a number from 0 to 1.

References DisplayModifiedEvent, and Opacity.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetPower

(

double

val

)

Power of the fiducial surface expressed as a number from 0 to 1.

References DisplayModifiedEvent, and Power.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetSelectedColor

(

double

c[3]

)

References SetSelectedColor().

void vtkMRMLFiducialListNode::SetSelectedColor	(	double	r,
		double	g,
		double	b
	)

Get/Set for colour for when a fiducial is selected.

References DisplayModifiedEvent, and SelectedColor.

Referenced by Copy(), vtkMRMLFiducialListStorageNode::ReadData(), and SetSelectedColor().

void vtkMRMLFiducialListNode::SetSpecular

(

double

val

)

Specular of the fiducial surface expressed as a number from 0 to 1.

References DisplayModifiedEvent, and Specular.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetSymbolScale

(

double

scale

)

vtkSetMacro(SymbolScale,double);

Get/Set for Symbol scale

References DisplayModifiedEvent, and SymbolScale.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetTextScale

(

double

scale

)

Get/Set for Text scale vtkSetMacro(TextScale,double);

References DisplayModifiedEvent, and TextScale.

Referenced by Copy(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::SetVisibility

(

int

visible

)

Get/Set for list visibility vtkSetMacro(Visibility,int);

References DisplayModifiedEvent, and Visibility.

Referenced by Copy(), vtkSlicerFiducialsGUI::ModifyAllListExposure(), vtkSlicerFiducialsGUI::ModifyListExposure(), and vtkMRMLFiducialListStorageNode::ReadData().

void vtkMRMLFiducialListNode::UpdateReferences

(

)

[virtual]

update display node ids

Reimplemented from vtkMRMLStorableNode.

void vtkMRMLFiducialListNode::UpdateScene

(

vtkMRMLScene *

scene

)

[virtual]

Finds the storage node and read the data

Reimplemented from vtkMRMLStorableNode.

vtkMRMLFiducialListNode::vtkGetMacro	(	NumberingScheme	,
		int
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	GlyphType	,
		int
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Locked	,
		int
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Power	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Specular	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Diffuse	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Ambient	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Opacity	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	TextScale	,
		double
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	Visibility	,
		int
	)

vtkMRMLFiducialListNode::vtkGetMacro	(	SymbolScale	,
		double
	)

vtkMRMLFiducialListNode::vtkGetVectorMacro	(	SelectedColor	,
		double	,
		3
	)

vtkMRMLFiducialListNode::vtkGetVectorMacro	(	Color	,
		double	,
		3
	)

vtkMRMLFiducialListNode::vtkSetMacro	(	NumberingScheme	,
		int
	)

Flag determining how to number the next added fiducial.

vtkMRMLFiducialListNode::vtkTypeMacro	(	vtkMRMLFiducialListNode	,
		vtkMRMLStorableNode
	)

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

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

Reimplemented from vtkMRMLStorableNode.

References Ambient, Color, Diffuse, GetNthFiducial(), GetNumberOfFiducials(), GlyphType, Locked, NumberingScheme, Opacity, Power, SelectedColor, Specular, SymbolScale, TextScale, Visibility, and vtkMRMLFiducial::WriteXML().

---

Member Data Documentation

double vtkMRMLFiducialListNode::Ambient [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetAmbient(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::Color[3] [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetColor(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::Diffuse [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetDiffuse(), vtkMRMLFiducialListNode(), and WriteXML().

vtkCollection* vtkMRMLFiducialListNode::FiducialList [protected]

The collection of fiducial points that make up this list.

Referenced by AddFiducial(), AddFiducialWithLabelXYZSelectedVisibility(), AddFiducialWithXYZ(), Copy(), GetNthFiducial(), GetNumberOfFiducials(), IsFiducialPresent(), MoveFiducialDown(), MoveFiducialUp(), RemoveAllFiducials(), RemoveFiducial(), vtkMRMLFiducialListNode(), and ~vtkMRMLFiducialListNode().

int vtkMRMLFiducialListNode::GlyphType [protected]

Referenced by GetGlyphTypeAsString(), PrintSelf(), ReadXMLAttributes(), SetGlyphType(), vtkMRMLFiducialListNode(), and WriteXML().

int vtkMRMLFiducialListNode::Locked [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetLocked(), vtkMRMLFiducialListNode(), and WriteXML().

int vtkMRMLFiducialListNode::NumberingScheme [protected]

How the next added fiducial will be numbered in it's LabelText field.

Referenced by Copy(), GetNumberingSchemeAsString(), PrintSelf(), ReadXMLAttributes(), SetFiducialLabelTextFromID(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::Opacity [protected]

Numbers relating to the display of the fiducials.

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetOpacity(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::Power [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetPower(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::SelectedColor[3] [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetSelectedColor(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::Specular [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetSpecular(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::SymbolScale [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetSymbolScale(), vtkMRMLFiducialListNode(), and WriteXML().

double vtkMRMLFiducialListNode::TextScale [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetTextScale(), vtkMRMLFiducialListNode(), and WriteXML().

int vtkMRMLFiducialListNode::Visibility [protected]

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetVisibility(), vtkMRMLFiducialListNode(), and WriteXML().

---

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

• Libs/MRML/vtkMRMLFiducialListNode.h
• Libs/MRML/vtkMRMLFiducialListNode.cxx