itk::Scene< SpaceDimension > Class Template Reference

a Scene has a list of SpatialObjects. More...

#include <itkScene.h>

Inheritance diagram for itk::Scene:

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

[legend]List of all members.

[NOHEADER]
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef Scene< 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 std::list< SpatialObject< SpaceDimension > * >	ObjectListType
Public Methods
	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 Methods
	Scene ()
virtual	~Scene ()
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::Scene< SpaceDimension >

a Scene has a list of SpatialObjects.

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

\also SpatialObject

Definition at line 38 of file itkScene.h.

---

Member Typedef Documentation

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

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

template<unsigned int SpaceDimension = 3> typedef std::list< SpatialObject<SpaceDimension> * > itk::Scene< SpaceDimension >::ObjectListType

Definition at line 54 of file itkScene.h.

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

Definition at line 50 of file itkScene.h.

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

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

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

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

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

Definition at line 51 of file itkScene.h.

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

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

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

Definition at line 46 of file itkScene.h.

---

Constructor & Destructor Documentation

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

constructor

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

destructor

---

Member Function Documentation

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

Add an object to the list of children.

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

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

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

template<unsigned int SpaceDimension = 3> unsigned long itk::Scene< SpaceDimension >::GetMTime (  void    )  const [virtual]

Returns the latest modified time of all the objects contained in this Scene object. Reimplemented from itk::Object.

template<unsigned int SpaceDimension = 3> unsigned int itk::Scene< SpaceDimension >::GetNumberOfObjects (  unsigned int    depth = MaximumDepth, char *    name = NULL )

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

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

Return a SpatialObject in the scene given its ID

template<unsigned int SpaceDimension = 3> ObjectListType* itk::Scene< 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::Scene< SpaceDimension >::GetParentId (  void    )  [inline]

Get/Set the ParentID Definition at line 89 of file itkScene.h. References itk::Scene< SpaceDimension >::m_Objects, and itk::Scene< SpaceDimension >::m_ParentId.

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

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

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

template<unsigned int SpaceDimension = 3> virtual void itk::Scene< 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::Scene< 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::Scene< SpaceDimension >::SetObjects (  ObjectListType &    children )

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

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

Get/Set the ParentID Definition at line 88 of file itkScene.h. References itk::Scene< SpaceDimension >::m_ParentId.

---

Member Data Documentation

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

List of the children object plug to the Scene spatial object. Definition at line 100 of file itkScene.h. Referenced by itk::Scene< SpaceDimension >::GetParentId().

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

Parent ID : default = -1 Definition at line 112 of file itkScene.h. Referenced by itk::Scene< SpaceDimension >::GetParentId(), and itk::Scene< SpaceDimension >::SetParentId().

---

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

• itkScene.h

---