org.mini2Dx.ui.effect

Class SlideIn

java.lang.Object

org.mini2Dx.ui.effect.SlideIn

All Implemented Interfaces:

UiEffect

public class SlideIn
extends java.lang.Object
implements UiEffect

A UiEffect that moves a UiElement from off-screen to its target position

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_DURATION

Constructor Summary

Constructors

Constructor and Description
SlideIn() Slide in from bottom of screen with DEFAULT_DURATION
SlideIn(float duration) Slide in from bottom of screen with specific duration
SlideIn(SlideDirection direction) Slide in from outside of the screen with DEFAULT_DURATION
SlideIn(SlideDirection direction, float duration) Slide in from outside of the screen with specific duration

Method Summary

Modifier and Type	Method and Description
float	getDuration()
float	getSpeed()
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_DURATION

public static final float DEFAULT_DURATION

See Also:

Constant Field Values

Constructor Detail

SlideIn

public SlideIn()

Slide in from bottom of screen with DEFAULT_DURATION

SlideIn

public SlideIn(float duration)

Slide in from bottom of screen with specific duration

Parameters:

duration - The duration of the animation in seconds

SlideIn

public SlideIn(SlideDirection direction)

Slide in from outside of the screen with DEFAULT_DURATION

Parameters:

direction - The slide direction. Note that this is the direction that the UiElement moves

SlideIn

public SlideIn(SlideDirection direction,
               float duration)

Slide in from outside of the screen with specific duration

Parameters:

direction - The slide direction. Note that this is the direction that the UiElement moves

duration - The duration of the animation in seconds

Method Detail

update

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

Description copied from interface: UiEffect

Updates the effect

Specified by:

update in interface UiEffect

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

preBegin

public void preBegin(UiElement element)

Description copied from interface: UiEffect

Called before the effect begins

Specified by:

preBegin in interface UiEffect

Parameters:

element - The UiElement the effect is applied to

postEnd

public void postEnd(UiElement element)

Description copied from interface: UiEffect

Called after the effect ends

Specified by:

postEnd in interface UiEffect

Parameters:

element - The UiElement the effect was applied to

preRender

public void preRender(Graphics g)

Description copied from interface: UiEffect

Called before rendering the UiElement

Specified by:

preRender in interface UiEffect

Parameters:

g - The Graphics context

postRender

public void postRender(Graphics g)

Description copied from interface: UiEffect

Called after rendering the UiElement

Specified by:

postRender in interface UiEffect

Parameters:

g - The Graphics context

isFinished

public boolean isFinished()

Description copied from interface: UiEffect

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

Specified by:

isFinished in interface UiEffect

Returns:

getDuration

public float getDuration()

getSpeed

public float getSpeed()