0022627: Change OCCT memory management defaults
[occt.git] / src / BRepAlgo / BRepAlgo_Image.cdl
CommitLineData
7fd59977 1-- File: BRepAlgo_Image.cdl
2-- Created: Thu Oct 26 14:31:50 1995
3-- Author: Yves FRICAUD
4-- <yfr@stylox>
5---Copyright: Matra Datavision 1995
6
7
8class Image from BRepAlgo
9
10 ---Purpose: Stores link between a shape <S> and a shape <NewS>
11 -- obtained from <S>. <NewS> is an image of <S>.
12
13uses
14 Shape from TopoDS,
15 ShapeEnum from TopAbs,
16 ListOfShape from TopTools,
17 DataMapOfShapeListOfShape from TopTools,
18 DataMapOfShapeShape from TopTools
19
20raises
21 ConstructionError from Standard
22
23is
24 Create;
25
26 SetRoot (me : in out; S : Shape from TopoDS)
27 is static;
28
29
30 Bind (me : in out; OldS : Shape from TopoDS;
31 NewS : Shape from TopoDS)
32 ---Purpose: Links <NewS> as image of <OldS>.
33 raises
34 ConstructionError -- if Olds has image.
35 is static;
36
37
38 Bind (me : in out; OldS : Shape from TopoDS;
39 NewS : ListOfShape from TopTools)
40 ---Purpose: Links <NewS> as image of <OldS>.
41 raises
42 ConstructionError -- if Olds has image.
43 is static;
44
45
46 Add (me : in out; OldS : Shape from TopoDS;
47 NewS : Shape from TopoDS)
48 ---Purpose: Add <NewS> to the image of <OldS>.
49 raises
50 ConstructionError -- if Olds has not image.
51 is static;
52
53
54 Add (me : in out; OldS : Shape from TopoDS;
55 NewS : ListOfShape from TopTools)
56 ---Purpose: Add <NewS> to the image of <OldS>.
57 raises
58 ConstructionError -- if Olds has not image.
59 is static;
60
61 Clear(me : in out)
62 is static;
63
64 Remove(me : in out; S : Shape from TopoDS)
65 ---Purpose: Remove <S> to set of images.
66 raises
67 ConstructionError -- if S is not an image.
68 is static;
69
70 Roots (me)
71 ---C++: return const &
72 returns ListOfShape from TopTools
73 is static;
74
75 IsImage (me; S : Shape from TopoDS)
76 returns Boolean from Standard
77 is static;
78
79 ImageFrom (me; S : Shape from TopoDS)
80 ---Purpose: Returns the generator of <S>
81 ---C++: return const &
82 returns Shape from TopoDS
83 is static;
84
85 Root (me; S : Shape from TopoDS)
86 ---Purpose: Returns the upper generator of <S>
87 ---C++: return const &
88 returns Shape from TopoDS
89 is static;
90
91 HasImage (me; S : Shape from TopoDS)
92 returns Boolean from Standard
93 is static;
94
95 Image (me; S : Shape from TopoDS)
96 ---Purpose: Returns the Image of <S>.
97 -- Returns <S> in the list if HasImage(S) is false.
98 ---C++: return const &
99 returns ListOfShape from TopTools
100 is static;
101
102 LastImage (me; S : Shape from TopoDS;
103 L : in out ListOfShape from TopTools)
104 ---Purpose: Stores in <L> the images of images of...images of <S>.
105 -- <L> contains only <S> if HasImage(S) is false.
106 is static;
107
108 Compact (me : in out)
109 ---Purpose: Keeps only the link between roots and lastimage.
110 is static;
111
112 Filter (me : in out;
113 S : Shape from TopoDS;
114 ShapeType : ShapeEnum from TopAbs);
115 ---Purpose: Deletes in the images the shape of type <ShapeType>
116 -- which are not in <S>.
117 -- Warning: Compact() must be call before.
118
119fields
120
121 roots : ListOfShape from TopTools;
122 up : DataMapOfShapeShape from TopTools;
123 down : DataMapOfShapeListOfShape from TopTools;
124
125end Image;