itkLineSpatialObject.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkLineSpatialObject.h,v $
  Language:  C++
  Date:      $Date: 2009-04-07 14:34:04 $
  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 __itkLineSpatialObject_h
#define __itkLineSpatialObject_h

#include <list>

#include "itkPointBasedSpatialObject.h"
#include "itkLineSpatialObjectPoint.h"

namespace itk 
{

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

public:

  typedef LineSpatialObject                           Self;
  typedef PointBasedSpatialObject< TDimension >       Superclass;
  typedef SmartPointer < Self >                       Pointer;
  typedef SmartPointer < const Self >                 ConstPointer;
  typedef double                                      ScalarType;
  typedef LineSpatialObjectPoint< TDimension >        LinePointType;
  typedef std::vector< LinePointType >                PointListType;
  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;

  itkNewMacro( Self );

  itkTypeMacro( LineSpatialObject, PointBasedSpatialObject );

  PointListType & GetPoints( void );

  void SetPoints( PointListType & newPoints );

  const SpatialObjectPointType* GetPoint(unsigned long id) const 
    {
    return &(m_Points[id]);
    }

  SpatialObjectPointType* GetPoint(unsigned long id) {return &(m_Points[id]);}

  unsigned long GetNumberOfPoints(void) const {return m_Points.size();}

  bool IsEvaluableAt( const PointType & point, 
                      unsigned int depth=0, char * name=NULL ) const;

  bool ValueAt( const PointType & point, double & value,
                unsigned int depth=0, char * name=NULL ) const;

  bool IsInside( const PointType & point, 
                 unsigned int depth, char * name) const;

  virtual bool IsInside( const PointType & point) const;

  bool ComputeLocalBoundingBox() const;

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

  LineSpatialObject();
  virtual ~LineSpatialObject();

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

} // end namespace itk

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

#endif // __itkLineSpatialObject_h