ej.microui.display.shape

Class AntiAliasedShapes

java.lang.Object

ej.microui.display.shape.AntiAliasedShapes

public class AntiAliasedShapes
extends java.lang.Object

The AntiAliasedShapes class offers advanced drawing facilities, to render anti aliased lines, circles etc.

An AntiAliasedShapes instance holds a global state (thickness and fade) for all drawings. Several AntiAliasedShapes instances can be created at same time. However a default instance is created on MicroUI framework startup and it always available.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AntiAliasedShapes.Cap Define the cap representation when drawing a circle arc

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AntiAliasedShapes() Creates a new AntiAliasedShapes instance.

Method Summary

Modifier and Type	Method and Description
void	drawCircle(GraphicsContext gc, int x, int y, int diameter) Draws the outline of a circle covering the rectangle specified by its diameter, using the GraphicsContext 's current color. The center of the circle is defined as the center of the rectangle whose origin is at (x,y) (upper-left corner) and whose dimension is given by diameter. If diameter is negative, nothing is drawn.
void	drawCircleArc(GraphicsContext gc, int x, int y, int diameter, int startAngle, int arcAngle) Draws the outline of a circular arc covering the specified square, using the current color, stroke style and caps The arc is drawn from startAngle up to arcAngle degrees.
void	drawEllipse(GraphicsContext gc, int x, int y, int width, int height) Draws the outline of a ellipse covering the specified rectangle, using the GraphicsContext's current color. The center of the ellipse is defined as the center of the rectangle whose origin is at (x,y) (upper-left corner) and whose dimension is given by width and height. If either width or height is negative, nothing is drawn.
void	drawLine(GraphicsContext gc, int x1, int y1, int x2, int y2) Draws a line from (x1,y1) to (x2,y2) using the GraphicsContext's current color.
void	drawPoint(GraphicsContext gc, int x, int y) Draws a point at (x,y) using the GraphicsContext's current color.
AntiAliasedShapes.Cap	getEndCap() Returns the current shape end cap.
int	getFade() Returns the current fade.
AntiAliasedShapes.Cap	getStartCap() Returns the current shape start cap.
int	getThickness() Returns the current thickness.
void	reset() Resets the AntiAliasedShapes global state to its initial values.
void	setCaps(AntiAliasedShapes.Cap start, AntiAliasedShapes.Cap end) Configures the caps representation.
void	setEndCap(AntiAliasedShapes.Cap cap) Configures the cap representation of end of shape.
void	setFade(int fade) Apply a new fade.
void	setStartCap(AntiAliasedShapes.Cap cap) Configures the cap representation of start of shape.
void	setThickness(int thickness) Apply a new thickness.

Methods inherited from class java.lang.Object

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

Field Detail

Singleton

public static AntiAliasedShapes Singleton

Default AntiAliasedShapes instance created on MicroUI framework startup.

Constructor Detail

AntiAliasedShapes

public AntiAliasedShapes()

Creates a new AntiAliasedShapes instance. The global state is set to its initial value.

See Also:

reset()

Method Detail

reset

public void reset()

Resets the AntiAliasedShapes global state to its initial values. Default fade is 1 and default thickness is 0.

getFade

public int getFade()

Returns the current fade.

Returns:

the current fade.

setFade

public void setFade(int fade)

Apply a new fade.

Parameters:

fade - the new fade to apply.

Throws:

java.lang.IllegalArgumentException - when given fade is negative

getThickness

public int getThickness()

Returns the current thickness.

Returns:

the current thickness.

setThickness

public void setThickness(int thickness)

Apply a new thickness.

Parameters:

thickness - the new thickness to apply.

Throws:

java.lang.IllegalArgumentException - when given thickness is negative

getStartCap

public AntiAliasedShapes.Cap getStartCap()

Returns the current shape start cap.

Returns:

the current shape start cap.

setStartCap

public void setStartCap(AntiAliasedShapes.Cap cap)

Configures the cap representation of start of shape. This configuration is used by drawCircleArc(GraphicsContext, int, int, int, int, int).

Parameters:

cap - the shape cap configuration

getEndCap

