agi.foundation.graphics.advanced

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

Interface IScreenOverlayContainer

All Known Implementing Classes:

Overlay, ScreenOverlay, ScreenOverlayManager, TextureScreenOverlay

public interface IScreenOverlayContainer

The interface for screen overlays that contain a collection of other overlays. This interface is implemented by ScreenOverlayManager and ScreenOverlay.

Method Summary

Modifier and Type	Method and Description
boolean	getDisplay() Gets if this parent and the collection of overlays that are contained within this parent should be rendered.
ScreenOverlayCollection	getOverlays() Gets the collection of overlays that are contained within this parent.
ScreenOverlayPadding	getPadding() Gets the padding surrounding the Overlays (get) that are contained within this parent.
void	setDisplay(boolean value) Sets if this parent and the collection of overlays that are contained within this parent should be rendered.
void	setPadding(ScreenOverlayPadding value) Sets the padding surrounding the Overlays (get) that are contained within this parent.

Method Detail

getOverlays

ScreenOverlayCollection getOverlays()

Gets the collection of overlays that are contained within this parent.

See Also:

Screen Overlays topic - Nesting Overlays

getPadding

ScreenOverlayPadding getPadding()

Gets the padding surrounding the Overlays (get) that are contained within this parent.

See Also:

Screen Overlays topic - Nesting Overlays

setPadding

void setPadding(ScreenOverlayPadding value)

Sets the padding surrounding the Overlays (get) that are contained within this parent.

See Also:

Screen Overlays topic - Nesting Overlays

getDisplay

boolean getDisplay()

Gets if this parent and the collection of overlays that are contained within this parent should be rendered.

An overlay must be added to the ScreenOverlayManager before it is rendered. Once in the manager, setting this property to false is more efficient than removing the overlay from the manager. However, it is recommended to remove the overlay from the manager if the overlay will be hidden for a long period of time.

See Also:

ScreenOverlayManager

setDisplay

void setDisplay(boolean value)

Sets if this parent and the collection of overlays that are contained within this parent should be rendered.

An overlay must be added to the ScreenOverlayManager before it is rendered. Once in the manager, setting this property to false is more efficient than removing the overlay from the manager. However, it is recommended to remove the overlay from the manager if the overlay will be hidden for a long period of time.

See Also:

ScreenOverlayManager