itkSceneSpatialObject.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSceneSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2009-01-28 20:10:27 $
  Version:   $Revision: 1.11 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
 
#ifndef __itkSceneSpatialObject_h 
#define __itkSceneSpatialObject_h 

#include "itkSpatialObject.h"  
 
#include <list>

namespace itk 
{ 

template <unsigned int TSpaceDimension = 3>
class SceneSpatialObject 
  : public Object
{ 
 
public: 

  typedef SceneSpatialObject<TSpaceDimension> Self; 
  typedef Object                              Superclass; 
  typedef Superclass::Pointer                 SuperclassPointer; 
  typedef SmartPointer< Self >                Pointer; 
  typedef SmartPointer< const Self >          ConstPointer; 

  typedef SpatialObject<TSpaceDimension>      ObjectType;
  typedef SpatialObject<TSpaceDimension>      SpatialObjectType;
  typedef typename SpatialObjectType::Pointer SpatialObjectPointer;

  typedef std::list< SpatialObjectPointer > 
  ObjectListType; 
     
  itkStaticConstMacro(MaximumDepth, unsigned int, 9999999);

  itkNewMacro(Self); 
  itkTypeMacro(SceneSpatialObject, Object); 

  void AddSpatialObject( SpatialObject<TSpaceDimension> * pointer ); 

  void RemoveSpatialObject( SpatialObject<TSpaceDimension> * 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;

  void SetParentId(int parentid) {m_ParentId=parentid;}
  int  GetParentId(void) {return m_ParentId;}

  SpatialObject<TSpaceDimension> * GetObjectById(int Id);

  bool FixHierarchy(void);
  bool CheckIdValidity(void);
  void FixIdValidity(void);
  int GetNextAvailableId();

  void Clear();

protected: 
  SceneSpatialObject(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented

  ObjectListType m_Objects; 

  SceneSpatialObject(); 

  virtual ~SceneSpatialObject();

  virtual void PrintSelf( std::ostream& os, Indent indent ) const;

  int m_ParentId;

}; 

} // end of namespace itk
 

#ifndef ITK_MANUAL_INSTANTIATION 
#include "itkSceneSpatialObject.txx" 
#endif 

#endif // __SceneSpatialObject_h