annotate dwt/graphics/Region.d @ 212:ab60f3309436

reverted the char[] to String and use the an alias.
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:12:38 +0200
parents 25f88bf5a6df
children 36f5cb12e1a2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
23
f5482da87ed8 Image, ImageData
Frank Benoit <benoit@tionex.de>
parents: 20
diff changeset
10 * Port to the D programming language:
f5482da87ed8 Image, ImageData
Frank Benoit <benoit@tionex.de>
parents: 20
diff changeset
11 * Frank Benoit <benoit@tionex.de>
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.graphics.Region;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.DWT;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.DWTError;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import dwt.DWTException;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import dwt.internal.win32.OS;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.graphics.Resource;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 import dwt.graphics.Point;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.graphics.Rectangle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import dwt.graphics.Device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 import tango.text.convert.Format;
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 117
diff changeset
27 import dwt.dwthelper.utils;
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * Instances of this class represent areas of an x-y coordinate
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * system that are aggregates of the areas covered by a number
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * of polygons.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * Application code must explicitly invoke the <code>Region.dispose()</code>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * method to release the operating system resources managed by each instance
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * when those instances are no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 public final class Region : Resource {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * the OS resource for the region
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * (Warning: This field is platform dependent)
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * public API. It is marked public only so that it can be shared
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 * within the packages provided by DWT. It is not available on all
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * platforms and should never be accessed from application code.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 public HRGN handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * Constructs a new empty region.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * @exception DWTError <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * <li>ERROR_NO_HANDLES if a handle could not be obtained for region creation</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 public this () {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 this(null);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * Constructs a new empty region.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * You must dispose the region when it is no longer required.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * @param device the device on which to allocate the region
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * @exception DWTError <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * <li>ERROR_NO_HANDLES if a handle could not be obtained for region creation</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * @see #dispose
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 public this (Device device) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 if (device is null) device = Device.getDevice();
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 this.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 handle = OS.CreateRectRgn (0, 0, 0, 0);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 if (handle is null) DWT.error(DWT.ERROR_NO_HANDLES);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 if (device.tracking) device.new_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * Constructs a new region given a handle to the operating
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * system resources that it should represent.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * @param handle the handle for the result
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 this(Device device, HRGN handle) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 this.device = device;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 this.handle = handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * Adds the given polygon to the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 * @param pointArray points that describe the polygon to merge with the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 public void add (int[] pointArray) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 if (pointArray is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
117
25f88bf5a6df Only one file was damaged
Frank Benoit <benoit@tionex.de>
parents: 115
diff changeset
123 static if (OS.IsWinCE) DWT.error(DWT.ERROR_NOT_IMPLEMENTED);
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 auto polyRgn = OS.CreatePolygonRgn(cast(POINT*)pointArray.ptr, pointArray.length / 2, OS.ALTERNATE);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 OS.CombineRgn (handle, handle, polyRgn, OS.RGN_OR);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 OS.DeleteObject (polyRgn);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 * Adds the given rectangle to the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 * @param rect the rectangle to merge with the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 public void add (Rectangle rect) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 add (rect.x, rect.y, rect.width, rect.height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 * Adds the given rectangle to the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 * @param x the x coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 * @param y the y coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 * @param width the width coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 * @param height the height coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
161 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
162 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
163 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
164 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
165 * @since 3.1
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
166 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
167 public void add (int x, int y, int width, int height) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
168 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
169 if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
170 auto rectRgn = OS.CreateRectRgn (x, y, x + width, y + height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
171 OS.CombineRgn (handle, handle, rectRgn, OS.RGN_OR);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
172 OS.DeleteObject (rectRgn);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
173 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
174
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
175 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
176 * Adds all of the polygons which make up the area covered
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
177 * by the argument to the collection of polygons the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
178 * maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
179 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
180 * @param region the region to merge
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
181 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
182 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
183 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
184 * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
185 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
186 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
187 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
188 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
189 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
190 public void add (Region region) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
191 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
192 if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
193 if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
194 OS.CombineRgn (handle, handle, region.handle, OS.RGN_OR);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
195 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
196
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
197 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
198 * Returns <code>true</code> if the point specified by the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
199 * arguments is inside the area specified by the receiver,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
200 * and <code>false</code> otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
201 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
202 * @param x the x coordinate of the point to test for containment
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
203 * @param y the y coordinate of the point to test for containment
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
204 * @return <code>true</code> if the region contains the point and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
205 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
206 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
207 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
208 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
209 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
210 public bool contains (int x, int y) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
211 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
212 return cast(bool) OS.PtInRegion (handle, x, y);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
213 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
214
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
215 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
216 * Returns <code>true</code> if the given point is inside the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
217 * area specified by the receiver, and <code>false</code>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
218 * otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
219 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
220 * @param pt the point to test for containment
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
221 * @return <code>true</code> if the region contains the point and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
222 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
223 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
224 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
225 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
226 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
227 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
228 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
229 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
230 public bool contains (Point pt) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
231 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
232 if (pt is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
233 return contains(pt.x, pt.y);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
234 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
235
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
236 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
237 * Disposes of the operating system resources associated with
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
238 * the region. Applications must dispose of all regions which
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
239 * they allocate.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
240 */
48
9a64a7781bab Added override and alias, first chunk. Thanks torhu for doing this patch.
Frank Benoit <benoit@tionex.de>
parents: 23
diff changeset
241 override public void dispose () {
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
242 if (handle is null) return;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
243 if (device.isDisposed()) return;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
244 OS.DeleteObject(handle);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
245 handle = null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
246 if (device.tracking) device.dispose_Object(this);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
247 device = null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
248 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
249
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
250 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
251 * Compares the argument to the receiver, and returns true
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
252 * if they represent the <em>same</em> object using a class
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
253 * specific comparison.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
254 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
255 * @param object the object to compare with this object
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
256 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
257 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
258 * @see #hashCode
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
259 */
48
9a64a7781bab Added override and alias, first chunk. Thanks torhu for doing this patch.
Frank Benoit <benoit@tionex.de>
parents: 23
diff changeset
260 override public int opEquals (Object object) {
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
261 if (this is object) return true;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
262 if (!(cast(Region)object)) return false;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
263 Region rgn = cast(Region)object;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
264 return handle is rgn.handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
265 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
266
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
267 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
268 * Returns a rectangle which represents the rectangular
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
269 * union of the collection of polygons the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
270 * maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
271 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
272 * @return a bounding rectangle for the region
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
273 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
274 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
275 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
276 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
277 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
278 * @see Rectangle#union
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
279 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
280 public Rectangle getBounds() {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
281 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
282 RECT rect;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
283 OS.GetRgnBox(handle, &rect);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
284 return new Rectangle(rect.left, rect.top, rect.right - rect.left, rect.bottom - rect.top);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
285 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
286
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
287 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
288 * Returns an integer hash code for the receiver. Any two
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
289 * objects that return <code>true</code> when passed to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
290 * <code>equals</code> must return the same value for this
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
291 * method.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
292 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
293 * @return the receiver's hash
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
294 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
295 * @see #equals
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
296 */
48
9a64a7781bab Added override and alias, first chunk. Thanks torhu for doing this patch.
Frank Benoit <benoit@tionex.de>
parents: 23
diff changeset
297 override public hash_t toHash () {
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
298 return cast(hash_t)handle;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
299 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
300
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
301 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
302 * Intersects the given rectangle to the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
303 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
304 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
305 * @param rect the rectangle to intersect with the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
306 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
307 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
308 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
309 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
310 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
311 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
312 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
313 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
314 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
315 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
316 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
317 public void intersect (Rectangle rect) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
318 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
319 if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
320 intersect (rect.x, rect.y, rect.width, rect.height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
321 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
322
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
323 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
324 * Intersects the given rectangle to the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
325 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
326 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
327 * @param x the x coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
328 * @param y the y coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
329 * @param width the width coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
330 * @param height the height coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
331 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
332 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
333 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
334 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
335 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
336 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
337 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
338 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
339 * @since 3.1
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
340 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
341 public void intersect (int x, int y, int width, int height) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
342 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
343 if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
344 auto rectRgn = OS.CreateRectRgn (x, y, x + width, y + height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
345 OS.CombineRgn (handle, handle, rectRgn, OS.RGN_AND);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
346 OS.DeleteObject (rectRgn);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
347 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
348
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
349 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
350 * Intersects all of the polygons which make up the area covered
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
351 * by the argument to the collection of polygons the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
352 * maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
353 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
354 * @param region the region to intersect
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
355 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
356 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
357 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
358 * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
359 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
360 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
361 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
362 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
363 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
364 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
365 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
366 public void intersect (Region region) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
367 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
368 if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
369 if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
370 OS.CombineRgn (handle, handle, region.handle, OS.RGN_AND);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
371 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
372
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
373 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
374 * Returns <code>true</code> if the rectangle described by the
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
375 * arguments intersects with any of the polygons the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
376 * maintains to describe its area, and <code>false</code> otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
377 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
378 * @param x the x coordinate of the origin of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
379 * @param y the y coordinate of the origin of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
380 * @param width the width of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
381 * @param height the height of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
382 * @return <code>true</code> if the rectangle intersects with the receiver, and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
383 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
384 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
385 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
386 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
387 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
388 * @see Rectangle#intersects(Rectangle)
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
389 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
390 public bool intersects (int x, int y, int width, int height) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
391 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
392 RECT r;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
393 OS.SetRect (&r, x, y, x + width, y + height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
394 return cast(bool) OS.RectInRegion (handle, &r);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
395 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
396
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
397 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
398 * Returns <code>true</code> if the given rectangle intersects
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
399 * with any of the polygons the receiver maintains to describe
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
400 * its area and <code>false</code> otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
401 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
402 * @param rect the rectangle to test for intersection
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
403 * @return <code>true</code> if the rectangle intersects with the receiver, and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
404 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
405 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
406 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
407 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
408 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
409 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
410 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
411 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
412 * @see Rectangle#intersects(Rectangle)
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
413 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
414 public bool intersects (Rectangle rect) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
415 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
416 if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
417 return intersects(rect.x, rect.y, rect.width, rect.height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
418 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
419
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
420 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
421 * Returns <code>true</code> if the region has been disposed,
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
422 * and <code>false</code> otherwise.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
423 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
424 * This method gets the dispose state for the region.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
425 * When a region has been disposed, it is an error to
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
426 * invoke any other method using the region.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
427 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
428 * @return <code>true</code> when the region is disposed, and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
429 */
48
9a64a7781bab Added override and alias, first chunk. Thanks torhu for doing this patch.
Frank Benoit <benoit@tionex.de>
parents: 23
diff changeset
430 override public bool isDisposed() {
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
431 return handle is null;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
432 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
433
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
434 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
435 * Returns <code>true</code> if the receiver does not cover any
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
436 * area in the (x, y) coordinate plane, and <code>false</code> if
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
437 * the receiver does cover some area in the plane.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
438 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
439 * @return <code>true</code> if the receiver is empty, and <code>false</code> otherwise
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
440 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
441 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
442 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
443 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
444 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
445 public bool isEmpty () {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
446 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
447 RECT rect;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
448 auto result = OS.GetRgnBox (handle, &rect);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
449 if (result is OS.NULLREGION) return true;
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
450 return ((rect.right - rect.left) <= 0) || ((rect.bottom - rect.top) <= 0);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
451 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
452
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
453 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
454 * Subtracts the given polygon from the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
455 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
456 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
457 * @param pointArray points that describe the polygon to merge with the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
458 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
459 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
460 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
461 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
462 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
463 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
464 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
465 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
466 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
467 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
468 public void subtract (int[] pointArray) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
469 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
470 if (pointArray is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
117
25f88bf5a6df Only one file was damaged
Frank Benoit <benoit@tionex.de>
parents: 115
diff changeset
471 static if (OS.IsWinCE) DWT.error(DWT.ERROR_NOT_IMPLEMENTED);
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
472 auto polyRgn = OS.CreatePolygonRgn(cast(POINT*)pointArray.ptr, pointArray.length / 2, OS.ALTERNATE);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
473 OS.CombineRgn (handle, handle, polyRgn, OS.RGN_DIFF);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
474 OS.DeleteObject (polyRgn);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
475 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
476
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
477 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
478 * Subtracts the given rectangle from the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
479 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
480 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
481 * @param rect the rectangle to subtract from the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
482 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
483 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
484 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
485 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
486 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
487 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
488 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
489 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
490 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
491 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
492 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
493 public void subtract (Rectangle rect) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
494 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
495 if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
496 subtract (rect.x, rect.y, rect.width, rect.height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
497 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
498
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
499 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
500 * Subtracts the given rectangle from the collection of polygons
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
501 * the receiver maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
502 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
503 * @param x the x coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
504 * @param y the y coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
505 * @param width the width coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
506 * @param height the height coordinate of the rectangle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
507 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
508 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
509 * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
510 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
511 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
512 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
513 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
514 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
515 * @since 3.1
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
516 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
517 public void subtract (int x, int y, int width, int height) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
518 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
519 if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
520 auto rectRgn = OS.CreateRectRgn (x, y, x + width, y + height);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
521 OS.CombineRgn (handle, handle, rectRgn, OS.RGN_DIFF);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
522 OS.DeleteObject (rectRgn);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
523 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
524
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
525 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
526 * Subtracts all of the polygons which make up the area covered
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
527 * by the argument from the collection of polygons the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
528 * maintains to describe its area.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
529 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
530 * @param region the region to subtract
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
531 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
532 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
533 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
534 * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
535 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
536 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
537 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
538 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
539 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
540 * @since 3.0
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
541 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
542 public void subtract (Region region) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
543 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
544 if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
545 if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
546 OS.CombineRgn (handle, handle, region.handle, OS.RGN_DIFF);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
547 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
548
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
549 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
550 * Translate all of the polygons the receiver maintains to describe
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
551 * its area by the specified point.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
552 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
553 * @param x the x coordinate of the point to translate
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
554 * @param y the y coordinate of the point to translate
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
555 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
556 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
557 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
558 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
559 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
560 * @since 3.1
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
561 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
562 public void translate (int x, int y) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
563 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
564 OS.OffsetRgn (handle, x, y);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
565 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
566
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
567 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
568 * Translate all of the polygons the receiver maintains to describe
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
569 * its area by the specified point.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
570 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
571 * @param pt the point to translate
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
572 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
573 * @exception IllegalArgumentException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
574 * <li>ERROR_NULL_ARGUMENT - if the argument is null</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
575 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
576 * @exception DWTException <ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
577 * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
578 * </ul>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
579 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
580 * @since 3.1
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
581 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
582 public void translate (Point pt) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
583 if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
584 if (pt is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
585 translate (pt.x, pt.y);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
586 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
587
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
588 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
589 * Returns a string containing a concise, human-readable
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
590 * description of the receiver.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
591 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
592 * @return a string representation of the receiver
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
593 */
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 117
diff changeset
594 override public String toString () {
20
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
595 if (isDisposed()) return "Region {*DISPOSED*}";
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
596 return Format( "Region {{{}}", handle );
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
597 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
598
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
599 /**
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
600 * Invokes platform specific functionality to allocate a new region.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
601 * <p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
602 * <b>IMPORTANT:</b> This method is <em>not</em> part of the public
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
603 * API for <code>Region</code>. It is marked public only so that it
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
604 * can be shared within the packages provided by DWT. It is not
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
605 * available on all platforms, and should never be called from
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
606 * application code.
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
607 * </p>
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
608 *
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
609 * @param device the device on which to allocate the region
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
610 * @param handle the handle for the region
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
611 * @return a new region object containing the specified device and handle
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
612 */
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
613 public static Region win32_new(Device device, HRGN handle) {
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
614 return new Region(device, handle);
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
615 }
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
616
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
617 }