tools.aqua.bgw.util.Coordinate.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bgw-core Show documentation
A framework for board game applications.
There is a newer version: 0.5
/*
 *    Copyright 2021 The BoardGameWork Authors
 *    SPDX-License-Identifier: Apache-2.0
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

@file:Suppress("unused")

package tools.aqua.bgw.util

import tools.aqua.bgw.util.Trig.Companion.cosD
import tools.aqua.bgw.util.Trig.Companion.sinD

/**
 * A Coordinate containing [xCoord] and [yCoord].
 *
 * @constructor Creates a [Coordinate] with given [xCoord] and [yCoord].
 *
 * @param xCoord The x coordinate.
 * @param yCoord The y coordinate.
 */
open class Coordinate(xCoord: Number = 0, yCoord: Number = 0) {
	
	/**
	 * X coordinate.
	 */
	val xCoord: Double = xCoord.toDouble()
	
	/**
	 * Y coordinate.
	 */
	val yCoord: Double = yCoord.toDouble()
	
	/**
	 * Returns a new coordinate object containing added [xCoord] and [yCoord].
	 *
	 * @param other [Coordinate] to add.
	 *
	 * @return New coordinate object containing added [xCoord] and [yCoord].
	 */
	operator fun plus(other: Coordinate): Coordinate = Coordinate(
		xCoord + other.xCoord,
		yCoord + other.yCoord
	)
	
	/**
	 * Returns a new coordinate object containing subtracted [xCoord] and [yCoord].
	 *
	 * @param other [Coordinate] to subtract.
	 *
	 * @return New coordinate object containing subtracted [xCoord] and [yCoord].
	 */
	operator fun minus(other: Coordinate): Coordinate = Coordinate(
		xCoord - other.xCoord,
		yCoord - other.yCoord
	)
	
	/**
	 * Returns a new coordinate object containing multiplied [Coordinate] with [factor].
	 *
	 * @param factor factor to multiply with.
	 *
	 * @return New coordinate object containing multiplied [Coordinate] with [factor].
	 */
	operator fun times(factor: Number): Coordinate = Coordinate(
		xCoord * factor.toDouble(),
		yCoord * factor.toDouble()
	)
	
	/**
	 * Returns a new coordinate object containing divided [Coordinate] by [denominator].
	 *
	 * @param denominator denominator to divide by.
	 *
	 * @return New coordinate object containing divided [Coordinate] by [denominator].
	 */
	operator fun div(denominator: Number): Coordinate = Coordinate(
		xCoord / denominator.toDouble(),
		yCoord / denominator.toDouble()
	)
	
	
	/**
	 * Rotates [Coordinate] by [angle] degrees around center point.
	 *
	 * With
	 *
	 * - Angle t,
	 *
	 * - Center point Z
	 *
	 * - Coordinate P
	 *
	 *
	 * [ cos(phi)  -sin(phi) ] * [ Px - Zx ] + [ Zx ] = [ cos(phi)*(Px-Zx) - sin(phi)*(Py-Zy) + Zx ]
	 *
	 * [ sin(phi)   cos(phi) ]   [ Py - Zy ]   [ Zy ]   [ sin(phi)*(Px-Zx) + cos(phi)*(Py-Zy) + Zy ]
	 */
	fun rotated(angle: Number, center: Coordinate): Coordinate = Coordinate(
		xCoord = cosD(angle) * (xCoord - center.xCoord) - sinD(angle) * (yCoord - center.yCoord) + center.xCoord,
		yCoord = sinD(angle) * (xCoord - center.xCoord) + cosD(angle) * (yCoord - center.yCoord) + center.yCoord
	)
	
	/**
	 * Rotates coordinate by angle degrees around point (0,0).
	 *
	 * With
	 *
	 * - Angle t,
	 *
	 * - Center point Z
	 *
	 * - Coordinate P
	 *
	 *
	 * [ cos(phi)  -sin(phi) ] * [ Px - Zx ] + [ Zx ] = [ cos(phi)*(Px-Zx) - sin(phi)*(Py-Zy) + Zx ]
	 *
	 * [ sin(phi)   cos(phi) ]   [ Py - Zy ]   [ Zy ]   [ sin(phi)*(Px-Zx) + cos(phi)*(Py-Zy) + Zy ]
	 */
	fun rotated(angle: Double): Coordinate = rotated(angle, Coordinate(0, 0))
	
	/**
	 * Prints [xCoord] and [yCoord] as String.
	 */
	override fun toString(): String = "X = $xCoord, Y = $yCoord"
	
	/**
	 * Compares coordinate to another Object.
	 *
	 * @return `true` if other object is Coordinate and [xCoord] == other.xCoord && [yCoord] == other.yCoord.
	 */
	override fun equals(other: Any?): Boolean {
		if (other !is Coordinate)
			return false
		
		return this.xCoord == other.xCoord && this.yCoord == other.yCoord
	}
	
	/**
	 * HashCode for this object.
	 *
	 * @return HashCode containing [xCoord] and [yCoord].
	 */
	override fun hashCode(): Int = xCoord.hashCode() - yCoord.hashCode()
}