src/gce/gce_MakeRotation.hxx

   1 // Created on: 1992-08-26
   2 // Created by: Remi GILET
   3 // Copyright (c) 1992-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _gce_MakeRotation_HeaderFile
  18 #define _gce_MakeRotation_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <gp_Trsf.hxx>
  25 #include <Standard_Real.hxx>
  26 class gp_Lin;
  27 class gp_Ax1;
  28 class gp_Pnt;
  29 class gp_Dir;
  30 class gp_Trsf;
  31
  32
  33 //! This class implements elementary construction algorithms for a
  34 //! rotation in 3D space. The result is a gp_Trsf transformation.
  35 //! A MakeRotation object provides a framework for:
  36 //! -   defining the construction of the transformation,
  37 //! -   implementing the construction algorithm, and
  38 //! -   consulting the result.
  39 class gce_MakeRotation
  40 {
  41 public:
  42
  43   DEFINE_STANDARD_ALLOC
  44
  45
  46   //! Constructs a rotation through angle Angle about the axis defined by the line Line.
  47   Standard_EXPORT gce_MakeRotation(const gp_Lin& Line, const Standard_Real Angle);
  48
  49   //! Constructs a rotation through angle Angle about the axis defined by the axis Axis.
  50   Standard_EXPORT gce_MakeRotation(const gp_Ax1& Axis, const Standard_Real Angle);
  51
  52
  53   //! Constructs a rotation through angle Angle about the axis defined by:
  54   //! the point Point and the unit vector Direc.
  55   Standard_EXPORT gce_MakeRotation(const gp_Pnt& Point, const gp_Dir& Direc, const Standard_Real Angle);
  56
  57   //! Returns the constructed transformation.
  58   Standard_EXPORT const gp_Trsf& Value() const;
  59
  60   Standard_EXPORT const gp_Trsf& Operator() const;
  61 Standard_EXPORT operator gp_Trsf() const;
  62
  63
  64
  65
  66 protected:
  67
  68
  69
  70
  71
  72 private:
  73
  74
  75
  76   gp_Trsf TheRotation;
  77
  78
  79 };
  80
  81
  82
  83
  84
  85
  86
  87 #endif // _gce_MakeRotation_HeaderFile