0024166: Unable to create file with "Save" menu of voxeldemo Qt sample
[occt.git] / src / Aspect / Aspect_AspectFillArea.cdl
CommitLineData
b311480e 1-- Created on: 1991-11-04
2-- Created by: NW,JPB,CAL
3-- Copyright (c) 1991-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
7fd59977 5--
b311480e 6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21-- Modified: 15/01/98 ; FMN : Ajout Hidden Line
22-- 08/01/03 ; SAV : Added method and field to control back face interior
23-- color
7fd59977 24
25deferred class AspectFillArea from Aspect
26
27 ---Purpose: Group of attributes for the FACE primitives.
28 -- The attributes are:
29 -- * type of interior
30 -- * type of hatch
31 -- * interior colour
32 -- * border colour
33 -- * type of border
34 -- * thickness of border
35 -- when the value of the group is modified, all graphic
36 -- objects using this group are modified.
37
38
39inherits
40
41 TShared
42
43uses
44
45 Color from Quantity,
46
47 HatchStyle from Aspect,
48 InteriorStyle from Aspect,
49 TypeOfLine from Aspect
50
51raises
52
53 AspectFillAreaDefinitionError from Aspect
54
55is
56
57 Initialize;
58 ---Level: Public
59 ---Purpose: Initialise the constructor
60 -- of Graphic3d_AspectFillArea3d.
61 --
62 -- default values :
63 --
64 -- InteriorStyle = Aspect_IS_EMPTY;
65 -- InteriorColor = Quantity_NOC_CYAN1;
66 -- EdgeColor = Quantity_NOC_WHITE;
67 -- EdgeType = Aspect_TOL_SOLID;
68 -- EdgeWidth = 1.0;
69 -- HatchStyle = Aspect_HS_VERTICAL;
70
71 Initialize ( InteriorStyle : InteriorStyle from Aspect;
72 InteriorColor : Color from Quantity;
73 EdgeColor : Color from Quantity;
74 EdgeLineType : TypeOfLine from Aspect;
75 EdgeLineWidth : Real from Standard )
76 ---Level: Public
77 ---Purpose: Initialise the values for the constructor of
78 -- Graphic3d_AspectFillArea3d.
79 --
80 -- InteriorStyle :
81 -- IS_EMPTY no interior.
82 -- IS_HOLLOW display the boundaries of the surface.
83 -- IS_HATCH display hatched with a hatch style.
84 -- IS_SOLID display the interior entirely filled.
85 --
86 -- EdgeLineType :
87 -- TOL_SOLID continuous
88 -- TOL_DASH dashed
89 -- TOL_DOT dotted
90 -- TOL_DOTDASH mixed
91 --
92 -- default values :
93 -- HatchStyle = Aspect_HS_VERTICAL;
94 --
95 -- Warning: Raises AspectFillAreaDefinitionError if the
96 -- width is a negative value.
97 raises AspectFillAreaDefinitionError from Aspect;
98
99 ---------------------------------------------------
100 -- Category: Methods to modify the class definition
101 ---------------------------------------------------
102
103 SetEdgeColor ( me : mutable;
104 AColor : Color from Quantity );
105 ---Level: Public
106 ---Purpose: Modifies the colour of the edge of the face
107 ---Category: Methods to modify the class definition
108
109 SetEdgeLineType ( me : mutable;
110 AType : TypeOfLine from Aspect );
111 ---Level: Public
112 ---Purpose: Modifies the edge line type
113 ---Category: Methods to modify the class definition
114
115 SetEdgeWidth ( me : mutable;
116 AWidth : Real from Standard )
117 ---Level: Public
118 ---Purpose: Modifies the edge thickness
119 --
120 -- Category: Methods to modify the class definition
121 --
122 -- Warning: Raises AspectFillAreaDefinitionError if the
123 -- width is a negative value.
124 raises AspectFillAreaDefinitionError from Aspect;
125
126 SetHatchStyle ( me : mutable;
127 AStyle : HatchStyle from Aspect );
128 ---Level: Public
129 ---Purpose: Modifies the hatch type used when InteriorStyle
130 -- is IS_HATCH
131 ---Category: Methods to modify the class definition
132
133 SetInteriorColor ( me : mutable;
134 AColor : Color from Quantity );
135 ---Level: Public
136 ---Purpose: Modifies the colour of the interior of the face
137 ---Category: Methods to modify the class definition
138
139 SetBackInteriorColor( me : mutable; color : Color from Quantity );
140 ---Level: Public
141 ---Purpose: Modifies the colour of the interior of the back face
142 ---Category: Methods to modify the class definition
143
144 SetInteriorStyle ( me : mutable;
145 AStyle : InteriorStyle from Aspect );
146 ---Level: Public
147 ---Purpose: Modifies the interior type used for rendering
148 --
149 -- InteriorStyle : IS_EMPTY no interior
150 -- IS_HOLLOW display the boundaries of the surface
151 -- IS_HATCH display hatching
152 -- IS_SOLID display interior entirely filled
153 --
154 ---Category: Methods to modify the class definition
155
156 ----------------------------
157 -- Category: Inquire methods
158 ----------------------------
159
160 HatchStyle ( me )
161 returns HatchStyle from Aspect;
162 ---Level: Public
163 ---Purpose: Returns the hatch type used when InteriorStyle
164 -- is IS_HATCH
165 ---Category: Inquire methods
166
167 Values ( me;
168 AStyle : out InteriorStyle from Aspect;
169 AIntColor : out Color from Quantity;
170 AEdgeColor : out Color from Quantity;
171 AType : out TypeOfLine from Aspect;
172 AWidth : out Real from Standard );
173
174 Values ( me;
175 AStyle : out InteriorStyle from Aspect;
176 AIntColor : out Color from Quantity;
177 BackIntColor : out Color from Quantity;
178 AEdgeColor : out Color from Quantity;
179 AType : out TypeOfLine from Aspect;
180 AWidth : out Real from Standard );
181 ---Level: Public
182 ---Purpose: Returns the current values of the <me> group.
183 ---Category: Inquire methods
184
185--\f
186
187fields
188
189--
190-- Class : Aspect_AspectFillArea
191--
192-- Purpose : Declaration of specific variables in the context of
193-- drawing faces
194--
195-- Reminder : The drawing context of a face is defined by:
196-- - the interior style and color of the face
197-- - the style, color and thickness of the face edge
198--
199
200 -- the interior
201 MyInteriorStyle : InteriorStyle from Aspect;
202 MyInteriorColor : Color from Quantity;
203
204 MyBackInteriorColor : Color from Quantity;
205
206 -- the edge
207 MyEdgeColor : Color from Quantity;
208 MyEdgeType : TypeOfLine from Aspect;
209 MyEdgeWidth : Real from Standard;
210
211 -- the hatch
212 MyHatchStyle : HatchStyle from Aspect;
213
214end AspectFillArea;