#region Copyright & License Information /* * Copyright 2007-2021 The OpenRA Developers (see AUTHORS) * This file is part of OpenRA, which is free software. It is made * available to you under the terms of the GNU General Public License * as published by the Free Software Foundation, either version 3 of * the License, or (at your option) any later version. For more * information, see COPYING. */ #endregion using System; using Eluant; using Eluant.ObjectBinding; using OpenRA.Scripting; namespace OpenRA { public readonly struct CPos : IScriptBindable, ILuaAdditionBinding, ILuaSubtractionBinding, ILuaEqualityBinding, ILuaTableBinding, IEquatable { // Coordinates are packed in a 32 bit signed int // X and Y are 12 bits (signed): -2048...2047 // Layer is an unsigned byte // Packing is XXXX XXXX XXXX YYYY YYYY YYYY LLLL LLLL public readonly int Bits; // X is padded to MSB, so bit shift does the correct sign extension public int X => Bits >> 20; // Align Y with a short, cast, then shift the rest of the way // The signed short bit shift does the correct sign extension public int Y => ((short)(Bits >> 4)) >> 4; public byte Layer => (byte)Bits; public CPos(int bits) { Bits = bits; } public CPos(int x, int y) : this(x, y, 0) { } public CPos(int x, int y, byte layer) { Bits = (x & 0xFFF) << 20 | (y & 0xFFF) << 8 | layer; } public static readonly CPos Zero = new CPos(0, 0, 0); public static explicit operator CPos(int2 a) { return new CPos(a.X, a.Y); } public static CPos operator +(CVec a, CPos b) { return new CPos(a.X + b.X, a.Y + b.Y, b.Layer); } public static CPos operator +(CPos a, CVec b) { return new CPos(a.X + b.X, a.Y + b.Y, a.Layer); } public static CPos operator -(CPos a, CVec b) { return new CPos(a.X - b.X, a.Y - b.Y, a.Layer); } public static CVec operator -(CPos a, CPos b) { return new CVec(a.X - b.X, a.Y - b.Y); } public static bool operator ==(CPos me, CPos other) { return me.Bits == other.Bits; } public static bool operator !=(CPos me, CPos other) { return !(me == other); } public override int GetHashCode() { return Bits.GetHashCode(); } public bool Equals(CPos other) { return Bits == other.Bits; } public override bool Equals(object obj) { return obj is CPos && Equals((CPos)obj); } public override string ToString() { if (Layer == 0) return X + "," + Y; return X + "," + Y + "," + Layer; } public MPos ToMPos(Map map) { return ToMPos(map.Grid.Type); } public MPos ToMPos(MapGridType gridType) { if (gridType == MapGridType.Rectangular) return new MPos(X, Y); // Convert from RectangularIsometric cell (x, y) position to rectangular map position (u, v) // - The staggered rows make this fiddly (hint: draw a diagram!) // (a) Consider the relationships: // - +1x (even -> odd) adds (0, 1) to (u, v) // - +1x (odd -> even) adds (1, 1) to (u, v) // - +1y (even -> odd) adds (-1, 1) to (u, v) // - +1y (odd -> even) adds (0, 1) to (u, v) // (b) Therefore: // - ax + by adds (a - b)/2 to u (only even increments count) // - ax + by adds a + b to v var u = (X - Y) / 2; var v = X + Y; return new MPos(u, v); } #region Scripting interface public LuaValue Add(LuaRuntime runtime, LuaValue left, LuaValue right) { if (!left.TryGetClrValue(out CPos a) || !right.TryGetClrValue(out CVec b)) throw new LuaException($"Attempted to call CPos.Add(CPos, CVec) with invalid arguments ({left.WrappedClrType().Name}, {right.WrappedClrType().Name})"); return new LuaCustomClrObject(a + b); } public LuaValue Subtract(LuaRuntime runtime, LuaValue left, LuaValue right) { var rightType = right.WrappedClrType(); if (!left.TryGetClrValue(out CPos a)) throw new LuaException($"Attempted to call CPos.Subtract(CPos, (CPos|CVec)) with invalid arguments ({left.WrappedClrType().Name}, {rightType.Name})"); if (rightType == typeof(CPos)) { right.TryGetClrValue(out CPos b); return new LuaCustomClrObject(a - b); } else if (rightType == typeof(CVec)) { right.TryGetClrValue(out CVec b); return new LuaCustomClrObject(a - b); } throw new LuaException($"Attempted to call CPos.Subtract(CPos, (CPos|CVec)) with invalid arguments ({left.WrappedClrType().Name}, {rightType.Name})"); } public LuaValue Equals(LuaRuntime runtime, LuaValue left, LuaValue right) { if (!left.TryGetClrValue(out CPos a) || !right.TryGetClrValue(out CPos b)) return false; return a == b; } public LuaValue this[LuaRuntime runtime, LuaValue key] { get { switch (key.ToString()) { case "X": return X; case "Y": return Y; case "Layer": return Layer; default: throw new LuaException($"CPos does not define a member '{key}'"); } } set => throw new LuaException("CPos is read-only. Use CPos.New to create a new value"); } #endregion } }