src/gce/gce_MakeRotation.cdl

   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 class MakeRotation
  18
  19 from gce
  20
  21     ---Purpose: This class implements elementary construction algorithms for a
  22     -- rotation in 3D space. The result is a gp_Trsf transformation.
  23     -- A MakeRotation object provides a framework for:
  24     -- -   defining the construction of the transformation,
  25     -- -   implementing the construction algorithm, and
  26     -- -   consulting the result.
  27
  28 uses Pnt  from gp,
  29      Lin  from gp,
  30      Ax1  from gp,
  31      Dir  from gp,
  32      Trsf from gp,
  33      Real from Standard
  34
  35 is
  36
  37 Create(Line  : Lin  from gp      ;
  38        Angle : Real from Standard) returns MakeRotation;
  39     ---Purpose: Constructs a rotation through angle Angle about the axis defined by the line Line.
  40
  41 Create(Axis  : Ax1  from gp      ;
  42        Angle : Real from Standard) returns MakeRotation;
  43     ---Purpose: Constructs a rotation through angle Angle about the axis defined by the axis Axis.
  44
  45 Create(Point : Pnt  from gp      ;
  46        Direc : Dir  from gp      ;
  47        Angle : Real from Standard) returns MakeRotation;
  48     ---Purpose:
  49     -- Constructs a rotation through angle Angle about the axis defined by:
  50     -- the point Point and the unit vector Direc.
  51
  52 Value(me) returns Trsf from gp
  53     is static;
  54     ---C++: return const&
  55     ---Purpose: Returns the constructed transformation.
  56
  57 Operator(me) returns Trsf from gp
  58     is static;
  59     ---C++: return const&
  60     ---C++: alias "Standard_EXPORT operator gp_Trsf() const;"
  61
  62 fields
  63
  64     TheRotation : Trsf from gp;
  65
  66 end MakeRotation;