org.mini2Dx.ui.element

Class Image

java.lang.Object

org.mini2Dx.ui.element.UiElement

org.mini2Dx.ui.element.Image

All Implemented Interfaces:

Hoverable

public class Image
extends UiElement

Wraps a Texture or TextureRegion as a UiElement

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageRenderNode	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
Image() Constructor.
Image(float x, float y, float width, float height) Constructor
Image(java.lang.String id) Constructor
Image(java.lang.String id, float x, float y, float width, float height) Constructor
Image(java.lang.String id, java.lang.String texturePath) Constructor
Image(java.lang.String id, Texture texture) Constructor
Image(java.lang.String id, TextureRegion textureRegion) Constructor
Image(Texture texture) Constructor.
Image(TextureRegion textureRegion) 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
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	getTexturePath() Returns the current texture path
TextureRegion	getTextureRegion(AssetManager assetManager) Returns the current TextureRegion for this Image
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 Image 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 Image should scale to the size of its parent
void	setStyleId(java.lang.String styleId) Sets the style if for this UiElement
void	setTexture(Texture texture) Sets the current Texture used by this Image
void	setTexturePath(java.lang.String texturePath) Sets the current texture path.
void	setTextureRegion(TextureRegion textureRegion) Sets the current TextureRegion used by this Image
void	setVisibility(Visibility visibility) Sets the current Visibility of this UiElement
void	setZIndex(int zIndex) Sets the Z index of this UiElement.
void	shrinkToImageSize(AssetManager assetManager)
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 ImageRenderNode renderNode

Constructor Detail

Image

public Image()

Constructor. Generates a unique ID for this Image

Image

public Image(java.lang.String id)

Constructor

Parameters:

id - The unique ID for this Image

Image

public Image(float x,
             float y,
             float width,
             float height)

Constructor

Parameters:

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

Image

public Image(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

Image

public Image(java.lang.String id,
             java.lang.String texturePath)

Constructor

Parameters:

id - The unique ID for this Image

texturePath - The path for the Texture to be loaded by the AssetManager

Image

public Image(Texture texture)

Constructor. Generates a unique ID for this Image

Parameters:

texture - The Texture to use

Image

public Image(TextureRegion textureRegion)

Constructor. Generates a unique ID for this Image

Parameters:

textureRegion - The TextureRegion to use

Image

public Image(java.lang.String id,
             Texture texture)

Constructor

Parameters:

id - The unique ID for this Image

texture - The Texture to use

Image

public Image(java.lang.String id,
             TextureRegion textureRegion)

Constructor

Parameters:

id - The unique ID for this Image

textureRegion - The TextureRegion to use

Method Detail

postDeserialize

public void postDeserialize()

estimateSize

protected void estimateSize()

shrinkToImageSize

public void shrinkToImageSize(AssetManager assetManager)

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

getTextureRegion

public TextureRegion getTextureRegion(AssetManager assetManager)

Returns the current TextureRegion for this Image

Parameters:

assetManager - The game's AssetManager

Returns:

Null if no TextureRegion has been set

setTextureRegion

public void setTextureRegion(TextureRegion textureRegion)

Sets the current TextureRegion used by this Image

Parameters:

textureRegion - The TextureRegion to use

setTexture

public void setTexture(Texture texture)

Sets the current Texture used by this Image

Parameters:

texture - The Texture to use

getTexturePath

public java.lang.String getTexturePath()

Returns the current texture path

Returns:

Null if no path is used

setTexturePath

public void setTexturePath(java.lang.String texturePath)

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

Parameters:

texturePath - The path to the texture

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 Image should scale to the size of its parent

Returns:

False by default

setResponsive

public void setResponsive(boolean responsive)

Sets if this Image 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