IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
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]

Public Types

typedef
TubeSpatialObjectType::PointListType 
PointListType
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Public Member Functions

void AddPoint (PointType &point)
 Add a point to the tube. More...
 
unsigned int GetNumberOfPoints (void) const
 Return the number of points in the tube. More...
 
const PointTypeGetPoint (unsigned int pointId) const
 Return a given point. More...
 
const PointListType GetPoints () const
 Return the internal list of points. More...
 
void Clear (void)
 Remove all the points in the list. More...
 
- Public Member Functions inherited from igstk::SpatialObject
 igstkLoadedObjectEventMacro (BoundingBoxEvent, IGSTKEvent, BoundingBoxType)
 
void RequestGetBounds ()
 
void RequestGetBounds () const
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardClassTraitsMacro(TubeObject,
SpatialObject) public typedef
TubeSpatialObjectType::TubePointType 
PointType
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::SpatialObject
igstkStandardClassTraitsMacro(SpatialObject,
Object) public typedef
SpatialObjectType::BoundingBoxType 
BoundingBoxType
 Macro with standard traits declarations. More...
 

Protected Member Functions

 TubeObject (void)
 The TubeReaderToTubeSpatialObject class is declared as a friend in order to be able to set the input mesh. More...
 
 ~TubeObject (void)
 Destructor. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print object information. More...
 
- Protected Member Functions inherited from igstk::SpatialObject
 SpatialObject (void)
 The constructor of this class is declared protected to enforce the use of SmartPointers syntax when instantiating objects of this class. More...
 
 ~SpatialObject (void)
 The destructor should be overriden in derived classes that allocate memory for member variables. More...
 
void RequestSetInternalSpatialObject (SpatialObjectType *object)
 Replacement for RequestSetSpatialObject(). More...
 
SpatialObjectType * GetInternalSpatialObject () const
 Returns the ITK spatial object that is contained inside this IGSTK spatial object. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~Object (void)
 
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 

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
protectedvirtual

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: