agi.foundation.graphics.advanced

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

Class ScreenOverlayPadding

java.lang.Object

agi.foundation.graphics.advanced.ScreenOverlayPadding

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class ScreenOverlayPadding
extends Object
implements ImmutableValueType

The padding by which all child overlays will be offset from the edges of the parent.

Constructor Summary

Constructors

Constructor and Description
ScreenOverlayPadding() Initializes a new instance.
ScreenOverlayPadding(double padding) Initializes a new instance with the specified padding, in pixels, on all sides.
ScreenOverlayPadding(double left, double top, double right, double bottom) Initializes a new instance with the specified padding, in pixels, on each side.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
double	getBottom() Gets the padding, in pixels, from the bottom edge of the parent.
double	getLeft() Gets the padding, in pixels, from the left edge of the parent.
double	getRight() Gets the padding, in pixels, from the right edge of the parent.
double	getTop() Gets the padding, in pixels, from the top edge of the parent.
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

ScreenOverlayPadding

public ScreenOverlayPadding()

Initializes a new instance.

ScreenOverlayPadding

public ScreenOverlayPadding(double padding)

Initializes a new instance with the specified padding, in pixels, on all sides.

Parameters:

padding - The padding to use on all sides of the overlay.

ScreenOverlayPadding

public ScreenOverlayPadding(double left,
                            double top,
                            double right,
                            double bottom)

Initializes a new instance with the specified padding, in pixels, on each side.

Parameters:

left - The padding to use on the left side of the overlay.

top - The padding to use on the top side of the overlay.

right - The padding to use on the right side of the overlay.

bottom - The padding to use on the bottom side of the overlay.

Method Detail

getLeft

public final double getLeft()

Gets the padding, in pixels, from the left edge of the parent.

getTop

public final double getTop()

Gets the padding, in pixels, from the top edge of the parent.

getRight

public final double getRight()

Gets the padding, in pixels, from the right edge of the parent.

getBottom

public final double getBottom()

Gets the padding, in pixels, from the bottom edge of the parent.

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)