0024784: Move documentation in CDL files to proper location
[occt.git] / src / HLRAlgo / HLRAlgo_PolyData.cdl
CommitLineData
b311480e 1-- Created on: 1993-10-29
2-- Created by: Christophe MARION
3-- Copyright (c) 1993-1999 Matra Datavision
973c2be1 4-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 5--
973c2be1 6-- This file is part of Open CASCADE Technology software library.
b311480e 7--
d5f74e42 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
973c2be1 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.
b311480e 13--
973c2be1 14-- Alternatively, this file may be used under the terms of Open CASCADE
15-- commercial license or contractual agreement.
7fd59977 16
17class PolyData from HLRAlgo inherits TShared from MMgt
ff8178ef 18 ---Purpose: Data structure of a set of Triangles.
7fd59977 19
20uses
21 Address from Standard,
22 Integer from Standard,
23 Boolean from Standard,
24 Array1OfXYZ from TColgp,
25 Array1OfTData from HLRAlgo,
26 Array1OfPHDat from HLRAlgo,
27 HArray1OfXYZ from TColgp,
28 HArray1OfTData from HLRAlgo,
29 HArray1OfPHDat from HLRAlgo,
30 EdgeStatus from HLRAlgo
31
32is
6e33d3ce 33 Create returns PolyData from HLRAlgo;
7fd59977 34
35 HNodes(me : mutable; HNodes : HArray1OfXYZ from TColgp)
36 is static;
37
38 HTData(me : mutable; HTData : HArray1OfTData from HLRAlgo)
39 is static;
40
41 HPHDat(me : mutable; HPHDat : HArray1OfPHDat from HLRAlgo)
42 is static;
43
44 FaceIndex(me : mutable; I : Integer from Standard)
45 ---C++: inline
46 is static;
47
48 FaceIndex(me) returns Integer from Standard
49 ---C++: inline
50 is static;
51
52 Nodes(me) returns Array1OfXYZ from TColgp
53 ---C++: inline
54 ---C++: return &
55 is static;
56
57 TData(me) returns Array1OfTData from HLRAlgo
58 ---C++: inline
59 ---C++: return &
60 is static;
61
62 PHDat(me) returns Array1OfPHDat from HLRAlgo
63 ---C++: inline
64 ---C++: return &
65 is static;
66
67 UpdateGlobalMinMax(me : mutable;
68 ToTMinMax : Address from Standard)
69 is static;
70
71 Hiding(me) returns Boolean from Standard
72 ---C++: inline
73 is static;
74
75 HideByPolyData(me : mutable;
76 Coordinates : Address from Standard;
77 RealPtr : Address from Standard;
78 Indices : Address from Standard;
79 HidingShell : Boolean from Standard;
80 status : out EdgeStatus from HLRAlgo)
81 ---Purpose: process hiding between <Pt1> and <Pt2>.
82 is static;
83
84 HideByOneTriangle(me : mutable;
85 Coordinates : Address from Standard;
86 RealPtr : Address from Standard;
87 BooleanPtr : Address from Standard;
88 PlanPtr : Address from Standard;
89 status : out EdgeStatus from HLRAlgo)
90 ---Purpose: evident.
91 is static private;
92
93 Indices(me : mutable) returns Address from Standard
94 ---C++: inline
95 is static;
96
97fields
98 myIndices : Integer from Standard[3];
99 myHNodes : HArray1OfXYZ from TColgp;
100 myHTData : HArray1OfTData from HLRAlgo;
101 myHPHDat : HArray1OfPHDat from HLRAlgo;
102
103end PolyData;