0024428: Implementation of LGPL license
[occt.git] / src / BRepMesh / BRepMesh_VertexTool.cdl
CommitLineData
b311480e 1-- Created on: 2011-06-02
2-- Created by: Oleg AGASHIN
973c2be1 3-- Copyright (c) 2011-2014 OPEN CASCADE SAS
b311480e 4--
973c2be1 5-- This file is part of Open CASCADE Technology software library.
b311480e 6--
973c2be1 7-- This library is free software; you can redistribute it and / or modify it
8-- under the terms of the GNU Lesser General Public version 2.1 as published
9-- by the Free Software Foundation, with special exception defined in the file
10-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11-- distribution for complete text of the license and disclaimer of any warranty.
b311480e 12--
973c2be1 13-- Alternatively, this file may be used under the terms of Open CASCADE
14-- commercial license or contractual agreement.
51c3cc5f
O
15
16class VertexTool from BRepMesh
17
18 ---Purpose: Describes the data structure necessary for the
19 -- mesh algorithm and contains the vertices in UV space.
20
21 uses Boolean from Standard,
22 Integer from Standard,
23 Real from Standard,
24 XY from gp,
25 ListOfInteger from BRepMesh,
26 VertexCellFilter from BRepMesh,
27 VertexInspector from BRepMesh,
28 BaseAllocator from BRepMesh,
29 Vertex from BRepMesh,
30 DataMapOfIntegerListOfInteger from BRepMesh,
31 Array1OfReal from TColStd
32
33 is Create (theAlloc : in BaseAllocator from BRepMesh)
34 returns VertexTool from BRepMesh;
35
36
37 Create (nbComp : in Integer from Standard;
38 theAlloc : in BaseAllocator from BRepMesh)
39 ---Purpose: Constructs a VertexTool with an evaluation of the
40 -- number of vertices.
41 returns VertexTool from BRepMesh;
42
43 SetCellSize(me : in out;
44 theSize : in Real from Standard)
45 ---Purpose: Sets new size for cellfilter.
46 is static;
47
48 SetCellSize(me : in out;
49 theXSize : in Real from Standard;
50 theYSize : in Real from Standard)
51 ---Purpose: Sets new size for cellfilter.
52 is static;
53
54 SetTolerance(me : in out;
55 theTol : in Real from Standard)
56 ---Purpose: Sets new size for cellfilter.
57 is static;
58
59 SetTolerance(me : in out;
60 theTolX : in Real from Standard;
61 theTolY : in Real from Standard)
62 ---Purpose: Sets new size for cellfilter.
63 is static;
64
65 Add (me : in out;
66 theVertex: in Vertex from BRepMesh;
67 theParams: in ListOfInteger from BRepMesh)
68 ---Purpose: Adds a vertex to the tool.
69 returns Integer from Standard is static;
70
71 Add (me : in out;
72 theVertex: in Vertex from BRepMesh)
73 ---Purpose: Adds a vertex to the tool.
74 returns Integer from Standard is static;
75
76 Delete (me : in out; theIndex : Integer from Standard)
77 ---Purpose: Deletes a vertex from the tool.
78 is static;
79
80 FindFromIndex (me; theIndex : Integer from Standard)
81 ---Purpose: Returns data assigned to theIndex.
82 ---C++: alias operator()
83 ---C++: return &
84 returns ListOfInteger from BRepMesh is static;
85
86 FindKey (me: out; theIndex: Integer from Standard)
87 ---Purpose: Selects the vertex by theIndex.
88 ---C++: return const &
89 returns Vertex from BRepMesh is static;
90
91 FindIndex (me: out;
92 theVertex: Vertex from BRepMesh)
93 ---Purpose: Returns an index of theVertex.
94 returns Integer from Standard is static;
95
96 Extent (me)
97 ---Purpose: Returns a number of vertices.
98 returns Integer from Standard is static;
99
100 IsEmpty (me)
101 ---Purpose: Returns True when the map contains no keys.
102 returns Boolean from Standard is static;
103
104 Substitute(me: in out; Index: Integer from Standard;
105 theVertex: Vertex from BRepMesh;
106 theData : ListOfInteger from BRepMesh)
107 ---Purpose: Substitutes vertex with Index on
108 -- theVertex with attributes theData.
109 is static;
110
111 RemoveLast(me: out)
112 ---Purpose: Remove last node from the structure.
113 is static;
114
115 GetListOfDelNodes(me)
116 ---Purpose: Returns the list with indexes of
117 -- vertices that have Movability attribute
118 -- equal to BRepMesh_Deleted and can be
119 -- replaced with another node.
120 ---C++: return const &
121 returns ListOfInteger from BRepMesh
122 is static;
123
124 ExpandPoint(me: in out;
125 thePnt: in XY from gp;
126 theMinPnt: out XY from gp;
127 theMaxPnt: out XY from gp)
128 is static private;
129
130 Statistics(me; S: in out OStream from Standard)
131 ---Purpose: Prints statistics.
132 is static;
133
134 fields myAllocator : BaseAllocator from BRepMesh;
135 myCellFilter : VertexCellFilter from BRepMesh;
136 mySelector : VertexInspector from BRepMesh;
137 myLinksMap : DataMapOfIntegerListOfInteger from BRepMesh;
138 myTol : Array1OfReal from TColStd;
139
140end CircleTool;