ILinearDistance.hpp

#ifndef DM_ILINEAR_DISTANCE_HPP_INCLUDED
#define DM_ILINEAR_DISTANCE_HPP_INCLUDED

#ifdef _MSC_VER
  #pragma once
#endif

#include "DM/config.hpp"
#include "DM/ObjectBase.hpp"
#include "DM/Handle.hpp"

DM_NAMESPACE_BEGIN

/// \brief Computes an average linear distance of a given point set in 2d
class DM_API ILinearDistance2D : public ObjectBase
{
public: 
  static ILinearDistance2D *New();  ///< creates a linear distance object

protected:
  virtual ~ILinearDistance2D() {}

public:
  virtual void add(double x, double y) = 0; ///< adds a point to the point set
  virtual void clear() = 0;                 ///< removes all points from the point set
  virtual double get() const = 0;           ///< compute the linear distance of the current point set
};


/// \brief Computes an average linear distance of a given point set in 3d
class DM_API ILinearDistance3D : public ObjectBase
{
public:
  static ILinearDistance3D *New();  ///< creates a linear distance object
protected:
  virtual ~ILinearDistance3D() {}

public:
  virtual void add(double x, double y, double z) = 0; ///< adds a point to the point set
  virtual void clear() = 0;                           ///< removes all points from the point set
  virtual double get() const = 0;                     ///< compute the linear distance of the current point set
};

typedef Handle< ILinearDistance2D > LinearDistance2DHandle;
typedef Handle< ILinearDistance3D > LinearDistance3DHandle;

DM_NAMESPACE_END

#endif //DM_ILINEAR_DISTANCE_HPP_INCLUDED