org.mini2Dx.ui.element

Class AnimatedImage

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.AnimatedImage

All Implemented Interfaces:

Hoverable

public class AnimatedImage
extends UiElement

Field Summary

Fields

Modifier and Type	Field and Description
protected AnimatedImageRenderNode	renderNode

Fields inherited from class org.mini2Dx.ui.element.UiElement

deferredLayout, deferredRender, deferredUpdate, effects, height, styleId, visibility, width, x, y, zIndex

Constructor Summary

Constructors

Constructor and Description
AnimatedImage() Constructor.
AnimatedImage(java.lang.String id) Constructor
AnimatedImage(java.lang.String id, float x, float y, float width, float height) Constructor
AnimatedImage(java.lang.String id, java.lang.String[] texturePaths, float[] durations) Constructor
AnimatedImage(java.lang.String id, Texture[] textures, float[] durations) Constructor
AnimatedImage(java.lang.String id, TextureRegion[] textureRegions, float[] durations) Constructor
AnimatedImage(Texture[] textures, float[] durations) Constructor.
AnimatedImage(TextureRegion[] textureRegions, float[] durations) Constructor.

Method Summary

Modifier and Type	Method and Description
void	attach(ParentRenderNode<?,?> parentRenderNode) Attaches a RenderNode for this element to a parent RenderNode
void	detach(ParentRenderNode<?,?> parentRenderNode) Detaches this element's RenderNode from a parent RenderNode
protected void	estimateSize()
java.lang.String	getAtlas() Returns the atlas (if any) to look up the texture in
float[]	getFrameDurations() Returns the animation frame durations
int	getRenderHeight() Returns the height this element is currently rendering at
int	getRenderWidth() Returns the width this element is currently rendering at
int	getRenderX() Returns X coordinate of where this element is currently rendering
int	getRenderY() Returns Y coordinate of where this element is currently rendering
StyleRule	getStyleRule()
java.lang.String[]	getTexturePaths() Returns the texture paths for the animation
TextureRegion[]	getTextureRegions(AssetManager assetManager) Returns the current TextureRegion array for this AnimatedImage
void	invokeBeginHover() Triggers the begin hover event
void	invokeEndHover() Triggers the end hover event
boolean	isFlipX() Returns if the texture should be flipped horizontally during rendering
boolean	isFlipY() Returns if the texture should be flipped vertically during rendering
boolean	isInitialLayoutOccurred()
boolean	isInitialUpdateOccurred()
boolean	isRenderNodeDirty()
boolean	isResponsive() Returns if this AnimatedImage should scale to the size of its parent
void	postDeserialize()
void	setAtlas(java.lang.String atlas) Sets the atlas to look up the texture in
void	setFlipX(boolean flipX) Sets if the texture should be flipped horizontally during rendering
void	setFlipY(boolean flipY) Sets if the texture should be flipped vertically during rendering
void	setRenderNodeDirty()
void	setResponsive(boolean responsive) Sets if this AnimatedImage should scale to the size of its parent
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setTexturePaths(java.lang.String[] texturePaths, float[] durations) Sets the current texture path array.
void	setTextureRegions(TextureRegion[] textureRegions, float[] durations) Sets the current TextureRegion array used by this AnimatedImage
void	setTextures(Texture[] textures, float[] durations) Sets the current Texture array used by this AnimatedImage
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	syncWithUpdate(UiContainerRenderTree rootNode) Syncs data between the UiElement and RenderNode during update

Methods inherited from class org.mini2Dx.ui.element.UiElement

