From b8eac1296c09a292ae3f033347ccd306a5edbd62 Mon Sep 17 00:00:00 2001 From: Adam Date: Tue, 17 Apr 2018 22:35:06 -0400 Subject: [PATCH] Add Angle and Direction Extend GameObject.getOrientation() to account for object flags, and return an Angle --- .../java/net/runelite/api/GameObject.java | 5 +- .../java/net/runelite/api/coords/Angle.java | 69 +++++++++++++++++++ .../net/runelite/api/coords/Direction.java | 33 +++++++++ .../net/runelite/api/coords/AngleTest.java | 44 ++++++++++++ .../runelite/mixins/RSGameObjectMixin.java | 14 +++- .../net/runelite/rs/api/RSGameObject.java | 3 +- 6 files changed, 162 insertions(+), 6 deletions(-) create mode 100644 runelite-api/src/main/java/net/runelite/api/coords/Angle.java create mode 100644 runelite-api/src/main/java/net/runelite/api/coords/Direction.java create mode 100644 runelite-api/src/test/java/net/runelite/api/coords/AngleTest.java diff --git a/runelite-api/src/main/java/net/runelite/api/GameObject.java b/runelite-api/src/main/java/net/runelite/api/GameObject.java index 894f155c8c..499b0f6f46 100644 --- a/runelite-api/src/main/java/net/runelite/api/GameObject.java +++ b/runelite-api/src/main/java/net/runelite/api/GameObject.java @@ -25,6 +25,7 @@ package net.runelite.api; import java.awt.Polygon; +import net.runelite.api.coords.Angle; /** * @@ -32,8 +33,6 @@ import java.awt.Polygon; */ public interface GameObject extends TileObject { - int getFlags(); - /** * Returns the min x,y for this game object * @@ -50,4 +49,6 @@ public interface GameObject extends TileObject Point getRegionMaxLocation(); Polygon getConvexHull(); + + Angle getOrientation(); } diff --git a/runelite-api/src/main/java/net/runelite/api/coords/Angle.java b/runelite-api/src/main/java/net/runelite/api/coords/Angle.java new file mode 100644 index 0000000000..62d11c24cd --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/coords/Angle.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2018, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.runelite.api.coords; + +import lombok.Value; +import static net.runelite.api.coords.Direction.EAST; +import static net.runelite.api.coords.Direction.NORTH; +import static net.runelite.api.coords.Direction.SOUTH; +import static net.runelite.api.coords.Direction.WEST; + +@Value +public class Angle +{ + /** + * angle, 0-2047. + * 0 is south, west is 512, south is 1024, east is 1536s + */ + private final int angle; + + /** + * Get the nearest N/S/E/W direction for this angle + * @return + */ + public Direction getNearestDirection() + { + int round = angle >>> 9; + int up = angle & 256; + if (up != 0) + { + // round up + ++round; + } + switch (round & 3) + { + case 0: + return SOUTH; + case 1: + return WEST; + case 2: + return NORTH; + case 3: + return EAST; + default: + throw new IllegalStateException(); + } + } +} diff --git a/runelite-api/src/main/java/net/runelite/api/coords/Direction.java b/runelite-api/src/main/java/net/runelite/api/coords/Direction.java new file mode 100644 index 0000000000..7c436e2208 --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/coords/Direction.java @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2018, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.runelite.api.coords; + +public enum Direction +{ + NORTH, + SOUTH, + EAST, + WEST; +} diff --git a/runelite-api/src/test/java/net/runelite/api/coords/AngleTest.java b/runelite-api/src/test/java/net/runelite/api/coords/AngleTest.java new file mode 100644 index 0000000000..7f7a2f1548 --- /dev/null +++ b/runelite-api/src/test/java/net/runelite/api/coords/AngleTest.java @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2018, Adam + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR + * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +package net.runelite.api.coords; + +import static net.runelite.api.coords.Direction.NORTH; +import static net.runelite.api.coords.Direction.WEST; +import static org.junit.Assert.assertEquals; +import org.junit.Test; + +public class AngleTest +{ + + @Test + public void getNearestDirection() + { + Angle angle = new Angle(512 + 10); + assertEquals(WEST, angle.getNearestDirection()); + + angle = new Angle(512 + 256 + 1); + assertEquals(NORTH, angle.getNearestDirection()); + } +} \ No newline at end of file diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/RSGameObjectMixin.java b/runelite-mixins/src/main/java/net/runelite/mixins/RSGameObjectMixin.java index ec8695b03d..3d33f48387 100644 --- a/runelite-mixins/src/main/java/net/runelite/mixins/RSGameObjectMixin.java +++ b/runelite-mixins/src/main/java/net/runelite/mixins/RSGameObjectMixin.java @@ -28,6 +28,7 @@ import java.awt.Polygon; import java.awt.geom.Area; import net.runelite.api.Perspective; import net.runelite.api.Point; +import net.runelite.api.coords.Angle; import net.runelite.api.mixins.Inject; import net.runelite.api.mixins.Mixin; import net.runelite.api.mixins.Shadow; @@ -79,7 +80,7 @@ public abstract class RSGameObjectMixin implements RSGameObject @Override public Area getClickbox() { - return Perspective.getClickbox(client, getModel(), getOrientation(), getX(), getY()); + return Perspective.getClickbox(client, getModel(), getRsOrientation(), getX(), getY()); } @Inject @@ -93,6 +94,15 @@ public abstract class RSGameObjectMixin implements RSGameObject return null; } - return model.getConvexHull(getX(), getY(), getOrientation()); + return model.getConvexHull(getX(), getY(), getRsOrientation()); + } + + @Override + @Inject + public Angle getOrientation() + { + int orientation = getRsOrientation(); + int rotation = (getFlags() >> 6) & 3; + return new Angle(rotation * 512 + orientation); } } diff --git a/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java b/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java index f62b24e8ed..c0aff49eb6 100644 --- a/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSGameObject.java @@ -59,13 +59,12 @@ public interface RSGameObject extends GameObject int getHeight(); @Import("orientation") - int getOrientation(); + int getRsOrientation(); @Import("hash") @Override int getHash(); - @Override @Import("flags") int getFlags(); }