0024023: Revamp the OCCT Handle -- GC
[occt.git] / src / GC / GC_MakeTranslation.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 MakeTranslation
18
19 from GC
20
21     ---Purpose: This class implements elementary construction algorithms for a
22     -- translation in 3D space. The result is a
23     -- Geom_Transformation transformation.
24     -- A MakeTranslation 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      Transformation from Geom,
31      Vec            from gp,
32      Real           from Standard
33      
34 is
35
36 Create(Vect : Vec from gp) returns MakeTranslation;
37         ---Purpose: Constructs a translation along the vector " Vect "        
38 Create(Point1 : Pnt from gp;
39        Point2 : Pnt from gp) returns MakeTranslation;
40         ---Purpose: Constructs a translation along the vector (Point1,Point2)
41         --  defined from the point Point1 to the point Point2.
42     
43 Value(me) returns Transformation from Geom
44     is static;
45         ---Purpose:  Returns the constructed transformation.
46         ---C++: return const&
47         ---C++: alias "operator const Handle(Geom_Transformation)& () const { return Value(); }"
48
49 fields
50
51     TheTranslation : Transformation from Geom;
52
53 end MakeTranslation;
54