org.mini2Dx.ui.effect

Interface UiEffect

All Known Implementing Classes:

SlideIn, SlideOut

public interface UiEffect

An effect to be applied to a UiElement

Method Summary

Modifier and Type	Method and Description
boolean	isFinished() True if the effect has completed and should be removed from the UiElement
void	postEnd(UiElement element) Called after the effect ends
void	postRender(Graphics g) Called after rendering the UiElement
void	preBegin(UiElement element) Called before the effect begins
void	preRender(Graphics g) Called before rendering the UiElement
boolean	update(UiContainerRenderTree uiContainer, CollisionBox currentArea, Rectangle targetArea, float delta) Updates the effect

Method Detail

preBegin

void preBegin(UiElement element)

Called before the effect begins

Parameters:

element - The UiElement the effect is applied to

postEnd

void postEnd(UiElement element)

Called after the effect ends

Parameters:

element - The UiElement the effect was applied to

update

boolean update(UiContainerRenderTree uiContainer,
               CollisionBox currentArea,
               Rectangle targetArea,
               float delta)

Updates the effect

Parameters:

uiContainer - The UiContainerRenderTree the UiElement belongs to

currentArea - The current area that the UiElement is set to render in. Manipulate this to change where the element renders.

targetArea - The target area that the UiElement is set to render in as specified by the render tree and layout.

delta - The frame delta

Returns:

True if the UiElement should be rendered

preRender

void preRender(Graphics g)

Called before rendering the UiElement

Parameters:

g - The Graphics context

postRender

void postRender(Graphics g)

Called after rendering the UiElement

Parameters:

g - The Graphics context

isFinished

boolean isFinished()

True if the effect has completed and should be removed from the UiElement

Returns: