From 412c02cbaa22dbbb53ea9f5f15effbd36a7c6c34 Mon Sep 17 00:00:00 2001
From: Ray Greenwell <ray@threerings.net>
Date: Tue, 23 May 2006 22:12:30 +0000
Subject: [PATCH] Whoops! I forgot to check in the new StageLocation class,
 also added a log error message to my equals() logic error checking.

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4141 542714f4-19e9-0310-aa3c-eee0fc999fb1
---
 .../threerings/stage/data/StageLocation.java  | 133 ++++++++++++++++++
 .../whirled/spot/data/SceneLocation.java      |   2 +
 2 files changed, 135 insertions(+)
 create mode 100644 src/java/com/threerings/stage/data/StageLocation.java

diff --git a/src/java/com/threerings/stage/data/StageLocation.java b/src/java/com/threerings/stage/data/StageLocation.java
new file mode 100644
index 000000000..5c7c6d523
--- /dev/null
+++ b/src/java/com/threerings/stage/data/StageLocation.java
@@ -0,0 +1,133 @@
+//
+// $Id: Location.java 3726 2005-10-11 19:17:43Z ray $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library is free software; you can redistribute it and/or modify it
+// under the terms of the GNU Lesser General Public License as published
+// by the Free Software Foundation; either version 2.1 of the License, or
+// (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.stage.data;
+
+import com.threerings.io.SimpleStreamableObject;
+
+import com.threerings.util.DirectionCodes;
+import com.threerings.util.DirectionUtil;
+
+import com.threerings.whirled.spot.data.Location;
+
+/**
+ * Contains information on a scene occupant's position and orientation.
+ */
+public class StageLocation extends SimpleStreamableObject
+    implements Location
+{
+    /** The user's x position (interpreted by the display system). */
+    public int x;
+
+    /** The user's y position (interpreted by the display system). */
+    public int y;
+
+    /** The user's orientation (defined by {@link DirectionCodes}). */
+    public byte orient;
+
+    /** {@link #toString} helper function. */
+    public String orientToString ()
+    {
+        return DirectionUtil.toShortString(orient);
+    }
+
+    /**
+     * A zero-argument constructor used when unserializing instances.
+     */
+    public StageLocation ()
+    {
+    }
+
+    /**
+     * Constructs a location with the specified coordinates and
+     * orientation.
+     */
+    public StageLocation (int x, int y, byte orient)
+    {
+        this.x = x;
+        this.y = y;
+        this.orient = orient;
+
+        if (orient == -1) {
+            Thread.dumpStack();
+        }
+    }
+
+    // documentation inherited from interface Location
+    public Location getOpposite ()
+    {
+        StageLocation opp = (StageLocation) clone();
+        opp.orient = (byte) DirectionUtil.getOpposite(orient);
+        return opp;
+    }
+
+    /**
+     * Location equivalence means that the coordinates and orientation are
+     * the same.
+     */
+    public boolean equivalent (Location oloc)
+    {
+        return equals(oloc) && (orient == ((StageLocation) oloc).orient);
+    }
+
+    /**
+     * Location equality is determined by coordinates.
+     */
+    public boolean equals (Object other)
+    {
+        // TEMP
+        if (other instanceof com.threerings.whirled.spot.data.SceneLocation) {
+            com.threerings.stage.Log.warning(
+                "Illegal compare of SceneLocation and Location!!!");
+            Thread.dumpStack(); // this will help us find logic errors,
+            // as a SceneLocation and a Location shouldn't be compared..
+        }
+        // END: temp
+
+        if (other instanceof StageLocation) {
+            StageLocation that = (StageLocation) other;
+            return (this.x == that.x) && (this.y == that.y);
+
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Computes a reasonable hashcode for location instances.
+     */
+    public int hashCode ()
+    {
+        return x ^ y;
+    }
+
+    /**
+     * Creates a clone of this instance.
+     */
+    public Object clone ()
+    {
+        try {
+            return (StageLocation)super.clone();
+        } catch (CloneNotSupportedException cnse) {
+            throw new RuntimeException("StageLocation.clone() failed " + cnse);
+        }
+    }
+}
diff --git a/src/java/com/threerings/whirled/spot/data/SceneLocation.java b/src/java/com/threerings/whirled/spot/data/SceneLocation.java
index 47aa3afec..9d077479c 100644
--- a/src/java/com/threerings/whirled/spot/data/SceneLocation.java
+++ b/src/java/com/threerings/whirled/spot/data/SceneLocation.java
@@ -68,6 +68,8 @@ public class SceneLocation extends SimpleStreamableObject
     {
         // TEMP
         if (other instanceof Location) {
+            com.threerings.whirled.spot.Log.warning(
+                "Illegal compare of SceneLocation and Location!!!");
             Thread.dumpStack(); // this will help us find logic errors,
             // as a SceneLocation and a Location shouldn't be compared
         }