itkSceneSpatialObject.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef __itkSceneSpatialObject_h
#define __itkSceneSpatialObject_h

#include "itkSpatialObject.h"

#include <list>

namespace itk
{
template< unsigned int TSpaceDimension = 3 >
class ITK_EXPORT 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);

  ModifiedTimeType 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.hxx"
#endif

#endif // __SceneSpatialObject_h