0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PPoly / PPoly_Polygon3D.cdl
1 -- Created on: 1995-10-24
2 -- Created by: Mister rmi
3 -- Copyright (c) 1995-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 Polygon3D from PPoly inherits Persistent from Standard
18
19         ---Purpose: This class represents a 3d Polygon3D.
20         --          
21         --          It is defined by an array of 3d nodes values.
22         --          If the Polygon3D is closed, the point will be
23         --          repeated.
24
25
26 uses HArray1OfPnt  from PColgp,
27      HArray1OfReal from PColStd
28
29 is
30
31     Create(Nodes: HArray1OfPnt from PColgp;
32            Defl : Real from Standard) 
33     returns Polygon3D from PPoly;
34         ---Purpose: Defaults with allocation of nodes.
35
36     Create(Nodes      : HArray1OfPnt  from PColgp;
37            Parameters : HArray1OfReal from PColStd;
38            Defl       : Real          from Standard) 
39     returns Polygon3D from PPoly;
40         ---Purpose: Defaults with allocation of nodes + Parameters
41     
42
43     Deflection(me) returns Real;
44
45     Deflection(me : mutable; Defl : Real from Standard);
46     
47
48     NbNodes(me) returns Integer;
49     
50     Nodes(me) returns HArray1OfPnt from PColgp;
51
52     Nodes(me : mutable; Nodes : HArray1OfPnt from PColgp);
53     
54
55     HasParameters(me) returns Boolean from Standard;
56
57     Parameters(me : mutable; Parameters : HArray1OfReal from PColStd);
58         ---Purpose: Sets the value of myParameters
59
60     Parameters(me) returns HArray1OfReal from PColStd;
61         ---Purpose: Reference on the parameters values.
62     
63 fields
64
65     myDeflection : Real          from Standard;
66     myNodes      : HArray1OfPnt  from PColgp;
67     myParameters : HArray1OfReal from PColStd;
68         -- myParameters is Optional (Pointer can be Null)
69     
70 end Polygon3D;