geotrellis.vector.affine.PointTransformationMethods.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geotrellis-vector_2.11 Show documentation

GeoTrellis is an open source geographic data processing engine for high performance applications.

There is a newer version: 0.10.3

Show newest version

package geotrellis.vector.affine

import geotrellis.util.MethodExtensions
import geotrellis.vector.Point

/** Trait used to implicitly extend [[Point]] instances with transformation methods */
trait PointTransformationMethods extends MethodExtensions[Point] {

  /** Transform this point according to a provided [[AffineTransformation]] instance
    * @param trans  an AffineTransformation
    */
  def transform(trans: AffineTransformation) = trans.transform(self)

  /** Reflect this Point over the provided point */
  def reflect(p: Point): Point =
    reflect(p.x, p.y)

  /** Reflect this Point over the line between two points */
  def reflect(x: Double, y: Double): Point =
    Reflection(x, y).transform(self)

  /** Reflect this Point over the line between two points */
  def reflect(p0: Point, p1: Point): Point =
    reflect(p0.x, p0.y, p1.x, p1.y)

  /** Reflect this Point over the line between two points */
  def reflect(x0: Double, y0: Double, x1: Double, y1: Double): Point =
    Reflection(x0, y0, x1, y1).transform(self)

  /** Rotate this Point about its origin by the specified radians
    * @param theta  The number of radians about the origin to rotate this Point. Positive
    *               numbers correspond to counter-clockwise rotation
    */
  def rotate(theta: Double): Point =
    Rotation(theta).transform(self)

  /** Rotate this Point about its origin by the specified radians
    * @param sinTheta  The sin of the angle angle about the origin to rotate this Point
    * @param cosTheta  The cosin of the angle about the origin to rotate this Point
    */
  def rotate(sinTheta: Double, cosTheta: Double): Point =
    Rotation(sinTheta, cosTheta).transform(self)

  /** Change the scale of this Point
    * @param xscale  the updated scale on the x-axis
    * @param yscale  the updated scale on the y-axis
    */
  def scale(xscale: Double, yscale: Double): Point =
    Scaling(xscale, yscale).transform(self)

  /** Shear the provided Point
    * @param xshear  Shear on the x axis
    * @param yshear  Shear on the y axis
    */
  def shear(xshear: Double, yshear: Double): Point =
    Shearing(xshear, yshear).transform(self)

  /** Translate the provided Point
    * @param x  the value to translate by in the x direction
    * @param y  the value to translate by in the y direction
    */
  def translate(x: Double, y: Double): Point =
    Translation(x, y).transform(self)

}