summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/CursorPosition.cs
blob: 079917f246b1fcd23ca26e3063587a34cd66285f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
using Microsoft.Xna.Framework;

namespace StardewModdingAPI.Framework
{
    /// <summary>Defines a position on a given map at different reference points.</summary>
    internal class CursorPosition : ICursorPosition
    {
        /*********
        ** Accessors
        *********/
        /// <summary>The pixel position relative to the top-left corner of the in-game map.</summary>
        public Vector2 AbsolutePixels { get; }

        /// <summary>The pixel position relative to the top-left corner of the visible screen.</summary>
        public Vector2 ScreenPixels { get; }

        /// <summary>The tile position under the cursor relative to the top-left corner of the map.</summary>
        public Vector2 Tile { get; }

        /// <summary>The tile position that the game considers under the cursor for purposes of clicking actions. This may be different than <see cref="Tile"/> if that's too far from the player.</summary>
        public Vector2 GrabTile { get; }


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="absolutePixels">The pixel position relative to the top-left corner of the in-game map.</param>
        /// <param name="screenPixels">The pixel position relative to the top-left corner of the visible screen.</param>
        /// <param name="tile">The tile position relative to the top-left corner of the map.</param>
        /// <param name="grabTile">The tile position that the game considers under the cursor for purposes of clicking actions.</param>
        public CursorPosition(Vector2 absolutePixels, Vector2 screenPixels, Vector2 tile, Vector2 grabTile)
        {
            this.AbsolutePixels = absolutePixels;
            this.ScreenPixels = screenPixels;
            this.Tile = tile;
            this.GrabTile = grabTile;
        }

        /// <summary>Get whether the current object is equal to another object of the same type.</summary>
        /// <param name="other">An object to compare with this object.</param>
        public bool Equals(ICursorPosition other)
        {
            return other != null && this.AbsolutePixels == other.AbsolutePixels;
        }
    }
}