annotate dwt/graphics/Point.d @ 238:380bad9f6852

reverted char[] to String
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:42:55 +0200
parents df23b11d0b70
children c0d810de7093
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
1 /*******************************************************************************
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
11 * Frank Benoit <benoit@tionex.de>
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
13 module dwt.graphics.Point;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 188
diff changeset
15 import dwt.dwthelper.utils;
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 188
diff changeset
16
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
18 public import dwt.internal.SerializableCompatibility;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 import tango.text.convert.Format;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * Instances of this class represent places on the (x, y)
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * coordinate plane.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * The coordinate space for rectangles and points is considered
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * to have increasing values downward and to the right from its
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * origin making this the normal, computer graphics oriented notion
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * of (x, y) coordinates rather than the strict mathematical one.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * The hashCode() method in this class uses the values of the public
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * fields to compute the hash value. When storing instances of the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * class in hashed collections, do not modify these fields after the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * object has been inserted.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * Application code does <em>not</em> need to explicitly release the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * resources managed by each instance when those instances are no longer
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * required, and thus no <code>dispose()</code> method is provided.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * @see Rectangle
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 public final class Point : SerializableCompatibility {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
48 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
49 * the x coordinate of the point
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
50 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
51 public int x;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
53 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
54 * the y coordinate of the point
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
55 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
56 public int y;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
58 //static final long serialVersionUID = 3257002163938146354L;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * Constructs a new point with the given x and y coordinates.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * @param x the x coordinate of the new point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * @param y the y coordinate of the new point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 public this (int x, int y) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
67 this.x = x;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
68 this.y = y;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * Compares the argument to the receiver, and returns true
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * if they represent the <em>same</em> object using a class
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * specific comparison.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * @param object the object to compare with this object
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * @see #hashCode()
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 public override int opEquals (Object object) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
82 if (object is this) return true;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
83 if ( auto p = cast(Point)object ){
148
ee9953d47114 some ==/is replacements, thanks torhu for bug report
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
84 return (p.x is this.x) && (p.y is this.y);
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 return false;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * Returns an integer hash code for the receiver. Any two
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * objects that return <code>true</code> when passed to
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * <code>equals</code> must return the same value for this
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * method.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * @return the receiver's hash
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * @see #equals(Object)
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 */
188
df23b11d0b70 minor changes to be more compatible to dwt-win, fixed potetial ==/is bugs.
Frank Benoit <benoit@tionex.de>
parents: 177
diff changeset
99 override public hash_t toHash () {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
100 return x ^ y;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * Returns a string containing a concise, human-readable
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * description of the receiver.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * @return a string representation of the point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 188
diff changeset
109 override public String toString () {
177
5e10b057a923 Fix toString message
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
110 return Format( "Point {{{}, {}}", x, y );; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114