include/opencascade/gce_MakeTranslation.hxx

0001 // Created on: 1992-08-26
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 _gce_MakeTranslation_HeaderFile
0018 #define _gce_MakeTranslation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <gp_Trsf.hxx>
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 gp_Trsf transformation.
0030 //! A MakeTranslation object provides a framework for:
0031 //! -   defining the construction of the transformation,
0032 //! -   implementing the construction algorithm, and
0033 //! -   consulting the result.
0034 class gce_MakeTranslation
0035 {
0036 public:
0037   DEFINE_STANDARD_ALLOC
0038
0039   //! Constructs a translation from a vector.
0040   //! @param[in] Vect translation vector
0041   Standard_EXPORT gce_MakeTranslation(const gp_Vec& Vect);
0042
0043   //! Constructs a translation from two points.
0044   //! @param[in] Point1 start point
0045   //! @param[in] Point2 end point
0046   Standard_EXPORT gce_MakeTranslation(const gp_Pnt& Point1, const gp_Pnt& Point2);
0047
0048   //! Returns the constructed transformation.
0049   //! @return resulting transformation
0050   Standard_EXPORT const gp_Trsf& Value() const;
0051
0052   //! Alias for Value() returning a copy.
0053   //! @return resulting transformation
0054   gp_Trsf Operator() const { return Value(); }
0055
0056   //! Conversion operator returning the constructed transformation.
0057   //! @return resulting transformation
0058   operator gp_Trsf() const { return Operator(); }
0059
0060 private:
0061   gp_Trsf TheTranslation;
0062 };
0063
0064 #endif // _gce_MakeTranslation_HeaderFile