SignFiducialCollection Class Reference

#include <SignFiducialCollection.h>

List of all members.

Detailed Description

Class containing all fiducials belonging to one scene object (volume, model, ...).

The SignFiducialCollection class collects all fiducials that belong to one specific object in the MRML scene. This object can be a volume, a model, or anything else that is a subclass of MrmlVirtualObjectNode. Methods to add, delete, and update fiducials are provided.

Author:
Eigil Samset and Arne Hans


Public Member Functions

 SignFiducialCollection ()
 Constructor.
 ~SignFiducialCollection ()
 Destructor.
SignFiducial * AddFiducial (float x, float y, float z)
SignFiducial * AddFiducial (float x, float y, float z, int newID)
SignFiducial * AddFiducial (float *P)
SignFiducial * AddFiducial (float x, float y, float z, vtkKWFrame *menu)
SignFiducial * AddFiducial (float x, float y, float z, vtkKWFrame *menu, const char *name)
SignFiducial * AddFiducial (float x, float y, float z, vtkKWFrame *menu, const char *name, int newID)
int GetNumberOfFiducials ()
 Get the number of fiducial stored in this collection.
int DeleteFiducial (int id)
void DeleteFiducialAndGUI (SignFiducial *fiducial)
void SetParentNode (vtkMRMLNode *parent)
vtkMRMLNode * GetParentNode ()
 Get the parent MRML node for this fiducial collection.
void UpdateFiducials (Sign2DViewer *viewer)

Public Attributes

bool hasActors
 hasActors is true if this fiducial collection has any 2D or 3D markers, i.e. if it belongs to a volume.
FiducialVector Fiducials
 Vector of all fiducials in this collection.

Constructor & Destructor Documentation

SignFiducialCollection::SignFiducialCollection (   ) 
 

Constructor.

SignFiducialCollection::~SignFiducialCollection (   ) 
 

Destructor.

Member Function Documentation

SignFiducial * SignFiducialCollection::AddFiducial (  float  x,
float  y,
float  z,
vtkKWFrame *  menu,
const char *  name,
int  newID
) 
 

Coordinates have to be world coordinates.

Parameters:
x x coordinate
y y coordinate
z z coordinate
menu vtkKWFrame where the name of the fiducial and the delete button will be added
name name of the new fiducial
newID predefined ID of the new fiducial, must be unique

SignFiducial * SignFiducialCollection::AddFiducial (  float  x,
float  y,
float  z,
vtkKWFrame *  menu,
const char *  name
) 
 

Coordinates have to be world coordinates. The ID of the new fiducial will be generated automatically.

Parameters:
x x coordinate
y y coordinate
z z coordinate
menu vtkKWFrame where the name of the fiducial and the delete button will be added
name name of the new fiducial

SignFiducial * SignFiducialCollection::AddFiducial (  float  x,
float  y,
float  z,
vtkKWFrame *  menu
) 
 

Coordinates have to be world coordinates. Name and ID of the new fiducial will be generated automatically.

Parameters:
x x coordinate
y y coordinate
z z coordinate
menu vtkKWFrame where the name of the fiducial and the delete button will be added

SignFiducial * SignFiducialCollection::AddFiducial (  float *  P  ) 
 

Coordinates have to be world coordinates. Name and IF of the new fiducial will be generated automatically.

Parameters:
P pointer to a float[3] array of coordinates

SignFiducial * SignFiducialCollection::AddFiducial (  float  x,
float  y,
float  z,
int  newID
) 
 

Coordinates have to be world coordinates. The name of the new fiducial will be generated automatically.

Parameters:
x x coordinate
y y coordinate
z z coordinate
newID predefined ID of the new fiducial, must be unique

SignFiducial * SignFiducialCollection::AddFiducial (  float  x,
float  y,
float  z
) 
 

Coordinates have to be world coordinates. Name and ID of the new fiducial will be generated automatically.

Parameters:
x x coordinate
y y coordinate
z z coordinate

int SignFiducialCollection::DeleteFiducial (  int  id  ) 
 

Remove a fiducial from this collection.

Parameters:
id ID of the fiducial to be deleted

void SignFiducialCollection::DeleteFiducialAndGUI (  SignFiducial *  fiducial  ) 
 

Remove a fiducial from this collection and remove its label and button from the GUI.

Parameters:
fiducial fiducial to be deleted

int SignFiducialCollection::GetNumberOfFiducials (   ) 
 

Get the number of fiducial stored in this collection.

vtkMRMLNode * SignFiducialCollection::GetParentNode (   ) 
 

Get the parent MRML node for this fiducial collection.

void SignFiducialCollection::SetParentNode (  vtkMRMLNode *  parent  ) 
 

Set the parent MRML node for this fiducial collection.

Parameters:
parent MRML node

void SignFiducialCollection::UpdateFiducials (  Sign2DViewer *  viewer  ) 
 

Update all markers for fiducials in this collection in the specified 2D viewer.

Parameters:
viewer 2D viewer that will be updated

Member Data Documentation

FiducialVector SignFiducialCollection::Fiducials
 

Vector of all fiducials in this collection.

bool SignFiducialCollection::hasActors
 

hasActors is true if this fiducial collection has any 2D or 3D markers, i.e. if it belongs to a volume.

The documentation for this class was generated from the following files:
Generated on Mon Feb 26 12:13:10 2007 for TheSIGN by  doxygen 1.4.6