include/opencascade/gce_MakeRotation.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_MakeRotation_HeaderFile
0018 #define _gce_MakeRotation_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_Lin;
0026 class gp_Ax1;
0027 class gp_Pnt;
0028 class gp_Dir;
0029
0030 //! This class implements elementary construction algorithms for a
0031 //! rotation in 3D space. The result is a gp_Trsf transformation.
0032 //! A MakeRotation object provides a framework for:
0033 //! -   defining the construction of the transformation,
0034 //! -   implementing the construction algorithm, and
0035 //! -   consulting the result.
0036 class gce_MakeRotation
0037 {
0038 public:
0039   DEFINE_STANDARD_ALLOC
0040
0041   //! Constructs a rotation around the axis defined by a line.
0042   //! @param[in] Line rotation axis
0043   //! @param[in] Angle rotation angle in radians
0044   Standard_EXPORT gce_MakeRotation(const gp_Lin& Line, const double Angle);
0045
0046   //! Constructs a rotation around an axis.
0047   //! @param[in] Axis rotation axis
0048   //! @param[in] Angle rotation angle in radians
0049   Standard_EXPORT gce_MakeRotation(const gp_Ax1& Axis, const double Angle);
0050
0051   //! Constructs a rotation around an axis defined by point and direction.
0052   //! @param[in] Point point on the axis
0053   //! @param[in] Direc axis direction
0054   //! @param[in] Angle rotation angle in radians
0055   Standard_EXPORT gce_MakeRotation(const gp_Pnt& Point, const gp_Dir& Direc, const double Angle);
0056
0057   //! Returns the constructed transformation.
0058   //! @return resulting transformation
0059   Standard_EXPORT const gp_Trsf& Value() const;
0060
0061   //! Alias for Value() returning a copy.
0062   //! @return resulting transformation
0063   gp_Trsf Operator() const { return Value(); }
0064
0065   //! Conversion operator returning the constructed transformation.
0066   //! @return resulting transformation
0067   operator gp_Trsf() const { return Operator(); }
0068
0069 private:
0070   gp_Trsf TheRotation;
0071 };
0072
0073 #endif // _gce_MakeRotation_HeaderFile