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

  Program:   Insight Segmentation & Registration Toolkit
  Module:  $RCSfile: itkSurfaceSpatialObject.h,v $
  Language:  C++
  Date:    $Date: 2007/01/28 19:24:57 $
  Version:   $Revision: 1.25 $

  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 __itkSurfaceSpatialObject_h
#define __itkSurfaceSpatialObject_h

#include <list>

#include "itkPointBasedSpatialObject.h"
#include "itkSurfaceSpatialObjectPoint.h"

namespace itk 
{

/** 
* \class SurfaceSpatialObject
* \brief Representation of a Surface based on the spatial object classes.
*
* The Surface is basically defined by a set of points. 
*
* \sa SurfaceSpatialObjectPoint
*/

template < unsigned int TDimension = 3 >
class SurfaceSpatialObject 
  :public PointBasedSpatialObject<  TDimension >
{

public:

  typedef SurfaceSpatialObject                          Self;
  typedef PointBasedSpatialObject< TDimension >         Superclass;
  typedef SmartPointer < Self >                         Pointer;
  typedef SmartPointer < const Self >                   ConstPointer;
  typedef double                                        ScalarType;
  typedef SurfaceSpatialObjectPoint< TDimension >       SurfacePointType;
  typedef std::vector< SurfacePointType >               PointListType;
  typedef typename Superclass::SpatialObjectPointType   SpatialObjectPointType;
  typedef typename Superclass::PointType                PointType;
  typedef typename Superclass::TransformType            TransformType;
  typedef VectorContainer<unsigned long,PointType>      PointContainerType;
  typedef SmartPointer<PointContainerType>              PointContainerPointer;
  typedef typename Superclass::BoundingBoxType          BoundingBoxType;
  typedef typename Superclass::CovariantVectorType      CovariantVectorType;

  /** Method for creation through the object factory.*/
  itkNewMacro( Self );

  /** Method for creation through the object factory. */
  itkTypeMacro( SurfaceSpatialObject, PointBasedSpatialObject );
  
  /** Returns a reference to the list of the Surface points. */
  PointListType & GetPoints( void );
  
  /** Return a point in the list given the index */
  const SpatialObjectPointType* GetPoint(unsigned long id) const 
    {
    return &(m_Points[id]);
    }

  /** Return a point in the list given the index */
  SpatialObjectPointType* GetPoint(unsigned long id) {return &(m_Points[id]);}
  
  /** Return the number of points in the list */
  unsigned long GetNumberOfPoints(void) const {return m_Points.size();}

  /** Set the list of Surface points. */
  void SetPoints( PointListType & newPoints );

  /** Returns true if the Surface is evaluable at the requested point, 
   * false otherwise. */
  bool IsEvaluableAt( const PointType & point,
                      unsigned int depth=0, char * name=NULL) const;

  /** Returns the value of the Surface at that point.
   *  Currently this function returns a binary value,
   *  but it might want to return a degree of membership
   *  in case of fuzzy Surfaces. */
  bool ValueAt( const PointType & point, double & value,
                unsigned int depth=0, char * name=NULL) const;

  /** Returns true if the point is inside the Surface, false otherwise. */
  bool IsInside( const PointType & point,
                 unsigned int depth, char * name) const;

  /** Test whether a point is inside or outside the object 
   *  For computational speed purposes, it is faster if the method does not
   *  check the name of the class and the current depth */ 
  virtual bool IsInside( const PointType & point) const;

  /** Compute the boundaries of the Surface. */
  bool ComputeLocalBoundingBox( ) const;

  /** Compute the normals to the surface from neighboring points */
  bool Approximate3DNormals();

protected:
  SurfaceSpatialObject(const Self&); //purposely not implemented
  void operator=(const Self&); //purposely not implemented
   
  PointListType  m_Points;

  SurfaceSpatialObject();
  virtual ~SurfaceSpatialObject();

  /** Method to print the object.*/
  virtual void PrintSelf( std::ostream& os, Indent indent ) const;
};

} // end namespace itk

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

#endif // __itkSurfaceSpatialObject_h
