annotate dwt/graphics/Point.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 8cec8f536af3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
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
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.graphics.Point;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
14 public import dwt.internal.SerializableCompatibility;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import tango.text.convert.Format;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * Instances of this class represent places on the (x, y)
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * coordinate plane.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * The coordinate space for rectangles and points is considered
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * to have increasing values downward and to the right from its
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * origin making this the normal, computer graphics oriented notion
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * of (x, y) coordinates rather than the strict mathematical one.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * The hashCode() method in this class uses the values of the public
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * fields to compute the hash value. When storing instances of the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * class in hashed collections, do not modify these fields after the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * object has been inserted.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * </p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * <p>
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * Application code does <em>not</em> need to explicitly release the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * resources managed by each instance when those instances are no longer
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * required, and thus no <code>dispose()</code> method is provided.
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 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * @see Rectangle
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 public final class Point : SerializableCompatibility {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
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 * the x coordinate of the point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 public int x;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * the y coordinate of the point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 public int y;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 //static final long serialVersionUID = 3257002163938146354L;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * Constructs a new point with the given x and y coordinates.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * @param x the x coordinate of the new point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * @param y the y coordinate of the new point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 public this (int x, int y) {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 this.x = x;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 this.y = y;
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
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * Compares the argument to the receiver, and returns true
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * if they represent the <em>same</em> object using a class
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * specific comparison.
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 * @param object the object to compare with this object
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * @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
74 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * @see #hashCode()
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 public override int opEquals (Object object) {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 if (object is this) return true;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 if ( auto p = cast(Point)object ){
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 return (p.x == this.x) && (p.y == this.y);
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 return false;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84
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 * Returns an integer hash code for the receiver. Any two
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * objects that return <code>true</code> when passed to
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * <code>equals</code> must return the same value for this
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * method.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * @return the receiver's hash
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * @see #equals(Object)
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 public hash_t toHash () {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 return x ^ y;
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * Returns a string containing a concise, human-readable
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * description of the receiver.
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 * @return a string representation of the point
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 public char[] toString () {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 return Format( "Point {}, {}}", x, y );; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110