mitkPlanarFigure.h

Go to the documentation of this file.

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

Program:   Medical Imaging & Interaction Toolkit
Language:  C++
Date:      $Date: 2009-05-13 18:06:46 +0200 (Mi, 13 Mai 2009) $
Version:   $Revision: 17258 $

Copyright (c) German Cancer Research Center, Division of Medical and
Biological Informatics. All rights reserved.
See MITKCopyright.txt or https://www.mitk.org/copyright.html 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 _MITK_PLANAR_FIGURE_H_
#define _MITK_PLANAR_FIGURE_H_

#include "PlanarFigureExports.h"
#include "mitkBaseData.h"
#include "mitkCommon.h"


namespace mitk 
{

class Geometry2D;

class PlanarFigure_EXPORT PlanarFigure : public BaseData
{
public:
  mitkClassMacro( PlanarFigure, BaseData );


  typedef itk::VectorContainer< unsigned long, mitk::Point2D > VertexContainerType;
  typedef itk::VectorContainer< unsigned long, VertexContainerType::Pointer> VertexContainerVectorType;
  typedef itk::VectorContainer< unsigned long, bool>  BoolContainerType;


  virtual void SetGeometry2D( mitk::Geometry2D *geometry );


  virtual const Geometry2D *GetGeometry2D() const;


  virtual bool IsClosed() const;

  
  virtual bool IsPlaced() const { return m_FigurePlaced; };


  virtual void PlaceFigure( const Point2D& point );


  virtual bool AddControlPoint( const Point2D& point );

  virtual bool SetControlPoint( unsigned int index, const Point2D& point, bool createIfDoesNotExist = false);

  virtual bool SetCurrentControlPoint( const Point2D& point );

   
  unsigned int GetNumberOfControlPoints() const;


  virtual unsigned int GetMinimumNumberOfControlPoints() const = 0;


  virtual unsigned int GetMaximumNumberOfControlPoints() const = 0;


  virtual bool SelectControlPoint( unsigned int index );

  
  virtual void DeselectControlPoint();


  virtual int GetSelectedControlPoint() const { return m_SelectedControlPoint; }


  
  const VertexContainerType *GetControlPoints() const;

  
  VertexContainerType *GetControlPoints();


  Point2D& GetControlPoint( unsigned int index ) const;


  Point3D GetWorldControlPoint( unsigned int index ) const;


  VertexContainerType *GetPolyLine(unsigned int index);

  const VertexContainerType *GetPolyLine(unsigned int index) const;

  const VertexContainerType *GetHelperPolyLine(unsigned int index, double mmPerDisplayUnit, unsigned int displayHeight);

  virtual unsigned int GetNumberOfFeatures() const;


  const char *GetFeatureName( unsigned int index ) const;


  const char *GetFeatureUnit( unsigned int index ) const;


  double GetQuantity( unsigned int index ) const;

  
  bool IsFeatureActive( unsigned int index ) const;


  virtual void EvaluateFeatures();


  virtual void UpdateOutputInformation();

  virtual void SetRequestedRegionToLargestPossibleRegion();

  virtual bool RequestedRegionIsOutsideOfTheBufferedRegion();

  virtual bool VerifyRequestedRegion();

  virtual void SetRequestedRegion(itk::DataObject *data);
 
  virtual unsigned short GetPolyLinesSize();

  virtual unsigned short GetHelperPolyLinesSize();

  virtual bool IsHelperToBePainted(unsigned int index);

  virtual bool ResetOnPointSelect();

  virtual void RemoveLastControlPoint();

  void DeepCopy(Self::Pointer oldFigure);


protected:
  PlanarFigure();
  virtual ~PlanarFigure();

  void ResetNumberOfControlPoints( int numberOfControlPoints );

  virtual Point2D ApplyControlPointConstraints( unsigned int /*index*/, const Point2D& point );

  virtual unsigned int AddFeature( const char *featureName, const char *unitName );

  void SetFeatureName( unsigned int index, const char *featureName );

  void SetFeatureUnit( unsigned int index, const char *unitName );

  void SetQuantity( unsigned int index, double quantity );

  void ActivateFeature( unsigned int index );

  void DeactivateFeature( unsigned int index );

  virtual void GeneratePolyLine() = 0;

  virtual void GenerateHelperPolyLine(double mmPerDisplayUnit, unsigned int displayHeight) = 0;

  virtual void EvaluateFeaturesInternal() = 0;

  virtual void InitializeTimeSlicedGeometry( unsigned int timeSteps = 1 );

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


  VertexContainerType::Pointer m_ControlPoints;
  unsigned int m_NumberOfControlPoints;

  VertexContainerVectorType::Pointer m_PolyLines;
  VertexContainerVectorType::Pointer m_HelperPolyLines;
  BoolContainerType::Pointer         m_HelperPolyLinesToBePainted;


  bool m_FigurePlaced;

  // Currently selected control point; -1 means no point selected
  int m_SelectedControlPoint;


private:

  struct Feature
  {
    Feature( const char *name, const char *unit ) 
    : Name( name ), Unit( unit ), Quantity( 0.0 ), Active( true )
    {
    };

    std::string Name;
    std::string Unit;
    double Quantity;
    bool Active;
  };

  Geometry2D *m_Geometry2D;


  // Vector of features available for this geometric figure
  typedef std::vector< Feature > FeatureVectorType;
  FeatureVectorType m_Features;

  unsigned long m_FeaturesMTime;

};

} // namespace mitk

#endif //_MITK_PLANAR_FIGURE_H_