src/GC/GC_MakeRotation.cdl

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