annotate dwt/graphics/Region.d @ 213:36f5cb12e1a2

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