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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkContourSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2006/04/28 14:40:06 $
  Version:   $Revision: 1.3 $

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

#include <list>

#include "itkPointBasedSpatialObject.h"
#include "itkSpatialObjectPoint.h"
#include "itkContourSpatialObjectPoint.h"

namespace itk 
{

/** 
* \class ContourSpatialObject
* \brief Representation of a Contour based on the spatial object classes.
*
* The Contour is basically defined by a set of points which are inside this blob
*
* \sa SpatialObjectPoint
*/

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

public:

  typedef ContourSpatialObject                     Self;
  typedef PointBasedSpatialObject< TDimension>     Superclass;
  typedef SmartPointer < Self >                    Pointer;
  typedef SmartPointer < const Self >              ConstPointer;
  typedef double                                   ScalarType;
  typedef ContourSpatialObjectPoint< TDimension >  ControlPointType;
  typedef SpatialObjectPoint< TDimension >         InterpolatedPointType;
  typedef std::vector < ControlPointType >         ControlPointListType;
  typedef std::vector < InterpolatedPointType >    InterpolatedPointListType;

  typedef typename Superclass::SpatialObjectPointType SpatialObjectPointType;
  typedef typename Superclass::PointType              PointType;
  typedef typename Superclass::TransformType          TransformType;
  typedef typename Superclass::BoundingBoxType        BoundingBoxType;
  typedef VectorContainer<unsigned long,PointType>    PointContainerType;
  typedef SmartPointer<PointContainerType>            PointContainerPointer;

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

  /** Method for creation through the object factory. */
  itkTypeMacro( ContourSpatialObject, PointBasedSpatialObject );
  
  /** Returns a reference to the list of the control points. */
  ControlPointListType & GetControlPoints( void );

  /** Returns a reference to the list of the control points. */
  const ControlPointListType & GetControlPoints( void ) const;

  /** Set the list of control points.*/
  void SetControlPoints( ControlPointListType & newPoints );

  /** Return a control point in the list given the index */
  const ControlPointType* GetControlPoint(unsigned long id) const 
    {return &(m_ControlPoints[id]);}

  /** Return a control point in the list given the index */
  ControlPointType* GetControlPoint(unsigned long id) 
    {return &(m_ControlPoints[id]);}
  
  /** Return the number of control points in the list */
  unsigned long GetNumberOfControlPoints(void) const 
    {return m_ControlPoints.size();}

  /** Returns a reference to the list of the interpolated points. */
  InterpolatedPointListType & GetInterpolatedPoints( void );

  /** Returns a reference to the list of the interpolated points. */
  const InterpolatedPointListType & GetInterpolatedPoints( void ) const;

  /** Set the list of interpolated points.*/
  void SetInterpolatedPoints( InterpolatedPointListType & newPoints );

  /** Return a interpolated point in the list given the index */
  const InterpolatedPointType* GetInterpolatedPoint(unsigned long id) const 
    {return &(m_InterpolatedPoints[id]);}

  /** Return a interpolated point in the list given the index */
  InterpolatedPointType* GetInterpolatedPoint(unsigned long id) 
    {return &(m_InterpolatedPoints[id]);}
  
  /** Return the number of interpolated points in the list */
  unsigned long GetNumberOfInterpolatedPoints(void) const 
    {return m_InterpolatedPoints.size();}

  enum InterpolationType {NO_INTERPOLATION=0,
    EXPLICIT_INTERPOLATION, BEZIER_INTERPOLATION, 
    LINEAR_INTERPOLATION
    };

  /** Set/Get the interpolation type */
  InterpolationType GetInterpolationType() const
    { return m_InterpolationType; }
  void SetInterpolationType(InterpolationType interpolation)
    {m_InterpolationType = interpolation;}

  /** Set/Get if the contour is closed */
  itkSetMacro(Closed,bool);
  itkGetConstMacro(Closed,bool);

  /** Set/Get the display orientation of the contour */
  itkSetMacro(DisplayOrientation,int);
  itkGetConstMacro(DisplayOrientation,int);

  /** Set/Get the slice attached to the contour if any
   *  -1 is returned if no contour attached*/
  itkSetMacro(AttachedToSlice,int);
  itkGetConstMacro(AttachedToSlice,int);

  /** Returns true if the Contour 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 Contour at that point.
   *  Currently this function returns a binary value,
   *  but it might want to return a degree of membership
   *  in case of fuzzy Contours. */
  bool ValueAt( const PointType & point, double & value,
                unsigned int depth=0, char *name = NULL ) const;

  /** Returns true if the point is inside the Contour, 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 Contour. */
  bool ComputeLocalBoundingBox( void ) const;

protected:

  ControlPointListType        m_ControlPoints;
  InterpolatedPointListType   m_InterpolatedPoints;
  InterpolationType           m_InterpolationType;
  bool                        m_Closed;
  int                         m_DisplayOrientation;
  long int                    m_AttachedToSlice;

  ContourSpatialObject();
  virtual ~ContourSpatialObject();

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

} // end namespace itk

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

#endif // __itkContourSpatialObject_h
