include/opencascade/GC_MakeTranslation.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_MakeTranslation_HeaderFile
0018 #define _GC_MakeTranslation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 class Geom_Transformation;
0025 class gp_Vec;
0026 class gp_Pnt;
0027
0028 //! This class implements elementary construction algorithms for a
0029 //! translation in 3D space. The result is a
0030 //! Geom_Transformation transformation.
0031 //! A MakeTranslation object provides a framework for:
0032 //! -   defining the construction of the transformation,
0033 //! -   implementing the construction algorithm, and
0034 //! -   consulting the result.
0035 class GC_MakeTranslation
0036 {
0037 public:
0038   DEFINE_STANDARD_ALLOC
0039
0040   //! Constructs a translation along the vector " Vect "
0041   Standard_EXPORT GC_MakeTranslation(const gp_Vec& Vect);
0042
0043   //! Constructs a translation along the vector (Point1,Point2)
0044   //! defined from the point Point1 to the point Point2.
0045   Standard_EXPORT GC_MakeTranslation(const gp_Pnt& Point1, const gp_Pnt& Point2);
0046
0047   //! Returns the constructed transformation.
0048   Standard_EXPORT const Handle(Geom_Transformation)& Value() const;
0049
0050   operator const Handle(Geom_Transformation) & () const { return Value(); }
0051
0052 protected:
0053 private:
0054   Handle(Geom_Transformation) TheTranslation;
0055 };
0056
0057 #endif // _GC_MakeTranslation_HeaderFile