addEffectListener, addHoverListener, addNodeStateListener, alignAbove, alignBelow, alignEdgeToEdge, alignLeftOf, alignRightOf, applyEffect, deferUntilLayout, deferUntilLayout, deferUntilRender, deferUntilRender, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, deferUntilUpdate, equals, getContentHeight, getContentWidth, getElementById, getHeight, getId, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getStyleId, getVisibility, getWidth, getX, getY, getZIndex, hashCode, isDebugEnabled, isFlexLayout, isInitialised, notifyEffectListenersOnFinished, notifyHoverListenersOnBeginHover, notifyHoverListenersOnEndHover, notifyNodeStateListeners, removeEffectListener, removeHoverListener, removeNodeStateListener, set, setContentHeight, setContentWidth, setDebugEnabled, setHeight, setHeightToContentHeightOf, setHeightToHeightOf, setWidth, setWidthToContentWidthOf, setWidthToWidthOf, setX, setXY, setY, snapTo, snapTo, syncWithLayout, syncWithRender

Methods inherited from class java.lang.Object

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

Field Detail

renderNode

protected AnimatedImageRenderNode renderNode

Constructor Detail

AnimatedImage

public AnimatedImage()

Constructor. Generates a unique ID for this AnimatedImage

AnimatedImage

public AnimatedImage(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this AnimatedImage

AnimatedImage

public AnimatedImage(java.lang.String id,
                     float x,
                     float y,
                     float width,
                     float height)

Constructor

Parameters:

id - The unique ID for this element (if null an ID will be generated)

x - The x coordinate of this element relative to its parent

y - The y coordinate of this element relative to its parent

width - The width of this element

height - The height of this element

AnimatedImage

public AnimatedImage(java.lang.String id,
                     java.lang.String[] texturePaths,
                     float[] durations)

Constructor

Parameters:

id - The unique ID for this AnimatedImage

texturePaths - The paths for the textures to be loaded by the AssetManager

durations - The durations for each frame (in seconds)

AnimatedImage

public AnimatedImage(Texture[] textures,
                     float[] durations)

Constructor. Generates a unique ID for this AnimatedImage

Parameters:

textures - The Textures to use for each frame

durations - The durations for each frame (in seconds)

AnimatedImage

public AnimatedImage(TextureRegion[] textureRegions,
                     float[] durations)

Constructor. Generates a unique ID for this AnimatedImage

Parameters:

textureRegions - The TextureRegions to use for each frame

durations - The durations for each frame (in seconds)

AnimatedImage

public AnimatedImage(java.lang.String id,
                     Texture[] textures,
                     float[] durations)

Constructor

Parameters:

id - The unique ID for this AnimatedImage

textures - The Textures to use for each frame

durations - The durations for each frame (in seconds)

AnimatedImage

public AnimatedImage(java.lang.String id,
                     TextureRegion[] textureRegions,
                     float[] durations)

Constructor

Parameters:

id - The unique ID for this AnimatedImage

textureRegions - The TextureRegions to use for each frame

durations - The durations for each frame (in seconds)

Method Detail

postDeserialize

public void postDeserialize()

estimateSize

protected void estimateSize()

attach

public void attach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Attaches a RenderNode for this element to a parent RenderNode

Specified by:

attach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to attach to

detach

public void detach(ParentRenderNode<?,?> parentRenderNode)

Description copied from class: UiElement

Detaches this element's RenderNode from a parent RenderNode

Specified by:

detach in class UiElement

Parameters:

parentRenderNode - The parent RenderNode to detach from

invokeBeginHover

public void invokeBeginHover()

Description copied from interface: Hoverable

Triggers the begin hover event

invokeEndHover

public void invokeEndHover()

Description copied from interface: Hoverable

Triggers the end hover event

getTextureRegions

public TextureRegion[] getTextureRegions(AssetManager assetManager)

Returns the current TextureRegion array for this AnimatedImage

Parameters:

assetManager - The game's AssetManager

Returns:

Null if no animation has been set

setTextureRegions

public void setTextureRegions(TextureRegion[] textureRegions,
                              float[] durations)

Sets the current TextureRegion array used by this AnimatedImage

Parameters:

textureRegions - The TextureRegions to use for the animation

durations - The durations for each frame (in seconds)

setTextures

public void setTextures(Texture[] textures,
                        float[] durations)

Sets the current Texture array used by this AnimatedImage

Parameters:

textures - The Textures to use for the animation

durations - The durations for each frame (in seconds)

getTexturePaths

public java.lang.String[] getTexturePaths()

Returns the texture paths for the animation

Returns:

Null if no paths are used

getFrameDurations

public float[] getFrameDurations()

Returns the animation frame durations

Returns:

Null if no durations have been set

setTexturePaths

public void setTexturePaths(java.lang.String[] texturePaths,
                            float[] durations)

Sets the current texture path array. This will set the current TextureRegion array by loading it via the AssetManager

Parameters:

texturePaths - The paths to the textures for the animation

durations - The durations for each frame (in seconds)

getAtlas

public java.lang.String getAtlas()

Returns the atlas (if any) to look up the texture in

Returns:

Null by default

setAtlas

public void setAtlas(java.lang.String atlas)

Sets the atlas to look up the texture in

Parameters:

atlas - Null if the texture should not be looked up via an atlas

isResponsive

public boolean isResponsive()

Returns if this AnimatedImage should scale to the size of its parent

Returns:

False by default

setResponsive

public void setResponsive(boolean responsive)

Sets if this AnimatedImage should scale to the size of its parent

Parameters:

responsive -

setVisibility

public void setVisibility(Visibility visibility)

Description copied from class: UiElement

Sets the current Visibility of this UiElement

Specified by:

setVisibility in class UiElement

Parameters:

visibility - The Visibility to set

syncWithUpdate

public void syncWithUpdate(UiContainerRenderTree rootNode)

Description copied from class: UiElement

Syncs data between the UiElement and RenderNode during update

Overrides:

syncWithUpdate in class UiElement

setStyleId

public void setStyleId(java.lang.String styleId)

Description copied from class: UiElement

Sets the style if for this UiElement

Specified by:

setStyleId in class UiElement

Parameters:

styleId - The style id to set

setZIndex

public void setZIndex(int zIndex)

Description copied from class: UiElement

Sets the Z index of this UiElement. Elements will be rendered on different Z layers in ascending Z order (negatives values first, positive values last)

Specified by:

setZIndex in class UiElement

Parameters:

zIndex - The Z index

getStyleRule

public StyleRule getStyleRule()

Specified by:

getStyleRule in class UiElement

isFlipX

public boolean isFlipX()

Returns if the texture should be flipped horizontally during rendering

Returns:

setFlipX

public void setFlipX(boolean flipX)

Sets if the texture should be flipped horizontally during rendering

Parameters:

flipX - True if the texture should be flipped

isFlipY

public boolean isFlipY()

Returns if the texture should be flipped vertically during rendering

Returns:

setFlipY

public void setFlipY(boolean flipY)

Sets if the texture should be flipped vertically during rendering

Parameters:

flipY - True if the texture should be flipped

isRenderNodeDirty

public boolean isRenderNodeDirty()

Specified by:

isRenderNodeDirty in class UiElement

setRenderNodeDirty

public void setRenderNodeDirty()

Specified by:

setRenderNodeDirty in class UiElement

isInitialLayoutOccurred

public boolean isInitialLayoutOccurred()

Specified by:

isInitialLayoutOccurred in class UiElement

isInitialUpdateOccurred

public boolean isInitialUpdateOccurred()

Specified by:

isInitialUpdateOccurred in class UiElement

getRenderX

public int getRenderX()

Description copied from class: UiElement

Returns X coordinate of where this element is currently rendering

Specified by:

getRenderX in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderY

public int getRenderY()

Description copied from class: UiElement

Returns Y coordinate of where this element is currently rendering

Specified by:

getRenderY in class UiElement

Returns:

Integer.MIN_VALUE if not rendering

getRenderWidth

public int getRenderWidth()

Description copied from class: UiElement

Returns the width this element is currently rendering at

Specified by:

getRenderWidth in class UiElement

Returns:

-1 if not rendering

getRenderHeight

public int getRenderHeight()

Description copied from class: UiElement

Returns the height this element is currently rendering at

Specified by:

getRenderHeight in class UiElement

Returns:

-1 if not rendering