com.codingame.gameengine.module.entities

Class Line

java.lang.Object

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

com.codingame.gameengine.module.entities.Line

public class Line
extends Entity<T>

Represents a line segment from (x,y) to (x2,y2) in world units. This Shape does not have a fill.

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.
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	getX2() Returns the X coordinate of this Line's end point.
int	getY2() Returns the Y coordinate of this Line's end point.
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.
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.
Line	setX2(int x2) Sets the X coordinate of the end point of this Line.
Line	setX2(int x2, Curve curve) Sets the X coordinate of the end point of this Line.
Line	setY2(int y2) Sets the y coordinate of the end point of this Line.
Line	setY2(int y2, Curve curve) Sets the y coordinate of the end point of this Line.

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

setX2

public Line setX2(int x2)

Sets the X coordinate of the end point of this Line.

The starting point of this line is its position.

Parameters:

x2 - the X coordinate for the end point of this Line.

Returns:

this Line.

setX2

public Line setX2(int x2,
                  Curve curve)

Sets the X coordinate of the end point of this Line.

The starting point of this line is its position.

Parameters:

x2 - the X coordinate for the end point of this Line.

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

Returns:

this Line.

getX2

public int getX2()

Returns the X coordinate of this Line's end point.

Returns:

the X coordinate of this Line's end point.

setY2

public Line setY2(int y2)

Sets the y coordinate of the end point of this Line.

The starting point of this line is its position.

Parameters:

y2 - the Y coordinate for the end point of this Line.

Returns:

this Line.

setY2

public Line setY2(int y2,
                  Curve curve)

Sets the y coordinate of the end point of this Line.

The starting point of this line is its position.

Parameters:

y2 - the Y coordinate for the end point of this Line.

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

Returns:

this Line.

getY2

public int getY2()

Returns the Y coordinate of this Line's end point.

Returns:

the Y coordinate of this Line's end point.

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.