public AntiAliasedShapes.Cap getEndCap()

Returns the current shape end cap.

Returns:

the current shape end cap.

setEndCap

public void setEndCap(AntiAliasedShapes.Cap cap)

Configures the cap representation of end of shape. This configuration is used by drawCircleArc(GraphicsContext, int, int, int, int, int).

Parameters:

cap - the shape cap configuration

setCaps

public void setCaps(AntiAliasedShapes.Cap start,
                    AntiAliasedShapes.Cap end)

Configures the caps representation. This configuration is used by drawCircleArc(GraphicsContext, int, int, int, int, int). It is equivalent to the following code sequence:
setStartCap(start);
setEndCap(end);

Parameters:

start - the shape cap configuration

end - the shape cap configuration

drawPoint

public void drawPoint(GraphicsContext gc,
                      int x,
                      int y)

Draws a point at (x,y) using the GraphicsContext's current color.

Parameters:

gc - the GraphicsContext where render the drawing.

x - the x coordinate of the point

y - the y coordinate of the point

drawLine

public void drawLine(GraphicsContext gc,
                     int x1,
                     int y1,
                     int x2,
                     int y2)

Draws a line from (x1,y1) to (x2,y2) using the GraphicsContext's current color.

Parameters:

gc - the GraphicsContext where render the drawing.

x1 - the x coordinate of the start of the line

y1 - the y coordinate of the start of the line

x2 - the x coordinate of the end of the line

y2 - the y coordinate of the end of the line

drawCircleArc

public final void drawCircleArc(GraphicsContext gc,
                                int x,
                                int y,
                                int diameter,
                                int startAngle,
                                int arcAngle)

Draws the outline of a circular arc covering the specified square, using the current color, stroke style and caps

The arc is drawn from startAngle up to arcAngle degrees. The center of the arc is defined as the center of the rectangle whose origin is at (x,y) (upper-left corner) and whose dimension is given by diameter.

Angles are interpreted such that 0 degrees is at the 3 o'clock position. A positive value indicates a counter-clockwise rotation while a negative value indicates a clockwise rotation.

If diameter is negative, nothing is drawn.

The angles are given relative to the rectangle. For instance an angle of 45 degrees is always defined by the line from the center of the rectangle to the upper right corner of the rectangle. Thus for a non squarred rectangle angles are skewed along either height or width.

Parameters:

gc - the GraphicsContext where render the drawing.

x - the x coordinate of the upper-left corner of the rectangle where the arc is drawn

y - the y coordinate of the upper-left corner of the rectangle where the arc is drawn

diameter - the diameter of the arc to draw

startAngle - the beginning angle of the arc to draw

arcAngle - the angular extent of the arc from startAngle

See Also:

setStartCap(Cap), setEndCap(Cap), setCaps(Cap, Cap)

drawCircle

public void drawCircle(GraphicsContext gc,
                       int x,
                       int y,
                       int diameter)

Draws the outline of a circle covering the rectangle specified by its diameter, using the GraphicsContext 's current color.

The center of the circle is defined as the center of the rectangle whose origin is at (x,y) (upper-left corner) and whose dimension is given by diameter.

If diameter is negative, nothing is drawn.

Parameters:

gc - the GraphicsContext where render the drawing.

x - the x coordinate of the upper-left corner of the rectangle where the circle is drawn

y - the y coordinate of the upper-left corner of the rectangle where the circle is drawn

diameter - the diameter of the circle to draw

drawEllipse

public void drawEllipse(GraphicsContext gc,
                        int x,
                        int y,
                        int width,
                        int height)

Draws the outline of a ellipse covering the specified rectangle, using the GraphicsContext's current color.

The center of the ellipse is defined as the center of the rectangle whose origin is at (x,y) (upper-left corner) and whose dimension is given by width and height.

If either width or height is negative, nothing is drawn.

Parameters:

gc - the GraphicsContext where render the drawing.

x - the x coordinate of the upper-left corner of the rectangle where the ellipse is drawn

y - the y coordinate of the upper-left corner of the rectangle where the ellipse is drawn

width - the width of the ellipse to draw

height - the height of the ellipse to draw