Package paintingcanvas.drawable

Class Square

java.lang.Object

paintingcanvas.drawable.Drawable<Square>

paintingcanvas.drawable.Square

All Implemented Interfaces:

Animatable

public class Square
extends Drawable<Square>

A Square element.

 // Create a new Square at (100, 100) with a size of 30px
 Square square = new Square(100, 100, 30);
 

Field Summary

Fields

Modifier and Type	Field	Description
int	size	The size / side-length of the square.

Constructor Summary

Constructors

Constructor	Description
Square(int centerX, int centerY, int size)	Create a new Square element.
Square(int centerX, int centerY, int size, java.awt.Color color)	Create a new Square element.
Square(int centerX, int centerY, int size, java.lang.String color)	Create a new Square element with a certain color by name (see Hue for list of all valid names)

Method Summary

Modifier and Type	Method	Description
protected void	drawFilled(java.awt.Graphics2D gc)	the color is set to `color`
protected void	drawOutline(java.awt.Graphics2D gc)	the color is set to `outlineColor`, the stroke is set to `outlineStroke`
int	getSize()	Gets the size of the square.
Square	getThis()
Square	setSize(int s)	Sets the size of the square.

Methods inherited from class paintingcanvas.drawable.Drawable

Modifier and Type	Method	Description
AnimationBuilder	animate()	Start animating this object.
java.awt.Point	center(java.awt.Graphics g)	Get the object's centerpoint
Drawable<?>	drawable()	Get the Drawable element from this Animatable.
protected abstract void	drawFilled(java.awt.Graphics2D gc)	the color is set to `color`
protected abstract void	drawOutline(java.awt.Graphics2D gc)	the color is set to `outlineColor`, the stroke is set to `outlineStroke`
void	erase()	Erase this object from the canvas.
java.awt.Color	getColor()	Get the current color of an element as a Color
java.awt.Color	getOutlineColor()	Gets the outline color
java.awt.Stroke	getOutlineStroke()	Gets the outline stroke
java.awt.Point	getPos()	Get the position of the element
double	getRotation()	Get an elements rotation
protected abstract T	getThis()
int	getX()	Get the X-position of the element
int	getY()	Get the Y-position of the element.
T	hide()	Hide the Object.
T	move(int x, int y)	Moves this drawable by the specified x and y.
T	moveHorizontal(int x)	Moves this drawable by the specified x and y.
T	moveVertical(int y)	Moves this drawable by the specified x and y.
T	removeOutline()	Removes the outline from the shape
void	render(java.awt.Graphics g)	Actually render the object itself
T	rotate(double rotation)	Rotate this element by rotation°.
T	setColor(int hex)	Set the color of the object with a 8-bit RGB hex literal.
T	setColor(int r, int g, int b)	Set the color of the element with RGB.
T	setColor(java.awt.Color color)	Set the color of the object with a Color object.
T	setColor(java.lang.String color)	Set the color of the object with a certain color by name (see Hue for list of all valid names)
T	setFilled(boolean filled)	Set whether this object is filled or not
T	setOutline(int thickness)	Sets the parameters for the outline of the shape, with the color defaulting to black
T	setOutline(int thickness, java.awt.Color color)	Sets the parameters for the outline of the shape
T	setOutline(java.awt.Color color)	Sets the outline color of the shape
T	setPos(int x, int y)	Set the position of the element.
T	setRotation(double rotation)	Set an elements rotation to rotation°.
T	setX(int x)	Set the X-position of the object
T	setY(int y)	Set the Y-position of the element
T	show()	Show the Object

Methods inherited from class java.lang.Object

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

Methods inherited from interface paintingcanvas.animation.Animatable

Modifier and Type	Method	Description
default AnimationBuilder	colorTo(int hex, double duration)	Change the color of this to the specified color over duration seconds.
default AnimationBuilder	colorTo(int r, int g, int b, double duration)	Change the color of this to the specified color over duration seconds.
default AnimationBuilder	colorTo(java.awt.Color color, double duration)	Change the color of this to the specified color over duration seconds.
Drawable<?>	drawable()	Get the Drawable element from this Animatable.
default AnimationBuilder	fadeIn(double duration)	Fades this in over @{code duration} seconds.
default AnimationBuilder	fadeOut(double duration)	Fades this out over @{code duration} seconds.
default AnimationBuilder	moveBy(int x, int y, double duration)	This method moves this by the specified x and y
default AnimationBuilder	moveHorizontalBy(int x, double duration)	This method moves this by the specified x horizontally.
default AnimationBuilder	moveTo(int x, int y, double duration)	Move this to the specified x and y over duration seconds
default AnimationBuilder	moveVerticalBy(int y, double duration)	This method moves this by the specified x horizontally.
default AnimationBuilder	rotateBy(int angle, double duration)	Rotates this by angle°.
default AnimationBuilder	rotateTo(int angle, double duration)	Rotates this to the specified angle°.

Field Detail

size

public int size

The size / side-length of the square.

Constructor Detail

Square

public Square(int centerX,
              int centerY,
              int size)

Create a new Square element.

 // Create a square centered at (100, 100) with a side length of 30px
 Square square = new Square(100, 100, 30);
 

Parameters:

centerX - The X-position of the square

centerY - The Y-position of the square

size - The size of the square

Square

public Square(int centerX,
              int centerY,
              int size,
              java.awt.Color color)

Create a new Square element.

 // Create a red square centered at (100, 100) with a side length of 30px
 Square square = new Square(100, 100, 30, new Color(255, 0, 0));
 

Parameters:

centerX - The X-position of the square

centerY - The Y-position of the square

size - The size of the square

color - The color of the square

Square

public Square(int centerX,
              int centerY,
              int size,
              java.lang.String color)

Create a new Square element with a certain color by name (see Hue for list of all valid names)

 // Create a red square centered at (100, 100) with a side length of 30px
 Square square = new Square(100, 100, 30, "red");
 

Parameters:

centerX - The X-position of the square

centerY - The Y-position of the square

size - The size of the square

color - The name of the color of the square (case-insensitive)

Method Detail

drawFilled

protected void drawFilled(java.awt.Graphics2D gc)

Description copied from class: Drawable

the color is set to `color`

Specified by:

drawFilled in class Drawable<Square>

Parameters:

gc - The graphics context to draw the object with

drawOutline

protected void drawOutline(java.awt.Graphics2D gc)

Description copied from class: Drawable

the color is set to `outlineColor`, the stroke is set to `outlineStroke`

Specified by:

drawOutline in class Drawable<Square>

Parameters:

gc - The graphics context to draw the object with

getThis

public Square getThis()

Specified by:

getThis in class Drawable<Square>

getSize

public int getSize()

Gets the size of the square.

Returns:

The size of the square in pixels

See Also:

setSize(int)

setSize

public Square setSize(int s)

Sets the size of the square.

Parameters:

s - The new size of the square in pixels

Returns:

The original object to allow method chaining

See Also:

getSize()