itk::SceneSpatialObject< SpaceDimension > Class Template Reference

a SceneSpatialObject has a list of SpatialObjects More...

#include <itkSceneSpatialObject.h>

Inheritance diagram for itk::SceneSpatialObject< SpaceDimension >:

[legend]Collaboration diagram for itk::SceneSpatialObject< SpaceDimension >:

[legend]List of all members.

[NOHEADER]
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef SceneSpatialObject< SpaceDimension >	Self
typedef Object	Superclass
typedef Superclass::Pointer	SuperclassPointer
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef SpatialObject< SpaceDimension >	ObjectType
typedef SpatialObject< SpaceDimension >	SpatialObjectType
typedef SpatialObjectType::Pointer	SpatialObjectPointer
typedef std::list< SpatialObjectPointer >	ObjectListType
Public Member Functions
	itkStaticConstMacro (MaximumDepth, unsigned int, 9999999)
void	AddSpatialObject (SpatialObject< SpaceDimension > *pointer)
void	RemoveSpatialObject (SpatialObject< SpaceDimension > *object)
ObjectListType *	GetObjects (unsigned int depth=MaximumDepth, char *name=NULL)
unsigned int	GetNumberOfObjects (unsigned int depth=MaximumDepth, char *name=NULL)
void	SetObjects (ObjectListType &children)
unsigned long	GetMTime (void) const
SpatialObject< SpaceDimension > *	GetObjectById (int Id)
bool	FixHierarchy (void)
void	SetParentId (int parentid)
int	GetParentId (void)
Protected Member Functions
	SceneSpatialObject ()
virtual	~SceneSpatialObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
ObjectListType	m_Objects
int	m_ParentId

---

Detailed Description

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

a SceneSpatialObject has a list of SpatialObjects

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

SpatialObject

Definition at line 38 of file itkSceneSpatialObject.h.

---

Member Typedef Documentation

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

Reimplemented from itk::Object. Definition at line 48 of file itkSceneSpatialObject.h.

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

Definition at line 55 of file itkSceneSpatialObject.h.

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

Definition at line 50 of file itkSceneSpatialObject.h.

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

Reimplemented from itk::Object. Definition at line 47 of file itkSceneSpatialObject.h.

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

Smart pointer typedef support. Reimplemented from itk::Object. Definition at line 44 of file itkSceneSpatialObject.h.

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

Definition at line 52 of file itkSceneSpatialObject.h.

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

Definition at line 51 of file itkSceneSpatialObject.h.

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

Reimplemented from itk::Object. Definition at line 45 of file itkSceneSpatialObject.h.

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

Definition at line 46 of file itkSceneSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int SpaceDimension = 3> itk::SceneSpatialObject< SpaceDimension >::SceneSpatialObject (   )  [protected]

constructor

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

destructor

---

Member Function Documentation

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

Add an object to the list of children.

template<unsigned int SpaceDimension = 3> bool itk::SceneSpatialObject< SpaceDimension >::FixHierarchy (  void   )

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

Standard part of all itk objects. Reimplemented from itk::Object.

template<unsigned int SpaceDimension = 3> unsigned long itk::SceneSpatialObject< SpaceDimension >::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 SpaceDimension = 3> unsigned int itk::SceneSpatialObject< SpaceDimension >::GetNumberOfObjects (  unsigned int  depth = MaximumDepth, char *  name = NULL )

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

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

Return a SpatialObject in the SceneSpatialObject given its ID

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

Returns a list of pointer to the children affiliated to this object.

template<unsigned int SpaceDimension = 3> int itk::SceneSpatialObject< SpaceDimension >::GetParentId (  void   )  [inline]

Get/Set the ParentID Definition at line 90 of file itkSceneSpatialObject.h.

template<unsigned int SpaceDimension = 3> itk::SceneSpatialObject< SpaceDimension >::itkStaticConstMacro (  MaximumDepth  , unsigned  int, 9999999  )

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

Method for creation through the object factory Reimplemented from itk::Object.

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

Print the object informations in a stream. Reimplemented from itk::Object.

template<unsigned int SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::RemoveSpatialObject (  SpatialObject< SpaceDimension > *  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 SpaceDimension = 3> void itk::SceneSpatialObject< SpaceDimension >::SetObjects (  ObjectListType &  children  )

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

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

Get/Set the ParentID Definition at line 89 of file itkSceneSpatialObject.h.

---

Member Data Documentation

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

List of the children object plug to the SceneSpatialObject spatial object. Definition at line 101 of file itkSceneSpatialObject.h.

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

Parent ID : default = -1 Definition at line 113 of file itkSceneSpatialObject.h.

---

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

• itkSceneSpatialObject.h

---