com.codingame.gameengine.module.entities

Class Rectangle

java.lang.Object

com.codingame.gameengine.module.entities.Entity<T>

com.codingame.gameengine.module.entities.Rectangle

public class Rectangle
extends Entity<T>

A Rectangle specifies an area in a the world enclosed by the Rectangle's upper-left point (x,y), its width, and its height.

The coordinates, width and height are in world units.

Method Summary

Modifier and Type	Method and Description
double	getFillAlpha() Returns the alpha of the fill of this Shape as a percentage.
java.lang.Integer	getFillColor() Returns the color of the fill of this Shape as an RGB integer.
int	getHeight() Returns the height of this Rectangle in world units.
double	getLineAlpha() Returns the alpha of the border of this Shape as a percentage.
int	getLineColor() Returns the color of the border of this Shape as an RGB integer.
int	getLineWidth() Returns the width of the border of this Shape in world units.
int	getWidth() Returns the width of this Rectangle in world units.
T	setFillAlpha(double alpha) Sets the alpha of the fill of this Shape as a percentage.
T	setFillAlpha(double alpha, Curve curve) Sets the alpha of the fill of this Shape as a percentage.
T	setFillColor(int color) Sets the color of the fill of this Shape as an RGB integer or null if the fill should not be drawn.
T	setFillColor(int color, Curve curve) Sets the color of the fill of this Shape as an RGB integer or null if the fill should not be drawn.
Rectangle	setHeight(int height) Sets the height of this Rectangle in world units.
Rectangle	setHeight(int height, Curve curve) Sets the height of this Rectangle in world units.
T	setLineAlpha(double alpha) Sets the alpha of the border of this Shape as a percentage.
T	setLineAlpha(double alpha, Curve curve) Sets the alpha of the border of this Shape as a percentage.
T	setLineColor(int lineColor) Sets the color of the border of this Shape as an RGB integer.
T	setLineColor(int lineColor, Curve curve) Sets the color of the border of this Shape as an RGB integer.
T	setLineWidth(int lineWidth) Sets the width of the border of this Shape in world units.
T	setLineWidth(int lineWidth, Curve curve) Sets the width of the border of this Shape in world units.
Rectangle	setWidth(int width) Sets the width of this Rectangle in world units.
Rectangle	setWidth(int width, Curve curve) Sets the width of this Rectangle in world units.

Methods inherited from class com.codingame.gameengine.module.entities.Entity

getAlpha, getId, getRotation, getScaleX, getScaleY, getX, getY, getZIndex, isVisible, setAlpha, setAlpha, setRotation, setRotation, setScale, setScale, setScaleX, setScaleX, setScaleY, setScaleY, setVisible, setX, setX, setY, setY, setZIndex

Methods inherited from class java.lang.Object

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

Method Detail

setWidth

public Rectangle setWidth(int width)

Sets the width of this Rectangle in world units.

Parameters:

width - the width for this Rectangle.

Returns:

this Rectangle

setWidth

public Rectangle setWidth(int width,
                          Curve curve)

Sets the width of this Rectangle in world units.

Parameters:

width - the width for this Rectangle.

curve - the transition to animate between values of this property.

Returns:

this Rectangle

getWidth

public int getWidth()

Returns the width of this Rectangle in world units.

Default is 100.

Returns:

the width of this Rectangle.

setHeight

public Rectangle setHeight(int height)

Sets the height of this Rectangle in world units.

Parameters:

height - the height for this Rectangle.

Returns:

this Rectangle

setHeight

public Rectangle setHeight(int height,
                           Curve curve)

Sets the height of this Rectangle in world units.

Parameters:

height - the height for this Rectangle.

curve - the transition to animate between values of this property.

Returns:

this Rectangle

getHeight

public int getHeight()

Returns the height of this Rectangle in world units.

Default is 100.

Returns:

the height of this Rectangle.

setFillColor

public T setFillColor(int color)

Sets the color of the fill of this Shape as an RGB integer or null if the fill should not be drawn.

Parameters:

color - the color of the fill of this Shape.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if color isn't a valid RGB integer

setFillColor

public T setFillColor(int color,
                      Curve curve)

Sets the color of the fill of this Shape as an RGB integer or null if the fill should not be drawn.

Parameters:

color - the color of the fill of this Shape.

curve - the transition to animate between values of this property.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if color isn't a valid RGB integer

getFillColor

public java.lang.Integer getFillColor()

Returns the color of the fill of this Shape as an RGB integer.

Can be null if no fill should be drawn.

Returns:

the color of the fill of this Shape.

setFillAlpha

public T setFillAlpha(double alpha)

Sets the alpha of the fill of this Shape as a percentage.

Parameters:

alpha - the alpha of the fill of this Shape.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

setFillAlpha

public T setFillAlpha(double alpha,
                      Curve curve)

Sets the alpha of the fill of this Shape as a percentage.

Parameters:

alpha - the alpha of the fill of this Shape.

curve - the transition to animate between values of this property.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

getFillAlpha

public double getFillAlpha()

Returns the alpha of the fill of this Shape as a percentage.

Default is 1.

Returns:

the alpha of the fill of this Shape.

setLineAlpha

public T setLineAlpha(double alpha)

Sets the alpha of the border of this Shape as a percentage.

Parameters:

alpha - the alpha for the border of this Shape.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

setLineAlpha

public T setLineAlpha(double alpha,
                      Curve curve)

Sets the alpha of the border of this Shape as a percentage.

Parameters:

alpha - the alpha for the border of this Shape.

curve - the transition to animate between values of this property.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if alpha < 0 or alpha > 1

getLineAlpha

public double getLineAlpha()

Returns the alpha of the border of this Shape as a percentage.

Default is 1.

Returns:

the alpha for the border of this Shape.

setLineWidth

public T setLineWidth(int lineWidth)

Sets the width of the border of this Shape in world units.

Parameters:

lineWidth - the width for the border of this Shape.

Returns:

this Shape.

setLineWidth

public T setLineWidth(int lineWidth,
                      Curve curve)

Sets the width of the border of this Shape in world units.

Parameters:

lineWidth - the width for the border of this Shape.

curve - the transition to animate between values of this property.

Returns:

this Shape.

getLineWidth

public int getLineWidth()

Returns the width of the border of this Shape in world units.

Default is 1.

Returns:

the width of the border of this Shape.

setLineColor

public T setLineColor(int lineColor)

Sets the color of the border of this Shape as an RGB integer.

Parameters:

lineColor - the color for the border of this Shape.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if lineColor isn't a valid RGB integer

setLineColor

public T setLineColor(int lineColor,
                      Curve curve)

Sets the color of the border of this Shape as an RGB integer.

Parameters:

lineColor - the color for the border of this Shape.

curve - the transition to animate between values of this property.

Returns:

this Shape.

Throws:

java.lang.IllegalArgumentException - if lineColor isn't a valid RGB integer

getLineColor

public int getLineColor()

Returns the color of the border of this Shape as an RGB integer.

Default is 0xFFFFFF (white).

Returns:

the color of the border of this Shape.