8be8bc6adf0d0efdd0708692c71f83e70e6fd9ae
[occt.git] / src / HLRBRep / HLRBRep_InternalAlgo.cdl
1 -- File:        HLRBRep_InternalAlgo.cdl
2 -- Created:     Thu Apr 17 20:45:25 1997
3 -- Author:      Christophe MARION
4 --              <cma@partox.paris1.matra-dtv.fr>
5 ---Copyright:    Matra Datavision 1997
6
7 class InternalAlgo from HLRBRep inherits TShared from MMgt
8
9 uses
10     Address          from Standard,
11     Boolean          from Standard,
12     Integer          from Standard,
13     Projector        from HLRAlgo,
14     Data             from HLRBRep,
15     ShapeBounds      from HLRBRep,
16     SeqOfShapeBounds from HLRBRep,
17     OutLiner         from HLRTopoBRep,
18     MapOfShapeTool   from BRepTopAdaptor,
19     TShared          from MMgt
20
21 raises
22     OutOfRange   from Standard
23     
24 is
25     Create returns mutable InternalAlgo from HLRBRep;
26     
27     Create(A : InternalAlgo from HLRBRep)
28     returns mutable InternalAlgo from HLRBRep;
29     
30     Projector(me: mutable; P : Projector from HLRAlgo)
31         ---Purpose: set the projector.
32     is static;
33
34     Projector(me: mutable)
35     returns  Projector from HLRAlgo
36         ---Purpose: set the projector.
37         ---C++: return &
38     is static;
39
40     Update(me: mutable)
41         ---Purpose: update the DataStructure.
42     is static;
43
44     Load(me : mutable; S     : OutLiner from HLRTopoBRep;
45                        SData : TShared  from MMgt;
46                        nbIso : Integer  from Standard = 0)
47         ---Purpose: add the shape <S>.
48     is static;
49     
50     Load(me : mutable; S     : OutLiner from HLRTopoBRep;
51                        nbIso : Integer  from Standard = 0)
52         ---Purpose: add the shape <S>.
53     is static;
54     
55     Index(me; S : OutLiner from HLRTopoBRep) returns Integer from Standard
56         ---Purpose: return the index of the Shape <S> and  return 0 if
57         --          the Shape <S> is not found.
58     is static;
59
60     Remove(me : mutable; I : Integer from Standard)
61     raises OutOfRange from Standard
62         ---Purpose: remove the Shape of Index <I>.
63     is static;
64
65     ShapeData(me : mutable; I     : Integer from Standard;
66                             SData : TShared from MMgt)
67     raises OutOfRange from Standard
68         ---Purpose: Change the Shape Data of the Shape of index <I>.
69     is static;
70     
71     SeqOfShapeBounds(me : mutable) returns SeqOfShapeBounds from HLRBRep
72         ---C++: return &
73     is static;
74     
75     NbShapes(me) returns Integer from Standard
76     is static;
77     
78     ShapeBounds(me : mutable; I : Integer from Standard)
79     returns ShapeBounds from HLRBRep
80     raises OutOfRange from Standard
81         ---C++: return &
82     is static;
83     
84     InitEdgeStatus(me : mutable)
85         ---Purpose: init the status of the selected edges depending of
86         --          the back faces of a closed shell.
87     is static;
88     
89     Select(me : mutable)
90         ---Purpose: select all the DataStructure.
91     is static;
92     
93     Select(me : mutable; I : Integer from Standard)
94     raises OutOfRange from Standard
95         ---Purpose: select  only   the Shape of index <I>.
96     is static;
97     
98     SelectEdge(me : mutable; I : Integer from Standard)
99     raises OutOfRange from Standard
100         ---Purpose: select only the edges of the Shape <S>.
101     is static;
102     
103     SelectFace(me : mutable; I : Integer from Standard)
104     raises OutOfRange from Standard
105         ---Purpose: select only the faces of the Shape <S>.
106     is static;
107     
108     ShowAll(me : mutable)
109         ---Purpose: set to visible all the edges.
110     is static;
111     
112     ShowAll(me : mutable; I : Integer from Standard)
113     raises OutOfRange from Standard
114         ---Purpose: set to visible all the edges of the Shape <S>.
115     is static;
116     
117     HideAll(me : mutable)
118         ---Purpose: set to hide all the edges.
119     is static;
120     
121     HideAll(me : mutable; I : Integer from Standard)
122     raises OutOfRange from Standard
123         ---Purpose: set to  hide all the  edges of the  Shape <S>.
124     is static;
125     
126     PartialHide(me : mutable)
127         ---Purpose: own hiding  of all the shapes of the DataStructure
128         --          without hiding by each other.
129     is static;
130     
131     Hide(me : mutable)
132         ---Purpose: hide all the DataStructure.
133     is static;
134     
135     Hide(me : mutable; I : Integer from Standard)
136     raises OutOfRange from Standard
137         ---Purpose: hide the Shape <S> by itself.
138     is static;
139     
140     Hide(me : mutable; I,J : Integer from Standard)
141     raises OutOfRange from Standard
142         ---Purpose: hide the Shape <S1> by the shape <S2>.
143     is static;
144     
145     HideSelected(me : mutable; I        : Integer from Standard;
146                                SideFace : Boolean from Standard)
147         ---Purpose: first if <SideFace> own hiding  of the side faces.
148         --          After hiding  of    the  selected  parts  of   the
149         --          DataStructure.
150     is static private;
151     
152     Debug(me : mutable; deb : Boolean from Standard)
153     is static;
154     
155     Debug(me) returns Boolean from Standard
156     is static;
157     
158     DataStructure(me) returns any Data from HLRBRep
159     is static;
160     
161 fields
162     myDS             : Data             from HLRBRep;
163     myProj           : Projector        from HLRAlgo;
164     myShapes         : SeqOfShapeBounds from HLRBRep;
165     myMapOfShapeTool : MapOfShapeTool   from BRepTopAdaptor;
166
167     myDebug       : Boolean          from Standard;
168
169 end Algo;