ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
itk::SceneSpatialObject< TSpaceDimension > Class Template Reference

#include <itkSceneSpatialObject.h>

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

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
Examples:
Examples/SpatialObjects/SceneSpatialObject.cxx.

Definition at line 38 of file itkSceneSpatialObject.h.

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 Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void AddSpatialObject (SpatialObject< TSpaceDimension > *pointer)
 
bool CheckIdValidity ()
 
void Clear ()
 
bool FixHierarchy ()
 
void FixIdValidity ()
 
virtual ModifiedTimeType GetMTime (void) const override
 
int GetNextAvailableId ()
 
unsigned int GetNumberOfObjects (unsigned int depth=MaximumDepth, char *name=nullptr)
 
SpatialObject< TSpaceDimension > * GetObjectById (int Id)
 
ObjectListTypeGetObjects (unsigned int depth=MaximumDepth, char *name=nullptr)
 
void RemoveSpatialObject (SpatialObject< TSpaceDimension > *object)
 
void SetObjects (ObjectListType &children)
 
void SetParentId (int parentid)
 
int GetParentId (void)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

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 override
 
 SceneSpatialObject (const Self &)
 
 SceneSpatialObject ()
 
virtual ~SceneSpatialObject ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ObjectListType m_Objects
 
int m_ParentId
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
static Pointer New ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Member Typedef Documentation

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

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

Definition at line 46 of file itkSceneSpatialObject.h.

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

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

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 ( )
protectedvirtual

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 ( )
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 ( ) const
virtual

Method for creation through the object factory

Reimplemented from itk::Object.

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

In practice, this is used to transform an imported MetaIO scene hierarchy specified only by Ids into the SceneSpatialObject hierarchy specified by Ids and Child/Parent lists.

template<unsigned int TSpaceDimension = 3>
void itk::SceneSpatialObject< TSpaceDimension >::FixIdValidity ( )
template<unsigned int TSpaceDimension = 3>
virtual ModifiedTimeType itk::SceneSpatialObject< TSpaceDimension >::GetMTime ( void  ) const
overridevirtual

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 = nullptr 
)

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 = nullptr 
)

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.

References itk::SceneSpatialObject< TSpaceDimension >::m_ParentId.

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

Method for creation through the object factory

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

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.

References itk::SceneSpatialObject< TSpaceDimension >::m_ParentId.

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 118 of file itkSceneSpatialObject.h.

template<unsigned int TSpaceDimension = 3>
int itk::SceneSpatialObject< TSpaceDimension >::m_ParentId
protected
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: