include/opencascade/GC_MakeTranslation2d.hxx

0001 // Created on: 1992-09-28
0002 // Created by: Remi GILET
0003 // Copyright (c) 1992-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _GC_MakeTranslation2d_HeaderFile
0018 #define _GC_MakeTranslation2d_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class Geom2d_Transformation;
0025 class gp_Vec2d;
0026 class gp_Pnt2d;
0027
0028 //! This class implements elementary construction algorithms for
0029 //! translations in 2D space.
0030 //! The result is a `Geom2d_Transformation`.
0031 //! A `GC_MakeTranslation2d` object provides a framework for:
0032 //! - defining the transformation parameters;
0033 //! - running the construction algorithm;
0034 //! - querying the resulting transformation via `Value()`.
0035 class GC_MakeTranslation2d
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   //! Constructs a translation along a vector.
0041   //! @param[in] theVect translation vector
0042   Standard_EXPORT GC_MakeTranslation2d(const gp_Vec2d& theVect);
0043
0044   //! Constructs a translation along the vector from one point to another.
0045   //! @param[in] thePoint1 first point
0046   //! @param[in] thePoint2 second point
0047   Standard_EXPORT GC_MakeTranslation2d(const gp_Pnt2d& thePoint1, const gp_Pnt2d& thePoint2);
0048
0049   //! Returns the constructed transformation.
0050   //! @return resulting transformation
0051   Standard_EXPORT const occ::handle<Geom2d_Transformation>& Value() const;
0052
0053   //! Conversion operator returning the constructed object.
0054   //! @return resulting transformation
0055   operator const occ::handle<Geom2d_Transformation>&() const { return Value(); }
0056
0057 private:
0058   occ::handle<Geom2d_Transformation> TheTranslation;
0059 };
0060
0061 #endif // _GC_MakeTranslation2d_HeaderFile