Package arc.scene.ui

Class Image

java.lang.Object

arc.scene.Element

arc.scene.ui.Image

Direct Known Subclasses:

BorderImage, ColorImage, SchematicsDialog.SchematicImage

public class Image
extends Element

Displays a Drawable, scaled various way within the widgets bounds. The preferred size is the min size of the drawable. Only when using a TextureRegionDrawable will the actor's scale, rotation, and origin be used when drawing.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	imageHeight
protected float	imageWidth
protected float	imageX
protected float	imageY

Fields inherited from class arc.scene.Element

color, cullable, fillParent, height, name, originX, originY, parent, parentAlpha, rotation, scaleX, scaleY, touchable, touchablility, translation, userObject, visibility, visible, width, x, y

Constructor Summary

Constructors

Constructor	Description
Image()	Creates an image with no region or patch, stretched, and aligned center.
Image(NinePatch patch)	Creates an image stretched, and aligned center.
Image(TextureRegion region)	Creates an image stretched, and aligned center.
Image(Texture texture)	Creates an image stretched, and aligned center.
Image(Drawable drawable)	Creates an image stretched, and aligned center.
Image(Drawable name, Color color)
Image(Drawable drawable, Scaling scaling)	Creates an image aligned center.
Image(Drawable drawable, Scaling scaling, int align)

Method Summary

Modifier and Type	Method	Description
void	draw()	Draws the element.
Drawable	getDrawable()
float	getImageHeight()
float	getImageWidth()
float	getImageX()
float	getImageY()
float	getMinHeight()
float	getMinWidth()
float	getPrefHeight()
float	getPrefWidth()
TextureRegion	getRegion()
void	layout()	Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Element.invalidate() on any each child whose width or height has changed, and calls Element.validate() on each child.
void	setAlign(int align)
void	setDrawable(TextureRegion region)
void	setDrawable(Drawable drawable)
Image	setScaling(Scaling scaling)

Methods inherited from class arc.scene.Element

act, actions, addAction, addCaptureListener, addListener, change, changed, clear, clearActions, clearListeners, clicked, clicked, clicked, clicked, clipBegin, clipBegin, clipEnd, dragged, exited, fire, fireClick, getActions, getCaptureListeners, getHeight, getListeners, getMaxHeight, getMaxWidth, getRight, getRotation, getScene, getTop, getWidth, getX, getY, getZIndex, hasActions, hasKeyboard, hasMouse, hasParent, hasScroll, hit, hovered, invalidate, invalidateHierarchy, isAscendantOf, isDescendantOf, isDescendantOf, isTouchable, keepInStage, keyDown, keyDown, localToAscendantCoordinates, localToParentCoordinates, localToStageCoordinates, moveBy, needsLayout, notify, pack, parentToLocalCoordinates, released, remove, removeAction, removeCaptureListener, removeListener, requestKeyboard, requestScroll, rotateBy, rotationChanged, scaleBy, scaleBy, screenToLocalCoordinates, scrolled, setBounds, setColor, setColor, setFillParent, setHeight, setLayoutEnabled, setOrigin, setOrigin, setPosition, setPosition, setRotation, setRotationOrigin, setScale, setScale, setScene, setSize, setSize, setTranslation, setWidth, setZIndex, sizeBy, sizeBy, sizeChanged, stageToLocalCoordinates, tapped, toBack, toFront, toString, touchable, update, updateVisibility, validate, visible

Methods inherited from class java.lang.Object

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

Field Details

imageX

protected float imageX

imageY

protected float imageY

imageWidth

protected float imageWidth

imageHeight

protected float imageHeight

Constructor Details

Image

public Image()

Creates an image with no region or patch, stretched, and aligned center.

Image

public Image(Drawable name,
 Color color)

Image

public Image(NinePatch patch)

Creates an image stretched, and aligned center.

Parameters:

patch - May be null.

Image

public Image(TextureRegion region)

Creates an image stretched, and aligned center.

Parameters:

region - May be null.

Image

public Image(Texture texture)

Creates an image stretched, and aligned center.

Image

public Image(Drawable drawable)

Creates an image stretched, and aligned center.

Parameters:

drawable - May be null.

Image

public Image(Drawable drawable,
 Scaling scaling)

Creates an image aligned center.

Parameters:

drawable - May be null.

Image

public Image(Drawable drawable,
 Scaling scaling,
 int align)

Parameters:

drawable - May be null.

Method Details

layout

public void layout()

Description copied from class: Element

Computes and caches any information needed for drawing and, if this actor has children, positions and sizes each child, calls Element.invalidate() on any each child whose width or height has changed, and calls Element.validate() on each child. This method should almost never be called directly, instead Element.validate() should be used.

Overrides:

layout in class Element

draw

public void draw()

Description copied from class: Element

Draws the element. Does nothing by default.

Overrides:

draw in class Element

getRegion

public TextureRegion getRegion()

getDrawable

public Drawable getDrawable()

Returns:

May be null.

setDrawable

public void setDrawable(TextureRegion region)

setDrawable

public void setDrawable(Drawable drawable)

Parameters:

drawable - May be null.

setScaling

public Image setScaling(Scaling scaling)

setAlign

public void setAlign(int align)

getMinWidth

public float getMinWidth()

Overrides:

getMinWidth in class Element

getMinHeight

public float getMinHeight()

Overrides:

getMinHeight in class Element

getPrefWidth

public float getPrefWidth()

Overrides:

getPrefWidth in class Element

getPrefHeight

public float getPrefHeight()

Overrides:

getPrefHeight in class Element

getImageX

public float getImageX()

getImageY

public float getImageY()

getImageWidth

public float getImageWidth()

getImageHeight

public float getImageHeight()