ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes
itk::SceneSpatialObject< TSpaceDimension > Class Template Reference

#include <itkSceneSpatialObject.h>

+ Inheritance diagram for itk::SceneSpatialObject< TSpaceDimension >:
+ Collaboration diagram for itk::SceneSpatialObject< TSpaceDimension >:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef std::list
< SpatialObjectPointer
ObjectListType
typedef SpatialObject
< TSpaceDimension > 
ObjectType
typedef SmartPointer< SelfPointer
typedef SceneSpatialObject
< TSpaceDimension > 
Self
typedef SpatialObjectType::Pointer SpatialObjectPointer
typedef SpatialObject
< TSpaceDimension > 
SpatialObjectType
typedef Object Superclass
typedef Superclass::Pointer SuperclassPointer

Public Member Functions

void AddSpatialObject (SpatialObject< TSpaceDimension > *pointer)
bool CheckIdValidity (void)
void Clear ()
bool FixHierarchy (void)
void FixIdValidity (void)
unsigned long GetMTime (void) const
int GetNextAvailableId ()
unsigned int GetNumberOfObjects (unsigned int depth=MaximumDepth, char *name=NULL)
SpatialObject< TSpaceDimension > * GetObjectById (int Id)
ObjectListTypeGetObjects (unsigned int depth=MaximumDepth, char *name=NULL)
void RemoveSpatialObject (SpatialObject< TSpaceDimension > *object)
void SetObjects (ObjectListType &children)
void SetParentId (int parentid)
int GetParentId (void)

Static Public Attributes

static const unsigned int MaximumDepth = 9999999

Protected Member Functions

void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, Indent indent) const
 SceneSpatialObject (const Self &)
 SceneSpatialObject ()
virtual ~SceneSpatialObject ()

Protected Attributes

ObjectListType m_Objects
int m_ParentId
static Pointer New ()
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const

Detailed Description

template<unsigned int TSpaceDimension = 3>
class itk::SceneSpatialObject< TSpaceDimension >

a SceneSpatialObject has a list of SpatialObjects

This class represent a SceneSpatialObject object into which one can plug any kind of spatial object.

See also:
SpatialObject

Definition at line 38 of file itkSceneSpatialObject.h.


Member Typedef Documentation

template<unsigned int TSpaceDimension = 3>
typedef SmartPointer< const Self > itk::SceneSpatialObject< TSpaceDimension >::ConstPointer

Reimplemented from itk::Object.

Definition at line 47 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef std::list< SpatialObjectPointer > itk::SceneSpatialObject< TSpaceDimension >::ObjectListType

Definition at line 53 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef SpatialObject< TSpaceDimension > itk::SceneSpatialObject< TSpaceDimension >::ObjectType

Definition at line 49 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef SmartPointer< Self > itk::SceneSpatialObject< TSpaceDimension >::Pointer

Reimplemented from itk::Object.

Definition at line 46 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef SceneSpatialObject< TSpaceDimension > itk::SceneSpatialObject< TSpaceDimension >::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Definition at line 43 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef SpatialObjectType::Pointer itk::SceneSpatialObject< TSpaceDimension >::SpatialObjectPointer

Definition at line 51 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef SpatialObject< TSpaceDimension > itk::SceneSpatialObject< TSpaceDimension >::SpatialObjectType

Definition at line 50 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef Object itk::SceneSpatialObject< TSpaceDimension >::Superclass

Reimplemented from itk::Object.

Definition at line 44 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
typedef Superclass::Pointer itk::SceneSpatialObject< TSpaceDimension >::SuperclassPointer

Definition at line 45 of file itkSceneSpatialObject.h.


Constructor & Destructor Documentation

template<unsigned int TSpaceDimension = 3>
itk::SceneSpatialObject< TSpaceDimension >::SceneSpatialObject ( const Self ) [protected]
template<unsigned int TSpaceDimension = 3>
itk::SceneSpatialObject< TSpaceDimension >::SceneSpatialObject ( ) [protected]

