include/opencascade/GC_MakeRotation.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_MakeRotation_HeaderFile
0018 #define _GC_MakeRotation_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <Standard_Real.hxx>
0025 class Geom_Transformation;
0026 class gp_Lin;
0027 class gp_Ax1;
0028 class gp_Pnt;
0029 class gp_Dir;
0030
0031 //! This class implements elementary construction algorithms for a
0032 //! rotation in 3D space. The result is a
0033 //! Geom_Transformation transformation.
0034 //! A MakeRotation object provides a framework for:
0035 //! -   defining the construction of the transformation,
0036 //! -   implementing the construction algorithm, and
0037 //! -   consulting the result.
0038 class GC_MakeRotation
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   //! Constructs a rotation around the axis defined by a line.
0044   //! @param[in] theLine rotation axis
0045   //! @param[in] theAngle rotation angle in radians
0046   Standard_EXPORT GC_MakeRotation(const gp_Lin& theLine, const double theAngle);
0047
0048   //! Constructs a rotation around an axis.
0049   //! @param[in] theAxis rotation axis
0050   //! @param[in] theAngle rotation angle in radians
0051   Standard_EXPORT GC_MakeRotation(const gp_Ax1& theAxis, const double theAngle);
0052
0053   //! Constructs a rotation around an axis defined by point and direction.
0054   //! @param[in] thePoint point on the axis
0055   //! @param[in] theDirec axis direction
0056   //! @param[in] theAngle rotation angle in radians
0057   Standard_EXPORT GC_MakeRotation(const gp_Pnt& thePoint,
0058                                   const gp_Dir& theDirec,
0059                                   const double  theAngle);
0060
0061   //! Returns the constructed transformation.
0062   //! @return resulting transformation
0063   Standard_EXPORT const occ::handle<Geom_Transformation>& Value() const;
0064
0065   //! Conversion operator returning the constructed object.
0066   //! @return resulting object
0067   operator const occ::handle<Geom_Transformation>&() const { return Value(); }
0068
0069 private:
0070   occ::handle<Geom_Transformation> TheRotation;
0071 };
0072
0073 #endif // _GC_MakeRotation_HeaderFile