ej.microui.display.transform

Class ImageScale

java.lang.Object

ej.microui.display.transform.AbstractTransform

ej.microui.display.transform.ImageScale

public class ImageScale
extends AbstractTransform

This class holds a context in order to draw images with scaling.

An image scale instance holds a global state for all drawings. Several instances can be created at the same time. However a default instance is created on MicroUI framework startup and is always available.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static ImageScale	Singleton Default instance created on MicroUI framework startup.

Constructor Summary

Constructors

Constructor and Description
ImageScale()

Method Summary

Modifier and Type	Method and Description
void	draw(GraphicsContext gc, Image image, int x, int y, int anchor) Deprecated. Use drawNearestNeighbor(GraphicsContext, Image, int, int, int) or drawBilinear(GraphicsContext, Image, int, int, int) instead.
void	drawBilinear(GraphicsContext gc, Image image, int x, int y, int anchor) Draw the Image in the GraphicsContext at given anchor position and using the current scaling factor.
void	drawNearestNeighbor(GraphicsContext gc, Image image, int x, int y, int anchor) Draw the Image in the GraphicsContext at given anchor position and using the current scaling factor.
float	getFactor() Deprecated. Use getFactorX() or getFactorY() instead.
float	getFactorX() Returns the current scaling X factor.
float	getFactorY() Returns the current scaling Y factor.
void	setFactor(float factor) Set a new scaling factor.
void	setFactorX(float factor) Set a new scaling X factor.
void	setFactorY(float factor) Set a new scaling Y factor.

Methods inherited from class ej.microui.display.transform.AbstractTransform

getAlpha, getTranslateX, getTranslateY, isMirrored, resetAlpha, resetTranslate, setAlpha, setMirror, translate

Methods inherited from class java.lang.Object

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

Field Detail

Singleton

public static ImageScale Singleton

Default instance created on MicroUI framework startup.

Constructor Detail

ImageScale

public ImageScale()

Method Detail

getFactor

public float getFactor()

Deprecated. Use getFactorX() or getFactorY() instead.

Returns:

the current scaling X factor.

getFactorX

public float getFactorX()

Returns the current scaling X factor.

Returns:

the current scaling X factor.

getFactorY

public float getFactorY()

Returns the current scaling Y factor.

Returns:

the current scaling Y factor.

setFactor

public void setFactor(float factor)

Set a new scaling factor. Equivalent to
setFactorX(factor);
setFactorY(factor);


Parameters:

factor - the new scaling factor

Throws:

java.lang.IllegalArgumentException - if factor is lower than or equal to zero

setFactorX

public void setFactorX(float factor)

Set a new scaling X factor.

Parameters:

factor - the new scaling X factor

Throws:

java.lang.IllegalArgumentException - if factor is lower than or equal to zero

setFactorY

public void setFactorY(float factor)

Set a new scaling Y factor.

Parameters:

factor - the new scaling Y factor

Throws:

java.lang.IllegalArgumentException - if factor is lower than or equal to zero

draw

public void draw(GraphicsContext gc,
                 Image image,
                 int x,
                 int y,
                 int anchor)

Deprecated. Use drawNearestNeighbor(GraphicsContext, Image, int, int, int) or drawBilinear(GraphicsContext, Image, int, int, int) instead.

Parameters:

gc - the GraphicsContext where to render the drawing.

image - the Image to draw

x - the x coordinate of the image reference anchor point

y - the y coordinate of the image reference anchor point

anchor - position of the image reference point around the anchor point

drawBilinear

public void drawBilinear(GraphicsContext gc,
                         Image image,
                         int x,
                         int y,
                         int anchor)

Draw the Image in the GraphicsContext at given anchor position and using the current scaling factor. This method uses the bilinear algorithm to render the image. This algorithm performs better rendering than nearest neighbor algorithm but it is slower to apply.

Parameters:

gc - the GraphicsContext where to render the drawing.

image - the Image to draw

x - the x coordinate of the image reference anchor point

y - the y coordinate of the image reference anchor point

anchor - position of the image reference point around the anchor point

drawNearestNeighbor

public void drawNearestNeighbor(GraphicsContext gc,
                                Image image,
                                int x,
                                int y,
                                int anchor)

Draw the Image in the GraphicsContext at given anchor position and using the current scaling factor. This method uses the nearest neighbor algorithm to render the image. This algorithm is faster than bilinear algorithm but its rendering is more simple.

Parameters:

gc - the GraphicsContext where to render the drawing.

image - the Image to draw

x - the x coordinate of the image reference anchor point

y - the y coordinate of the image reference anchor point

anchor - position of the image reference point around the anchor point