0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PPoly / PPoly_PolygonOnTriangulation.cdl
1 -- Created on: 1996-06-05
2 -- Created by: Mister rmi
3 -- Copyright (c) 1996-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 PolygonOnTriangulation from PPoly inherits Persistent from Standard
18
19         ---Purpose: This class represents a 3d Polygon based on
20         --          indices of triangulation nodes.
21         --          
22         --          This polygon may also have a parametric
23         --          representation.
24
25
26 uses HArray1OfInteger  from PColStd,
27      HArray1OfReal     from PColStd
28
29 raises NullObject from Standard
30
31 is
32
33     Create returns PolygonOnTriangulation from PPoly;
34     
35     Create(Nodes : HArray1OfInteger from PColStd;
36            Defl  : Real             from Standard)
37     returns PolygonOnTriangulation from PPoly;
38         ---Purpose: Defaults with allocation of nodes.
39     
40     Create(Nodes      : HArray1OfInteger from PColStd;
41            Defl       : Real             from Standard;
42            Parameters : HArray1OfReal    from PColStd) 
43     returns PolygonOnTriangulation from PPoly;
44         ---Purpose: Defaults with allocation of nodes.
45     
46     Deflection(me) returns Real;
47     
48     Deflection(me : mutable; D : Real);
49
50
51     NbNodes(me) returns Integer;
52     
53     Nodes(me) returns HArray1OfInteger from PColStd;
54         ---Purpose: Reference on the 3d nodes indices.
55
56     Nodes(me : mutable; Nodes : HArray1OfInteger from PColStd);
57     
58     HasParameters(me) returns Boolean from Standard;
59     
60     Parameters(me) returns HArray1OfReal from PColStd;
61         ---Purpose: Returns the parameters values.
62
63     Parameters(me : mutable; Param : HArray1OfReal from PColStd);
64     
65     
66 fields
67
68     myDeflection    : Real             from Standard;
69     myNodes         : HArray1OfInteger from PColStd;
70     myParameters    : HArray1OfReal    from PColStd; 
71          -- myParameters is Optional (pointer can be null)
72     
73 end PolygonOnTriangulation;