itk::Scene< PipelineDimension > Class Template Reference

a Scene has a list of NDimensionalSpatialObjects. More...

#include <itkScene.h>

Inheritance diagram for itk::Scene:

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

[legend]List of all members.

[NOHEADER]
virtual const char *	GetClassName () const
Pointer	New ()
Public Types
typedef Scene< PipelineDimension >	Self
typedef Object	Superclass
typedef Superclass::Pointer	SuperclassPointer
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef std::list< NDimensionalSpatialObject<> * >	ObjectListType
Public Methods
void	AddSpatialObject (NDimensionalSpatialObject<> *pointer)
void	RemoveSpatialObject (NDimensionalSpatialObject<> *object)
ObjectListType &	GetObjects (void)
unsigned int	GetNumberOfObjects (void)
void	SetObjects (ObjectListType &children)
unsigned long	GetMTime (void) const
NDimensionalSpatialObject *	GetObjectById (int Id)
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 PipelineDimension = 3>
class itk::Scene< PipelineDimension >

a Scene has a list of NDimensionalSpatialObjects.

This class represent a Scene object to which it's possible to plug any kind of spatial object.

\also SpatialObject

Definition at line 38 of file itkScene.h.

---

Member Typedef Documentation

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

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

template<unsigned int PipelineDimension = 3> typedef std::list< NDimensionalSpatialObject<> * > itk::Scene< PipelineDimension >::ObjectListType

Definition at line 50 of file itkScene.h.

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

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

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

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

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

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

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

Definition at line 46 of file itkScene.h.

---

Constructor & Destructor Documentation

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

constructor

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

destructor

---

Member Function Documentation

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

Add an object to the list of children.

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

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

template<unsigned int PipelineDimension = 3> unsigned long itk::Scene< PipelineDimension >::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 PipelineDimension = 3> unsigned int itk::Scene< PipelineDimension >::GetNumberOfObjects (  void    )

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

template<unsigned int PipelineDimension = 3> NDimensionalSpatialObject* itk::Scene< PipelineDimension >::GetObjectById (  int    Id )

Return a SpatialObject in the scene given its ID

template<unsigned int PipelineDimension = 3> ObjectListType& itk::Scene< PipelineDimension >::GetObjects (  void    )

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

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

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

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

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

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

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

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

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

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

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

---

Member Data Documentation

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

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

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

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

---

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

• itkScene.h

---