igstk::TubeObject Class Reference

This class represents a Tube object. More...

#include <igstkTubeObject.h>

Inheritance diagram for igstk::TubeObject:
Inheritance graph
[legend]
Collaboration diagram for igstk::TubeObject:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
TubeSpatialObjectType::PointListType 
PointListType

Public Member Functions

void AddPoint (PointType &point)
 Add a point to the tube.
unsigned int GetNumberOfPoints (void) const
 Return the number of points in the tube.
const PointTypeGetPoint (unsigned int pointId) const
 Return a given point.
const PointListType GetPoints () const
 Return the internal list of points.
void Clear (void)
 Remove all the points in the list.

Public Attributes

igstkStandardClassTraitsMacro(TubeObject,
SpatialObject) public typedef
TubeSpatialObjectType::TubePointType 
PointType
 Macro with standard traits declarations.

Protected Member Functions

 TubeObject (void)
 The TubeReaderToTubeSpatialObject class is declared as a friend in order to be able to set the input mesh.
 ~TubeObject (void)
 Destructor.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information.

Detailed Description

This class represents a Tube object.

The tube is basically defined by a set of points representing its centerline. Each point as a position and an associated radius value.

Definition at line 42 of file igstkTubeObject.h.


Member Typedef Documentation

typedef TubeSpatialObjectType::PointListType igstk::TubeObject::PointListType

Definition at line 56 of file igstkTubeObject.h.


Constructor & Destructor Documentation

igstk::TubeObject::TubeObject ( void   )  [protected]

The TubeReaderToTubeSpatialObject class is declared as a friend in order to be able to set the input mesh.

Constructor

igstk::TubeObject::~TubeObject ( void   )  [protected]

Destructor.


Member Function Documentation

void igstk::TubeObject::AddPoint ( PointType point  ) 

Add a point to the tube.

unsigned int igstk::TubeObject::GetNumberOfPoints ( void   )  const

Return the number of points in the tube.

const PointType* igstk::TubeObject::GetPoint ( unsigned int  pointId  )  const

Return a given point.

const PointListType igstk::TubeObject::GetPoints (  )  const

Return the internal list of points.

void igstk::TubeObject::Clear ( void   ) 

Remove all the points in the list.

virtual void igstk::TubeObject::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [protected, virtual]

Print object information.

Reimplemented from igstk::SpatialObject.


Member Data Documentation

igstkStandardClassTraitsMacro ( TubeObject, SpatialObject ) public typedef TubeSpatialObjectType::TubePointType igstk::TubeObject::PointType

Macro with standard traits declarations.

Internal typedef

Definition at line 49 of file igstkTubeObject.h.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 11:06:52 2010 for IGSTK by  doxygen 1.6.3