Mercurial > projects > dwt-mac
diff dwt/graphics/Region.d @ 0:380af2bdd8e5
Upload of whole dwt tree
author | Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com> |
---|---|
date | Sat, 09 Aug 2008 17:00:02 +0200 |
parents | |
children | 649b8e223d5a |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwt/graphics/Region.d Sat Aug 09 17:00:02 2008 +0200 @@ -0,0 +1,683 @@ +/******************************************************************************* + * Copyright (c) 2000, 2005 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + *******************************************************************************/ +module dwt.graphics.Region; + +import dwt.dwthelper.utils; + + +import dwt.DWT; +import dwt.DWTError; +import dwt.DWTException; +import dwt.internal.Callback; +import dwt.internal.cocoa.NSAffineTransform; +import dwt.internal.cocoa.NSBezierPath; +import dwt.internal.cocoa.NSPoint; +import dwt.internal.cocoa.NSRect; +import dwt.internal.cocoa.OS; + +/** + * Instances of this class represent areas of an x-y coordinate + * system that are aggregates of the areas covered by a number + * of polygons. + * <p> + * Application code must explicitly invoke the <code>Region.dispose()</code> + * method to release the operating system resources managed by each instance + * when those instances are no longer required. + * </p> + */ +public final class Region extends Resource { + /** + * the OS resource for the region + * (Warning: This field is platform dependent) + * <p> + * <b>IMPORTANT:</b> This field is <em>not</em> part of the DWT + * public API. It is marked public only so that it can be shared + * within the packages provided by DWT. It is not available on all + * platforms and should never be accessed from application code. + * </p> + */ + public int handle; + +/** + * Constructs a new empty region. + * + * @exception DWTError <ul> + * <li>ERROR_NO_HANDLES if a handle could not be obtained for region creation</li> + * </ul> + */ +public Region() { + this(null); +} + +/** + * Constructs a new empty region. + * <p> + * You must dispose the region when it is no longer required. + * </p> + * + * @param device the device on which to allocate the region + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li> + * </ul> + * @exception DWTError <ul> + * <li>ERROR_NO_HANDLES if a handle could not be obtained for region creation</li> + * </ul> + * + * @see #dispose + * + * @since 3.0 + */ +public Region(Device device) { + super(device); + handle = OS.NewRgn(); + if (handle is 0) DWT.error(DWT.ERROR_NO_HANDLES); + init(); +} + +Region(Device device, int handle) { + super(device); + this.handle = handle; +} + +/** + * Adds the given polygon to the collection of polygons + * the receiver maintains to describe its area. + * + * @param pointArray points that describe the polygon to merge with the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 +* + */ +public void add (int[] pointArray) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (pointArray is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + add(pointArray, pointArray.length); +} + +void add(int[] pointArray, int count) { + if (count <= 2) return; + int polyRgn = OS.NewRgn(); + OS.OpenRgn(); + OS.MoveTo((short)pointArray[0], (short)pointArray[1]); + for (int i = 1; i < count / 2; i++) { + OS.LineTo((short)pointArray[2 * i], (short)pointArray[2 * i + 1]); + } + OS.LineTo((short)pointArray[0], (short)pointArray[1]); + OS.CloseRgn(polyRgn); + OS.UnionRgn(handle, polyRgn, handle); + OS.DisposeRgn(polyRgn); +} + +/** + * Adds the given rectangle to the collection of polygons + * the receiver maintains to describe its area. + * + * @param rect the rectangle to merge with the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + */ +public void add(Rectangle rect) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + if (rect.width < 0 || rect.height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + add (rect.x, rect.y, rect.width, rect.height); +} + +/** + * Adds the given rectangle to the collection of polygons + * the receiver maintains to describe its area. + * + * @param x the x coordinate of the rectangle + * @param y the y coordinate of the rectangle + * @param width the width coordinate of the rectangle + * @param height the height coordinate of the rectangle + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.1 + */ +public void add(int x, int y, int width, int height) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + int rectRgn = OS.NewRgn(); + short[] r = new short[4]; + OS.SetRect(r, (short)x, (short)y, (short)(x + width),(short)(y + height)); + OS.RectRgn(rectRgn, r); + OS.UnionRgn(handle, rectRgn, handle); + OS.DisposeRgn(rectRgn); +} + +/** + * Adds all of the polygons which make up the area covered + * by the argument to the collection of polygons the receiver + * maintains to describe its area. + * + * @param region the region to merge + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + */ +public void add(Region region) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + OS.UnionRgn(handle, region.handle, handle); +} + +/** + * Returns <code>true</code> if the point specified by the + * arguments is inside the area specified by the receiver, + * and <code>false</code> otherwise. + * + * @param x the x coordinate of the point to test for containment + * @param y the y coordinate of the point to test for containment + * @return <code>true</code> if the region contains the point and <code>false</code> otherwise + * + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + */ +public bool contains(int x, int y) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + short[] point = new short[]{(short)x, (short)y}; + return OS.PtInRgn(point, handle); +} + +/** + * Returns <code>true</code> if the given point is inside the + * area specified by the receiver, and <code>false</code> + * otherwise. + * + * @param pt the point to test for containment + * @return <code>true</code> if the region contains the point and <code>false</code> otherwise + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + */ +public bool contains(Point pt) { + if (pt is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + return contains(pt.x, pt.y); +} + +NSAffineTransform transform; +void convertRgn(NSAffineTransform transform) { + int newRgn = OS.NewRgn(); + Callback callback = new Callback(this, "convertRgn", 4); + int proc = callback.getAddress(); + if (proc is 0) DWT.error(DWT.ERROR_NO_MORE_CALLBACKS); + this.transform = transform; + OS.QDRegionToRects(handle, OS.kQDParseRegionFromTopLeft, proc, newRgn); + this.transform = null; + callback.dispose(); + OS.CopyRgn(newRgn, handle); + OS.DisposeRgn(newRgn); +} + +int convertRgn(int message, int rgn, int r, int newRgn) { + if (message is OS.kQDRegionToRectsMsgParse) { + short[] rect = new short[4]; + OS.memmove(rect, r, rect.length * 2); + NSPoint point = new NSPoint(); + int polyRgn = OS.NewRgn(); + OS.OpenRgn(); + point.x = rect[1]; + point.y = rect[0]; + point = transform.transformPoint(point); + short startX, startY; + OS.MoveTo(startX = (short)point.x, startY = (short)point.y); + point.x = rect[3]; + point.y = rect[0]; + point = transform.transformPoint(point); + OS.LineTo((short)Math.round(point.x), (short)point.y); + point.x = rect[3]; + point.y = rect[2]; + point = transform.transformPoint(point); + OS.LineTo((short)Math.round(point.x), (short)Math.round(point.y)); + point.x = rect[1]; + point.y = rect[2]; + point = transform.transformPoint(point); + OS.LineTo((short)point.x, (short)Math.round(point.y)); + OS.LineTo(startX, startY); + OS.CloseRgn(polyRgn); + OS.UnionRgn(newRgn, polyRgn, newRgn); + OS.DisposeRgn(polyRgn); + } + return 0; +} + +void destroy() { + OS.DisposeRgn(handle); + handle = 0; +} + +/** + * Compares the argument to the receiver, and returns true + * if they represent the <em>same</em> object using a class + * specific comparison. + * + * @param object the object to compare with this object + * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise + * + * @see #hashCode + */ +public bool equals(Object object) { + if (this is object) return true; + if (!(object instanceof Region)) return false; + Region region = (Region)object; + return handle is region.handle; +} + +/** + * Returns a rectangle which represents the rectangular + * union of the collection of polygons the receiver + * maintains to describe its area. + * + * @return a bounding rectangle for the region + * + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @see Rectangle#union + */ +public Rectangle getBounds() { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + short[] bounds = new short[4]; + OS.GetRegionBounds(handle, bounds); + int width = bounds[3] - bounds[1]; + int height = bounds[2] - bounds[0]; + return new Rectangle(bounds[1], bounds[0], width, height); +} + +NSBezierPath getPath() { + Callback callback = new Callback(this, "regionToRects", 4); + if (callback.getAddress() is 0) DWT.error(DWT.ERROR_NO_MORE_CALLBACKS); + NSBezierPath path = NSBezierPath.bezierPath(); + path.retain(); + OS.QDRegionToRects(handle, OS.kQDParseRegionFromTopLeft, callback.getAddress(), path.id); + callback.dispose(); + if (path.isEmpty()) path.appendBezierPathWithRect(new NSRect()); + return path; +} + +NSPoint pt = new NSPoint(); +short[] rect = new short[4]; +int regionToRects(int message, int rgn, int r, int path) { + if (message is OS.kQDRegionToRectsMsgParse) { + OS.memmove(rect, r, rect.length * 2); + pt.x = rect[1]; + pt.y = rect[0]; + OS.objc_msgSend(path, OS.sel_moveToPoint_1, pt); + pt.x = rect[3]; + OS.objc_msgSend(path, OS.sel_lineToPoint_1, pt); + pt.x = rect[3]; + pt.y = rect[2]; + OS.objc_msgSend(path, OS.sel_lineToPoint_1, pt); + pt.x = rect[1]; + OS.objc_msgSend(path, OS.sel_lineToPoint_1, pt); + OS.objc_msgSend(path, OS.sel_closePath); + } + return 0; +} + +public static Region carbon_new(Device device, int handle) { + return new Region(device, handle); +} + +/** + * Returns an integer hash code for the receiver. Any two + * objects that return <code>true</code> when passed to + * <code>equals</code> must return the same value for this + * method. + * + * @return the receiver's hash + * + * @see #equals + */ +public int hashCode() { + return handle; +} + +/** + * Intersects the given rectangle to the collection of polygons + * the receiver maintains to describe its area. + * + * @param rect the rectangle to intersect with the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ +public void intersect(Rectangle rect) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + intersect (rect.x, rect.y, rect.width, rect.height); +} + +/** + * Intersects the given rectangle to the collection of polygons + * the receiver maintains to describe its area. + * + * @param x the x coordinate of the rectangle + * @param y the y coordinate of the rectangle + * @param width the width coordinate of the rectangle + * @param height the height coordinate of the rectangle + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.1 + */ +public void intersect(int x, int y, int width, int height) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + int rectRgn = OS.NewRgn(); + short[] r = new short[4]; + OS.SetRect(r, (short)x, (short)y, (short)(x + width),(short)(y + height)); + OS.RectRgn(rectRgn, r); + OS.SectRgn(handle, rectRgn, handle); + OS.DisposeRgn(rectRgn); +} + +/** + * Intersects all of the polygons which make up the area covered + * by the argument to the collection of polygons the receiver + * maintains to describe its area. + * + * @param region the region to intersect + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ +public void intersect(Region region) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + OS.SectRgn(handle, region.handle, handle); +} + +/** + * Returns <code>true</code> if the rectangle described by the + * arguments intersects with any of the polygons the receiver + * maintains to describe its area, and <code>false</code> otherwise. + * + * @param x the x coordinate of the origin of the rectangle + * @param y the y coordinate of the origin of the rectangle + * @param width the width of the rectangle + * @param height the height of the rectangle + * @return <code>true</code> if the rectangle intersects with the receiver, and <code>false</code> otherwise + * + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @see Rectangle#intersects(Rectangle) + */ +public bool intersects (int x, int y, int width, int height) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + short[] r = new short[4]; + OS.SetRect(r, (short)x, (short)y, (short)(x + width),(short)(y + height)); + return OS.RectInRgn(rect, handle); +} + +/** + * Returns <code>true</code> if the given rectangle intersects + * with any of the polygons the receiver maintains to describe + * its area and <code>false</code> otherwise. + * + * @param rect the rectangle to test for intersection + * @return <code>true</code> if the rectangle intersects with the receiver, and <code>false</code> otherwise + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @see Rectangle#intersects(Rectangle) + */ +public bool intersects(Rectangle rect) { + if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + return intersects(rect.x, rect.y, rect.width, rect.height); +} + +/** + * Returns <code>true</code> if the region has been disposed, + * and <code>false</code> otherwise. + * <p> + * This method gets the dispose state for the region. + * When a region has been disposed, it is an error to + * invoke any other method using the region. + * + * @return <code>true</code> when the region is disposed, and <code>false</code> otherwise + */ +public bool isDisposed() { + return handle is 0; +} + +/** + * Returns <code>true</code> if the receiver does not cover any + * area in the (x, y) coordinate plane, and <code>false</code> if + * the receiver does cover some area in the plane. + * + * @return <code>true</code> if the receiver is empty, and <code>false</code> otherwise + * + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + */ +public bool isEmpty() { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + return OS.EmptyRgn(handle); +} + +/** + * Subtracts the given polygon from the collection of polygons + * the receiver maintains to describe its area. + * + * @param pointArray points that describe the polygon to merge with the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ +public void subtract (int[] pointArray) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (pointArray is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + if (pointArray.length < 2) return; + int polyRgn = OS.NewRgn(); + OS.OpenRgn(); + OS.MoveTo((short)pointArray[0], (short)pointArray[1]); + for (int i = 1; i < pointArray.length / 2; i++) { + OS.LineTo((short)pointArray[2 * i], (short)pointArray[2 * i + 1]); + } + OS.LineTo((short)pointArray[0], (short)pointArray[1]); + OS.CloseRgn(polyRgn); + OS.DiffRgn(handle, polyRgn, handle); + OS.DisposeRgn(polyRgn); +} + +/** + * Subtracts the given rectangle from the collection of polygons + * the receiver maintains to describe its area. + * + * @param rect the rectangle to subtract from the receiver + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ +public void subtract(Rectangle rect) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (rect is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + subtract (rect.x, rect.y, rect.width, rect.height); +} + +/** + * Subtracts the given rectangle from the collection of polygons + * the receiver maintains to describe its area. + * + * @param x the x coordinate of the rectangle + * @param y the y coordinate of the rectangle + * @param width the width coordinate of the rectangle + * @param height the height coordinate of the rectangle + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_INVALID_ARGUMENT - if the rectangle's width or height is negative</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.1 + */ +public void subtract(int x, int y, int width, int height) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (width < 0 || height < 0) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + int rectRgn = OS.NewRgn(); + short[] r = new short[4]; + OS.SetRect(r, (short)x, (short)y, (short)(x + width),(short)(y + height)); + OS.RectRgn(rectRgn, r); + OS.DiffRgn(handle, rectRgn, handle); + OS.DisposeRgn(rectRgn); +} + +/** + * Subtracts all of the polygons which make up the area covered + * by the argument from the collection of polygons the receiver + * maintains to describe its area. + * + * @param region the region to subtract + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * <li>ERROR_INVALID_ARGUMENT - if the argument has been disposed</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.0 + */ +public void subtract(Region region) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (region is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + if (region.isDisposed()) DWT.error(DWT.ERROR_INVALID_ARGUMENT); + OS.DiffRgn(handle, region.handle, handle); +} + +/** + * Translate all of the polygons the receiver maintains to describe + * its area by the specified point. + * + * @param x the x coordinate of the point to translate + * @param y the y coordinate of the point to translate + * + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.1 + */ +public void translate (int x, int y) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + OS.OffsetRgn (handle, (short)x, (short)y); +} + +/** + * Translate all of the polygons the receiver maintains to describe + * its area by the specified point. + * + * @param pt the point to translate + * + * @exception IllegalArgumentException <ul> + * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> + * </ul> + * @exception DWTException <ul> + * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> + * </ul> + * + * @since 3.1 + */ +public void translate (Point pt) { + if (isDisposed()) DWT.error(DWT.ERROR_GRAPHIC_DISPOSED); + if (pt is null) DWT.error(DWT.ERROR_NULL_ARGUMENT); + translate (pt.x, pt.y); +} + +/** + * Returns a string containing a concise, human-readable + * description of the receiver. + * + * @return a string representation of the receiver + */ +public String toString () { + if (isDisposed()) return "Region {*DISPOSED*}"; + return "Region {" + handle + "}"; +} +}