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