Transformation.hpp

#pragma once
 
#include "DM/config.hpp"
#include "DM/Handle.hpp"
#include "DM/IGeometry.hpp"
 
DM_NAMESPACE_BEGIN
 
/// Interface for generic geometry object coordinate transformation
class DM_API ITrafo
{
protected:
  virtual ~ITrafo() {}
 
public:
  /// \brief returns the dimension of transformation.
  /// This info helps to optimize the actual transformation process of the geometry objects
  /// 
  /// \return 1 if only z values are changed
  /// \return 2 for 2d transformations
  /// \return 3 if all coordinate values may be changed
  virtual int  trafoDim() const = 0;
 
  /// \brief returns flag if the chunked transform function should be use
  /// the chunked transformation may results in high performance
  virtual bool usedChunkedTrafo() const = 0;
 
  /// \brief performs single point coordinate transformation (mandatory interface)
  /// please note that coordinates must not be changed if not effected by the transformation
  ///
  /// \param[in,out]  x    x-coordinate
  /// \param[in,out]  y    y-coordinate
  /// \param[in,out]  z    z-coordinate
  /// \param[in]      inv  inversion flag if transformation should be inverted
  virtual void transform(double &x, double &y, double &z, bool inv = false) const = 0;
 
  /// \brief performs chunked coordinate transformation (optional interface)
  /// please note that coordinates must not be changed if not effected by the transformation
  ///
  /// \param[in]      count number of points
  /// \param[in,out]  x     x-coordinate array
  /// \param[in,out]  y     y-coordinate array
  /// \param[in,out]  z     z-coordinate array
  /// \param[in]      inv   inversion flag if transformation should be inverted
  virtual void transform(size_t count, double *x, double *y, double *z, bool inv = false) const = 0;
 
};
 
/// \brief provides a generic framework for transforming geometry objects
void DM_API transform(const ITrafo &trafo, IGeometry &geom, bool inv = false);
 
DM_NAMESPACE_END