agi.foundation.graphics.advanced

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

Class ScreenOverlaySize

java.lang.Object

agi.foundation.graphics.advanced.ScreenOverlaySize

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class ScreenOverlaySize
extends Object
implements ImmutableValueType

Describes the size of a screen overlay.

Constructor Summary

Constructors

Constructor and Description
ScreenOverlaySize() Initializes a new instance.
ScreenOverlaySize(double width, double height) Initializes a new instance with a specified width and height in pixels.
ScreenOverlaySize(double width, double height, ScreenOverlayUnit widthUnit, ScreenOverlayUnit heightUnit) Initializes a new instance with a specified width and height 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	getHeight() Gets the height of the overlay.
ScreenOverlayUnit	getHeightUnit() Gets the unit with which the Height (get) property is represented.
double	getWidth() Gets the width of the overlay.
ScreenOverlayUnit	getWidthUnit() Gets the unit with which the Width (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

ScreenOverlaySize

public ScreenOverlaySize()

Initializes a new instance.

ScreenOverlaySize

public ScreenOverlaySize(double width,
                         double height)

Initializes a new instance with a specified width and height in pixels.

Parameters:

width - The width in pixels.

height - The height in pixels.

ScreenOverlaySize

public ScreenOverlaySize(double width,
                         double height,
                         @Nonnull
                         ScreenOverlayUnit widthUnit,
                         @Nonnull
                         ScreenOverlayUnit heightUnit)

Initializes a new instance with a specified width and height expressed in specified units.

Parameters:

width - The width in the unit specified by widthUnit.

height - The height in the unit specified by heightUnit.

widthUnit - The unit that width is specified in.

heightUnit - The unit that height is specified in.

Method Detail

getWidth

public final double getWidth()

Gets the width of the overlay. The unit is specified by the WidthUnit (get) property.

getHeight

public final double getHeight()

Gets the height of the overlay. The unit is specified by the HeightUnit (get) property.

getWidthUnit

@Nonnull
public final ScreenOverlayUnit getWidthUnit()

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

See Also:

Screen Overlays topic - Units

getHeightUnit

@Nonnull
public final ScreenOverlayUnit getHeightUnit()

Gets the unit with which the Height (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)