Transform2S (Apache Commons Geometry Spherical 1.0 API)

java.lang.Object
- org.apache.commons.geometry.spherical.twod.Transform2S

All Implemented Interfaces:

Function<Point2S,Point2S>, UnaryOperator<Point2S>, Transform<Point2S>
```
public final class Transform2S
extends Object
implements Transform<Point2S>
```
Implementation of the Transform interface for spherical 2D points.
This class uses an AffineTransformMatrix3D to perform spherical point transforms in Euclidean 3D space.

Instances of this class are guaranteed to be immutable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Point2S`	`apply(Point2S pt)`
`static Transform2S`	`createReflection(Point2S pole)` Create a transform that performs a reflection across the equatorial plane defined by the given pole point.
`static Transform2S`	`createReflection(Vector3D poleVector)` Create a transform that performs a reflection across the equatorial plane defined by the given pole point.
`static Transform2S`	`createRotation(Point2S pt, double angle)` Create a transform that rotates the given angle around `pt`.
`static Transform2S`	`createRotation(QuaternionRotation quaternion)` Create a transform that performs the given 3D rotation.
`static Transform2S`	`createRotation(Vector3D axis, double angle)` Create a transform that rotates the given angle around `axis`.
`boolean`	`equals(Object obj)` Return true if the given object is an instance of `Transform2S` and the underlying Euclidean transform matrices are exactly equal.
`AffineTransformMatrix3D`	`getEuclideanTransform()` Get the Euclidean transform matrix underlying the spherical transform.
`int`	`hashCode()`
`static Transform2S`	`identity()` Return an instance representing the identity transform.
`Transform2S`	`inverse()`
`Transform2S`	`multiply(Transform2S other)` Multiply the underlying Euclidean transform of this instance by that of the argument, eg, `other * this`.
`Transform2S`	`premultiply(Transform2S other)` Multiply the underlying Euclidean transform matrix of the argument by that of this instance, eg, `this * other`.
`boolean`	`preservesOrientation()`
`Transform2S`	`reflect(Point2S pole)` Apply a reflection across the equatorial plane defined by the given pole point to this instance.
`Transform2S`	`reflect(Vector3D poleVector)` Apply a reflection across the equatorial plane defined by the given pole vector to this instance.
`Transform2S`	`rotate(Point2S pt, double angle)` Apply a rotation of `angle` radians around the given point to this instance.
`Transform2S`	`rotate(QuaternionRotation quaternion)` Apply the given quaternion rotation to this instance.
`Transform2S`	`rotate(Vector3D axis, double angle)` Apply a rotation of `angle` radians around the given 3D axis to this instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function
andThen, compose

- Method Detail
  - getEuclideanTransform
```
public AffineTransformMatrix3D getEuclideanTransform()
```
    Get the Euclidean transform matrix underlying the spherical transform.
    
    Returns:
    
    the Euclidean transform matrix underlying the spherical transform
  - apply
```
public Point2S apply(Point2S pt)
```
    Specified by:
    
    apply in interface Function<Point2S,Point2S>
  - preservesOrientation
```
public boolean preservesOrientation()
```
    Specified by:
    
    preservesOrientation in interface Transform<Point2S>
  - inverse
```
public Transform2S inverse()
```
    Specified by:
    
    inverse in interface Transform<Point2S>
  - rotate
```
public Transform2S rotate(Point2S pt,
                          double angle)
```
    Apply a rotation of angle radians around the given point to this instance.
    
    Parameters:
    
    pt - point to rotate around
    
    angle - rotation angle in radians
    
    Returns:
    
    transform resulting from applying the specified rotation to this instance
  - rotate
```
public Transform2S rotate(Vector3D axis,
                          double angle)
