agi.foundation.graphics.advanced

(agi.foundation.graphics-2025r1.jar)

Class ScreenOverlayPoint

java.lang.Object

agi.foundation.graphics.advanced.ScreenOverlayPoint

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class ScreenOverlayPoint
extends Object
implements ImmutableValueType

Describes the position of a screen overlay.

Constructor Summary

Constructors

Constructor and Description
ScreenOverlayPoint() Initializes a new instance.
ScreenOverlayPoint(double x, double y) Initializes a new instance with a specified position in pixels.
ScreenOverlayPoint(double x, double y, ScreenOverlayUnit xUnit, ScreenOverlayUnit yUnit) Initializes a new instance with a specified position expressed in specified units.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
double	getX() Gets the X position of the overlay.
ScreenOverlayUnit	getXUnit() Gets the unit with which the X (get) property is represented.
double	getY() Gets the Y position of the overlay.
ScreenOverlayUnit	getYUnit() Gets the unit with which the Y (get) property is represented.
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

ScreenOverlayPoint

public ScreenOverlayPoint()

Initializes a new instance.

ScreenOverlayPoint

public ScreenOverlayPoint(double x,
                          double y)

Initializes a new instance with a specified position in pixels.

Parameters:

x - The X position in pixels.

y - The Y position in pixels.

ScreenOverlayPoint

public ScreenOverlayPoint(double x,
                          double y,
                          @Nonnull
                          ScreenOverlayUnit xUnit,
                          @Nonnull
                          ScreenOverlayUnit yUnit)

Initializes a new instance with a specified position expressed in specified units.

Parameters:

x - The X position in the unit specified by xUnit.

y - The Y position in the unit specified by yUnit.

xUnit - The unit of the x position.

yUnit - The unit of the y position.

Method Detail

getX

public final double getX()

Gets the X position of the overlay. The unit is specified by the XUnit (get) property.

getY

public final double getY()

Gets the Y position of the overlay. The unit is specified by the YUnit (get) property.

getXUnit

@Nonnull
public final ScreenOverlayUnit getXUnit()

Gets the unit with which the X (get) property is represented.

See Also:

Screen Overlays topic - Units

getYUnit

@Nonnull
public final ScreenOverlayUnit getYUnit()

Gets the unit with which the Y (get) property is represented.

See Also:

Screen Overlays topic - Units

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)