b311480e |
1 | -- Created on: 1991-11-04 |
2 | -- Created by: NW,JPB,CAL |
3 | -- Copyright (c) 1991-1999 Matra Datavision |
973c2be1 |
4 | -- Copyright (c) 1999-2014 OPEN CASCADE SAS |
7fd59977 |
5 | -- |
973c2be1 |
6 | -- This file is part of Open CASCADE Technology software library. |
b311480e |
7 | -- |
973c2be1 |
8 | -- This library is free software; you can redistribute it and / or modify it |
9 | -- under the terms of the GNU Lesser General Public 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. |
b311480e |
13 | -- |
973c2be1 |
14 | -- Alternatively, this file may be used under the terms of Open CASCADE |
15 | -- commercial license or contractual agreement. |
b311480e |
16 | |
7fd59977 |
17 | -- Modified: 15/01/98 ; FMN : Ajout Hidden Line |
18 | -- 08/01/03 ; SAV : Added method and field to control back face interior |
19 | -- color |
7fd59977 |
20 | |
21 | deferred class AspectFillArea from Aspect |
22 | |
23 | ---Purpose: Group of attributes for the FACE primitives. |
24 | -- The attributes are: |
25 | -- * type of interior |
26 | -- * type of hatch |
27 | -- * interior colour |
28 | -- * border colour |
29 | -- * type of border |
30 | -- * thickness of border |
31 | -- when the value of the group is modified, all graphic |
32 | -- objects using this group are modified. |
33 | |
34 | |
35 | inherits |
36 | |
37 | TShared |
38 | |
39 | uses |
40 | |
41 | Color from Quantity, |
42 | |
43 | HatchStyle from Aspect, |
44 | InteriorStyle from Aspect, |
45 | TypeOfLine from Aspect |
46 | |
47 | raises |
48 | |
49 | AspectFillAreaDefinitionError from Aspect |
50 | |
51 | is |
52 | |
53 | Initialize; |
54 | ---Level: Public |
55 | ---Purpose: Initialise the constructor |
56 | -- of Graphic3d_AspectFillArea3d. |
57 | -- |
58 | -- default values : |
59 | -- |
60 | -- InteriorStyle = Aspect_IS_EMPTY; |
61 | -- InteriorColor = Quantity_NOC_CYAN1; |
62 | -- EdgeColor = Quantity_NOC_WHITE; |
63 | -- EdgeType = Aspect_TOL_SOLID; |
64 | -- EdgeWidth = 1.0; |
65 | -- HatchStyle = Aspect_HS_VERTICAL; |
66 | |
67 | Initialize ( InteriorStyle : InteriorStyle from Aspect; |
68 | InteriorColor : Color from Quantity; |
69 | EdgeColor : Color from Quantity; |
70 | EdgeLineType : TypeOfLine from Aspect; |
71 | EdgeLineWidth : Real from Standard ) |
72 | ---Level: Public |
73 | ---Purpose: Initialise the values for the constructor of |
74 | -- Graphic3d_AspectFillArea3d. |
75 | -- |
76 | -- InteriorStyle : |
77 | -- IS_EMPTY no interior. |
78 | -- IS_HOLLOW display the boundaries of the surface. |
79 | -- IS_HATCH display hatched with a hatch style. |
80 | -- IS_SOLID display the interior entirely filled. |
81 | -- |
82 | -- EdgeLineType : |
83 | -- TOL_SOLID continuous |
84 | -- TOL_DASH dashed |
85 | -- TOL_DOT dotted |
86 | -- TOL_DOTDASH mixed |
87 | -- |
88 | -- default values : |
89 | -- HatchStyle = Aspect_HS_VERTICAL; |
90 | -- |
91 | -- Warning: Raises AspectFillAreaDefinitionError if the |
92 | -- width is a negative value. |
93 | raises AspectFillAreaDefinitionError from Aspect; |
94 | |
95 | --------------------------------------------------- |
96 | -- Category: Methods to modify the class definition |
97 | --------------------------------------------------- |
98 | |
99 | SetEdgeColor ( me : mutable; |
100 | AColor : Color from Quantity ); |
101 | ---Level: Public |
102 | ---Purpose: Modifies the colour of the edge of the face |
103 | ---Category: Methods to modify the class definition |
104 | |
105 | SetEdgeLineType ( me : mutable; |
106 | AType : TypeOfLine from Aspect ); |
107 | ---Level: Public |
108 | ---Purpose: Modifies the edge line type |
109 | ---Category: Methods to modify the class definition |
110 | |
111 | SetEdgeWidth ( me : mutable; |
112 | AWidth : Real from Standard ) |
113 | ---Level: Public |
114 | ---Purpose: Modifies the edge thickness |
115 | -- |
116 | -- Category: Methods to modify the class definition |
117 | -- |
118 | -- Warning: Raises AspectFillAreaDefinitionError if the |
119 | -- width is a negative value. |
120 | raises AspectFillAreaDefinitionError from Aspect; |
121 | |
122 | SetHatchStyle ( me : mutable; |
123 | AStyle : HatchStyle from Aspect ); |
124 | ---Level: Public |
125 | ---Purpose: Modifies the hatch type used when InteriorStyle |
126 | -- is IS_HATCH |
127 | ---Category: Methods to modify the class definition |
128 | |
129 | SetInteriorColor ( me : mutable; |
130 | AColor : Color from Quantity ); |
131 | ---Level: Public |
132 | ---Purpose: Modifies the colour of the interior of the face |
133 | ---Category: Methods to modify the class definition |
134 | |
135 | SetBackInteriorColor( me : mutable; color : Color from Quantity ); |
136 | ---Level: Public |
137 | ---Purpose: Modifies the colour of the interior of the back face |
138 | ---Category: Methods to modify the class definition |
139 | |
140 | SetInteriorStyle ( me : mutable; |
141 | AStyle : InteriorStyle from Aspect ); |
142 | ---Level: Public |
143 | ---Purpose: Modifies the interior type used for rendering |
144 | -- |
145 | -- InteriorStyle : IS_EMPTY no interior |
146 | -- IS_HOLLOW display the boundaries of the surface |
147 | -- IS_HATCH display hatching |
148 | -- IS_SOLID display interior entirely filled |
149 | -- |
150 | ---Category: Methods to modify the class definition |
151 | |
152 | ---------------------------- |
153 | -- Category: Inquire methods |
154 | ---------------------------- |
155 | |
156 | HatchStyle ( me ) |
157 | returns HatchStyle from Aspect; |
158 | ---Level: Public |
159 | ---Purpose: Returns the hatch type used when InteriorStyle |
160 | -- is IS_HATCH |
161 | ---Category: Inquire methods |
162 | |
163 | Values ( me; |
164 | AStyle : out InteriorStyle from Aspect; |
165 | AIntColor : out Color from Quantity; |
166 | AEdgeColor : out Color from Quantity; |
167 | AType : out TypeOfLine from Aspect; |
168 | AWidth : out Real from Standard ); |
169 | |
170 | Values ( me; |
171 | AStyle : out InteriorStyle from Aspect; |
172 | AIntColor : out Color from Quantity; |
173 | BackIntColor : out Color from Quantity; |
174 | AEdgeColor : out Color from Quantity; |
175 | AType : out TypeOfLine from Aspect; |
176 | AWidth : out Real from Standard ); |
177 | ---Level: Public |
178 | ---Purpose: Returns the current values of the <me> group. |
179 | ---Category: Inquire methods |
180 | |
181 | --\f |
182 | |
183 | fields |
184 | |
185 | -- |
186 | -- Class : Aspect_AspectFillArea |
187 | -- |
188 | -- Purpose : Declaration of specific variables in the context of |
189 | -- drawing faces |
190 | -- |
191 | -- Reminder : The drawing context of a face is defined by: |
192 | -- - the interior style and color of the face |
193 | -- - the style, color and thickness of the face edge |
194 | -- |
195 | |
196 | -- the interior |
197 | MyInteriorStyle : InteriorStyle from Aspect; |
198 | MyInteriorColor : Color from Quantity; |
199 | |
200 | MyBackInteriorColor : Color from Quantity; |
201 | |
202 | -- the edge |
203 | MyEdgeColor : Color from Quantity; |
204 | MyEdgeType : TypeOfLine from Aspect; |
205 | MyEdgeWidth : Real from Standard; |
206 | |
207 | -- the hatch |
208 | MyHatchStyle : HatchStyle from Aspect; |
209 | |
210 | end AspectFillArea; |