```
    Apply a rotation of angle radians around the given 3D axis to this instance.
    
    Parameters:
    
    axis - 3D axis of rotation
    
    angle - rotation angle in radians
    
    Returns:
    
    transform resulting from applying the specified rotation to this instance
  - rotate
```
public Transform2S rotate(QuaternionRotation quaternion)
```
    Apply the given quaternion rotation to this instance.
    
    Parameters:
    
    quaternion - quaternion rotation to apply
    
    Returns:
    
    transform resulting from applying the specified rotation to this instance
  - reflect
```
public Transform2S reflect(Point2S pole)
```
    Apply a reflection across the equatorial plane defined by the given pole point to this instance.
    
    Parameters:
    
    pole - pole point defining the equatorial reflection plane
    
    Returns:
    
    transform resulting from applying the specified reflection to this instance
  - reflect
```
public Transform2S reflect(Vector3D poleVector)
```
    Apply a reflection across the equatorial plane defined by the given pole vector to this instance.
    
    Parameters:
    
    poleVector - pole vector defining the equatorial reflection plane
    
    Returns:
    
    transform resulting from applying the specified reflection to this instance
  - multiply
```
public Transform2S multiply(Transform2S other)
```
    Multiply the underlying Euclidean transform of this instance by that of the argument, eg, other * this. The returned transform performs the equivalent of other followed by this.
    
    Parameters:
    
    other - transform to multiply with
    
    Returns:
    
    a new transform computed by multiplying the matrix of this instance by that of the argument
    
    See Also:
    
    AffineTransformMatrix3D.multiply(AffineTransformMatrix3D)
  - premultiply
```
public Transform2S premultiply(Transform2S other)
```
    Multiply the underlying Euclidean transform matrix of the argument by that of this instance, eg, this * other. The returned transform performs the equivalent of this followed by other.
    
    Parameters:
    
    other - transform to multiply with
    
    Returns:
    
    a new transform computed by multiplying the matrix of the argument by that of this instance
    
    See Also:
    
    AffineTransformMatrix3D.premultiply(AffineTransformMatrix3D)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Return true if the given object is an instance of Transform2S and the underlying Euclidean transform matrices are exactly equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - object to test for equality with the current instance
    
    Returns:
    
    true if the underlying transform matrices are exactly equal
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - identity
```
public static Transform2S identity()
```
    Return an instance representing the identity transform. This transform is guaranteed to return an equivalent (ie, co-located) point for any input point. However, the points are not guaranteed to contain exactly equal coordinates. For example, at the poles, an infinite number of points exist that vary only in the azimuth coordinate. When one of these points is transformed by this identity transform, the returned point may contain a different azimuth value from the input, but it will still represent the same location in space.
    
    Specified by:
    
    identity in interface Function<Point2S,Point2S>
    
    Specified by:
    
    identity in interface UnaryOperator<Point2S>
    
    Returns:
    
    an instance representing the identity transform
  - createRotation
```
public static Transform2S createRotation(Point2S pt,
                                         double angle)
```
    Create a transform that rotates the given angle around pt.
    
    Parameters:
    
    pt - point to rotate around
    
    angle - angle of rotation in radians
    
    Returns:
    
    a transform that rotates the given angle around pt
  - createRotation
```
public static Transform2S createRotation(Vector3D axis,
                                         double angle)
```
    Create a transform that rotates the given angle around axis.
    
    Parameters:
    
    axis - 3D axis of rotation
    
    angle - angle of rotation in radians
    
    Returns:
    
    a transform that rotates the given angle axis
  - createRotation
```
public static Transform2S createRotation(QuaternionRotation quaternion)
```
    Create a transform that performs the given 3D rotation.
    
    Parameters:
    
    quaternion - quaternion instance representing the 3D rotation
    
    Returns:
    
    a transform that performs the given 3D rotation
  - createReflection
```
public static Transform2S createReflection(Point2S pole)
```
    Create a transform that performs a reflection across the equatorial plane defined by the given pole point.
    
    Parameters:
    
    pole - pole point defining the equatorial reflection plane
    
    Returns:
    
    a transform that performs a reflection across the equatorial plane defined by the given pole point
  - createReflection
```
public static Transform2S createReflection(Vector3D poleVector)
```
    Create a transform that performs a reflection across the equatorial plane defined by the given pole point.
    
    Parameters:
    
    poleVector - pole vector defining the equatorial reflection plane
    
    Returns:
    
    a transform that performs a reflection across the equatorial plane defined by the given pole point

Class Transform2S

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Method Detail

getEuclideanTransform

apply

preservesOrientation

inverse

rotate

rotate

rotate

reflect

reflect

multiply

premultiply

hashCode

equals

toString

identity

createRotation

createRotation

createRotation

createReflection

createReflection