agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r2.jar)

Class ScreenOverlayRotationPoint

java.lang.Object

agi.foundation.graphics.advanced.ScreenOverlayRotationPoint

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class ScreenOverlayRotationPoint
extends Object
implements ImmutableValueType

The origin of rotation of a ScreenOverlay.

Constructor Summary

Constructors

Constructor and Description
ScreenOverlayRotationPoint() Initializes a new instance.
ScreenOverlayRotationPoint(double x, double y) Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).
ScreenOverlayRotationPoint(double x, double y, boolean relativeToParent) Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).
ScreenOverlayRotationPoint(ScreenOverlayOrigin rotationOrigin) Initializes a new instance with the rotation point defined by the given origin within the rotated overlay.
ScreenOverlayRotationPoint(ScreenOverlayOrigin rotationOrigin, boolean relativeToParent) Initializes a new instance with the rotation point defined by the given origin.
ScreenOverlayRotationPoint(ScreenOverlayPoint rotationPoint) Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).
ScreenOverlayRotationPoint(ScreenOverlayPoint rotationPoint, boolean relativeToParent) Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).
ScreenOverlayRotationPoint(ScreenOverlayPoint rotationPoint, ScreenOverlayOrigin rotationOrigin) Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).
ScreenOverlayRotationPoint(ScreenOverlayPoint rotationPoint, ScreenOverlayOrigin rotationOrigin, boolean relativeToParent) Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
ScreenOverlayOrigin	getOrigin() Gets the origin of rotation.
ScreenOverlayPoint	getPoint() Gets the point that the overlay is rotated around, defined relative to Origin (get).
boolean	getRelativeToParent() Gets a value indicating whether the rotation point is relative to the overlay's parent, or to the overlay itself.
boolean	getUseOriginAsPoint() Gets a value indicating whether the Origin (get) property will be used as the rotation point.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint()

Initializes a new instance.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayOrigin rotationOrigin)

Initializes a new instance with the rotation point defined by the given origin within the rotated overlay.

Parameters:

rotationOrigin - The origin around which the overlay is rotated.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayOrigin rotationOrigin,
                                  boolean relativeToParent)

Initializes a new instance with the rotation point defined by the given origin. The origin can be within the rotated overlay itself or within its parent.

Parameters:

rotationOrigin - The origin around which the overlay is rotated.

relativeToParent - When true, the rotationOrigin is within rotated overlay's parent; Otherwise, the rotationOrigin is within the rotated overlay itself.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(double x,
                                  double y)

Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).

Parameters:

x - The X position of the rotation point, in pixels.

y - The Y position of the rotation point, in pixels.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(double x,
                                  double y,
                                  boolean relativeToParent)

Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).

Parameters:

x - The X position of the rotation point, in pixels.

y - The Y position of the rotation point, in pixels.

relativeToParent - When true, the specified x and y position is within the rotated overlay's parent; Otherwise, the position is within the rotated overlay itself.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayPoint rotationPoint)

Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).

Parameters:

rotationPoint - The rotation point.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayPoint rotationPoint,
                                  boolean relativeToParent)

Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).

Parameters:

rotationPoint - The rotation point.

relativeToParent - When true, the specified rotationPoint is within the rotated overlay's parent; Otherwise, the position is within the rotated overlay itself.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayPoint rotationPoint,
                                  @Nonnull
                                  ScreenOverlayOrigin rotationOrigin)

Initializes a new instance with a rotation point specified relative to the overlay's Origin (get / set).

Parameters:

rotationPoint - The rotation point.

rotationOrigin - The rotation point's anchor.

ScreenOverlayRotationPoint

public ScreenOverlayRotationPoint(@Nonnull
                                  ScreenOverlayPoint rotationPoint,
                                  @Nonnull
                                  ScreenOverlayOrigin rotationOrigin,
                                  boolean relativeToParent)

Initializes a new instance with a rotation point specified relative to the overlay's or the overlay's parent's Origin (get / set).

Parameters:

rotationPoint - The rotation point.

rotationOrigin - The rotation point's anchor.

relativeToParent - When true, the rotationOrigin is within rotated overlay's parent; Otherwise, the rotationOrigin is within the rotated overlay itself.

Method Detail

getUseOriginAsPoint

public final boolean getUseOriginAsPoint()

Gets a value indicating whether the Origin (get) property will be used as the rotation point. If false, the Point (get) property is used.

getRelativeToParent

public final boolean getRelativeToParent()

Gets a value indicating whether the rotation point is relative to the overlay's parent, or to the overlay itself.

getOrigin

@Nonnull
public final ScreenOverlayOrigin getOrigin()

Gets the origin of rotation. When the UseOriginAsPoint (get) property is true, the overlay is rotated around this origin. When UseOriginAsPoint (get) property is false, the overlay is rotated around Point (get), which is defined relative to this origin.

getPoint

@Nonnull
public final ScreenOverlayPoint getPoint()

Gets the point that the overlay is rotated around, defined relative to Origin (get). When UseOriginAsPoint (get) is true, this property is ignored and the overlay is rotated around the Origin (get) itself.

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)