java.lang.Object
- paintingcanvas.drawable.Drawable<Ellipse>
- - paintingcanvas.drawable.Ellipse

All Implemented Interfaces:: Animatable

public class Ellipse
extends Drawable<Ellipse>

An ellipse element.


 // Create a new ellipse at (100, 100) with width 20 and height 30
 Ellipse ellipse = new Ellipse(100, 100, 20, 30);

Field Summary

Fields
Modifier and Type Field Description

int height
The height of the ellipse.

int width
The width of the ellipse.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getHeight()`	Gets the height of the ellipse.
`protected Ellipse`	`getThis()`
`int`	`getWidth()`	Gets the width of the ellipse.
`Ellipse`	`setHeight(int h)`	Sets the height of the ellipse.
`Ellipse`	`setWidth(int w)`	Sets the width of the ellipse.

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
  - width
```
public int width
```
    The width of the ellipse.
  - height
```
public int height
```
    The height of the ellipse.
- Constructor Detail
  - Ellipse
```
public Ellipse(int centerX,
               int centerY,
               int width,
               int height)
```
    Create a new Ellipse element.
    // Create a new ellipse centered at (100, 100) with width 20 and height 30 Ellipse ellipse = new Ellipse(100, 100, 20, 30);
    Parameters:
    
    centerX - The X-position of the ellipse
    
    centerY - The Y-position of the ellipse
    
    width - The width of the ellipse
    
    height - The height of the ellipse
  - Ellipse
```
public Ellipse(int centerX,
               int centerY,
               int width,
               int height,
               java.awt.Color color)
```
    Create a new Ellipse element.
    // Create a new red ellipse centered at (100, 100) with width 20 and height 30 Ellipse ellipse = new Ellipse(100, 100, 20, 30, new Color(255, 0, 0));
    Parameters:
    
    centerX - The X-position of the ellipse
    
    centerY - The Y-position of the ellipse
    
    width - The width of the ellipse
    
    height - The height of the ellipse
    
    color - The color of the ellipse
  - Ellipse
```
public Ellipse(int centerX,
               int centerY,
               int width,
               int height,
               java.lang.String color)
```
    Create a new Ellipse element with a certain color by name (see Hue for list of all valid names)
    // Create a new red ellipse centered at (100, 100) with width 20 and height 30 Ellipse ellipse = new Ellipse(100, 100, 20, 30, "red");
    Parameters:
    
    centerX - The X-position of the ellipse
    
    centerY - The Y-position of the ellipse
    
    width - The width of the ellipse
    
    height - The height of the ellipse
    
    color - The name of the color (case-insensitive)
- Method Detail
  - 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<Ellipse>
    
    Parameters:
    
    gc - The graphics context to draw the object with
  - 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<Ellipse>
    
    Parameters:
    
    gc - The graphics context to draw the object with
  - getThis
```
protected Ellipse getThis()
```
    Specified by:
    
    getThis in class Drawable<Ellipse>
  - getWidth
```
public int getWidth()
```
    Gets the width of the ellipse.
    
    Returns:
    
    The width of the ellipse in pixels
    
    See Also:
    
    getHeight(), setWidth(int)
  - setWidth
```
public Ellipse setWidth(int w)
```
    Sets the width of the ellipse.
    
    Parameters:
    
    w - The new width of the ellipse in pixels
    
    Returns:
    
    The original object to allow method chaining
    
    See Also:
    
    setHeight(int), getWidth()
  - getHeight
```
public int getHeight()
```
    Gets the height of the ellipse.
    
    Returns:
    
    The height of the ellipse in pixels
    
    See Also:
    
    getWidth(), setHeight(int)
  - setHeight
```
public Ellipse setHeight(int h)
```
    Sets the height of the ellipse.
    
    Parameters:
    
    h - The new height of the ellipse in pixels
    
    Returns:
    
    The original object to allow method chaining
    
    See Also:
    
    setWidth(int), getHeight()

Modifier and Type	Field	Description
`int`	`height`	The height of the ellipse.
`int`	`width`	The width of the ellipse.

Class Ellipse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class paintingcanvas.drawable.Drawable

Methods inherited from class java.lang.Object

Methods inherited from interface paintingcanvas.animation.Animatable

Field Detail

width

height

Constructor Detail

Ellipse

Ellipse

Ellipse

Method Detail

drawOutline

drawFilled

getThis

getWidth

setWidth

getHeight

setHeight