itkSpatialObjectPoint.h

Go to the documentation of this file.

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

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkSpatialObjectPoint.h,v $
  Language:  C++
  Date:      $Date: 2009-04-07 14:34:17 $
  Version:   $Revision: 1.16 $

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

#include "itkPoint.h"
#include "vnl/vnl_vector_fixed.h"
#include "itkRGBAPixel.h"

namespace itk 
{

template < unsigned int TPointDimension = 3 >
class ITK_EXPORT SpatialObjectPoint 
{

public:

  SpatialObjectPoint( void );

  virtual ~SpatialObjectPoint( void );

  typedef SpatialObjectPoint                Self;
  typedef Point< double, TPointDimension >  PointType;
  typedef vnl_vector< double >              VectorType;
  typedef RGBAPixel< float >                PixelType;
  typedef PixelType                         ColorType;

  int GetID( void ) const;

  void SetID(const int newID);

  const PointType & GetPosition( void ) const;

  void SetPosition(const PointType & newX);
  void SetPosition(const double x0, const double x1);
  void SetPosition(const double x0, const double x1, const double x2);

  Self & operator=(const SpatialObjectPoint & rhs);

  const PixelType & GetColor( void ) const;
  void SetColor(const PixelType & color );
  void SetColor(float r, float g, float b, float a=1);

  void SetRed( float r );
  float GetRed( void ) const;

  void SetGreen( float g );
  float GetGreen( void ) const;

  void SetBlue( float b );
  float GetBlue( void ) const;

  void SetAlpha( float a);
  float GetAlpha( void ) const;

  void Print(std::ostream &os) const;  

protected:

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

  int m_ID;

  PointType m_X;

  PixelType m_Color;

};

} // end of namespace itk

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

#endif // __itkSpatialObjectPoint_h