constructor

template<unsigned int TSpaceDimension = 3>
virtual itk::SceneSpatialObject< TSpaceDimension >::~SceneSpatialObject ( ) [protected, virtual]

destructor


Member Function Documentation

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::AddSpatialObject ( SpatialObject< TSpaceDimension > *  pointer)

Add an object to the list of children.

template<unsigned int TSpaceDimension = 3>
bool itk::SceneSpatialObject< TSpaceDimension >::CheckIdValidity ( void  )
template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::Clear ( )

Clear function : Remove all the objects in the scene

template<unsigned int TSpaceDimension = 3>
virtual::itk::LightObject::Pointer itk::SceneSpatialObject< TSpaceDimension >::CreateAnother ( void  ) const [virtual]

Method for creation through the object factory

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
bool itk::SceneSpatialObject< TSpaceDimension >::FixHierarchy ( void  )
template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::FixIdValidity ( void  )
template<unsigned int TSpaceDimension = 3>
unsigned long itk::SceneSpatialObject< TSpaceDimension >::GetMTime ( void  ) const [virtual]

Returns the latest modified time of all the objects contained in this SceneSpatialObject object.

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
virtual const char* itk::SceneSpatialObject< TSpaceDimension >::GetNameOfClass ( ) const [virtual]

Method for creation through the object factory

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
int itk::SceneSpatialObject< TSpaceDimension >::GetNextAvailableId ( )
template<unsigned int TSpaceDimension = 3>
unsigned int itk::SceneSpatialObject< TSpaceDimension >::GetNumberOfObjects ( unsigned int  depth = MaximumDepth,
char *  name = NULL 
)

Returns the number of children currently assigned to the SceneSpatialObject object.

template<unsigned int TSpaceDimension = 3>
SpatialObject< TSpaceDimension >* itk::SceneSpatialObject< TSpaceDimension >::GetObjectById ( int  Id)

Return a SpatialObject in the SceneSpatialObject given its ID

template<unsigned int TSpaceDimension = 3>
ObjectListType* itk::SceneSpatialObject< TSpaceDimension >::GetObjects ( unsigned int  depth = MaximumDepth,
char *  name = NULL 
)

Returns a list of pointer to the objects in the scene.

Warning:
This function creates a new list therefore the user is responsible for the deletion of the list.
template<unsigned int TSpaceDimension = 3>
int itk::SceneSpatialObject< TSpaceDimension >::GetParentId ( void  ) [inline]

Get/Set the ParentID

Definition at line 92 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
static Pointer itk::SceneSpatialObject< TSpaceDimension >::New ( ) [static]

Method for creation through the object factory

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::operator= ( const Self ) [protected]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
virtual void itk::SceneSpatialObject< TSpaceDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Print the object informations in a stream.

Reimplemented from itk::Object.

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::RemoveSpatialObject ( SpatialObject< TSpaceDimension > *  object)

Remove the object passed as arguments from the list of children. May this function should return a false value if the object to remove is not found in the list.

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::SetObjects ( ObjectListType children)

Set the list of pointers to children to the list passed as argument.

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::SetParentId ( int  parentid) [inline]

Get/Set the ParentID

Definition at line 91 of file itkSceneSpatialObject.h.


Member Data Documentation

template<unsigned int TSpaceDimension = 3>
ObjectListType itk::SceneSpatialObject< TSpaceDimension >::m_Objects [protected]

List of the children object plug to the SceneSpatialObject spatial object.

Definition at line 115 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
int itk::SceneSpatialObject< TSpaceDimension >::m_ParentId [protected]

Parent ID : default = -1

Definition at line 127 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
const unsigned int itk::SceneSpatialObject< TSpaceDimension >::MaximumDepth = 9999999 [static]

Definition at line 55 of file itkSceneSpatialObject.h.


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