0024428: Implementation of LGPL license
[occt.git] / src / BRepBuilderAPI / BRepBuilderAPI_Copy.cdl
1 -- Created on: 1994-12-12
2 -- Created by: Jacques GOUSSARD
3 -- Copyright (c) 1994-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
9 -- under the terms of the GNU Lesser General Public 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 Copy from BRepBuilderAPI inherits ModifyShape from BRepBuilderAPI
18
19         ---Purpose: Duplication of a shape.
20         -- A Copy object provides a framework for:
21         -- -   defining the construction of a duplicate shape,
22         -- -   implementing the construction algorithm, and
23         -- -   consulting the result.
24         
25 uses
26     Shape             from TopoDS,
27     Face              from TopoDS,
28     ShapeModification from BRepBuilderAPI,
29     ListOfShape       from TopTools
30
31
32 is
33
34     Create
35         ---Purpose: Constructs an empty copy framework. Use the function
36         -- Perform to copy shapes.
37         returns Copy from BRepBuilderAPI;
38
39
40     Create(S: Shape from TopoDS; copyGeom: Boolean = Standard_True)
41         ---Purpose: Constructs a copy framework and copies the shape S.
42         -- Use the function Shape to access the result.
43         -- If copyGeom is False, only topological objects will be copied, while 
44         -- geometry will be shared with original shape.
45         -- Note: the constructed framework can be reused to copy
46         -- other shapes: just specify them with the function Perform.
47         returns Copy from BRepBuilderAPI;
48
49
50     Perform(me: in out; S: Shape from TopoDS; copyGeom: Boolean = Standard_True)
51         ---Purpose: Copies the shape S.
52         -- Use the function Shape to access the result.
53         -- If copyGeom is False, only topological objects will be copied, while 
54         -- geometry will be shared with original shape.
55         is static;
56
57
58 end Copy;