OCCT

// Created on: 1992-09-28
// Created by: Remi GILET
// Copyright (c) 1992-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _GC_MakeTranslation2d_HeaderFile
#define _GC_MakeTranslation2d_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

class Geom2d_Transformation;
class gp_Vec2d;
class gp_Pnt2d;

//! This class implements elementary construction algorithms for
//! translations in 2D space.
//! The result is a `Geom2d_Transformation`.
//! A `GC_MakeTranslation2d` object provides a framework for:
//! - defining the transformation parameters;
//! - running the construction algorithm;
//! - querying the resulting transformation via `Value()`.
class GC_MakeTranslation2d
{
public:
  DEFINE_STANDARD_ALLOC

  //! Constructs a translation along a vector.
  //! @param[in] theVect translation vector
  Standard_EXPORT GC_MakeTranslation2d(const gp_Vec2d& theVect);

  //! Constructs a translation along the vector from one point to another.
  //! @param[in] thePoint1 first point
  //! @param[in] thePoint2 second point
  Standard_EXPORT GC_MakeTranslation2d(const gp_Pnt2d& thePoint1, const gp_Pnt2d& thePoint2);

  //! Returns the constructed transformation.
  //! @return resulting transformation
  Standard_EXPORT const occ::handle<Geom2d_Transformation>& Value() const;

  //! Conversion operator returning the constructed object.
  //! @return resulting transformation
  operator const occ::handle<Geom2d_Transformation>&() const { return Value(); }

private:
  occ::handle<Geom2d_Transformation> TheTranslation;
};

#endif // _GC_MakeTranslation2d_HeaderFile