com.github.ptitnoony.components.fxtreemap

Class Rect

java.lang.Object

com.github.ptitnoony.components.fxtreemap.Rect

public class Rect
extends Object

A simple class implementing a geometric rectangle

Author:

tadas-subonis, ahamon

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_HEIGHT Default height of a Rect: 1.0px
static double	DEFAULT_WIDTH Default width of a Rect: 1.0px

Constructor Summary

Constructors

Constructor and Description
Rect() Creates a new Rect at (0,0) with default width and height.
Rect(double x, double y, double w, double h) Creates a new Rect with the given parameters.
Rect(Rect r) Creates a new Rect using the same attributes values as the Rect given as parameter.

Method Summary

Modifier and Type	Method and Description
double	aspectRatio() Calculates the Rect aspect ratio.
double	getHeight() get Height.
double	getWidth() Get width
double	getX() Get x position.
double	getY() get y position.
void	setRect(double x, double y, double w, double h) Updates the Rect with the given parameters.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WIDTH

public static final double DEFAULT_WIDTH

Default width of a Rect: 1.0px

See Also:

Constant Field Values

DEFAULT_HEIGHT

public static final double DEFAULT_HEIGHT

Default height of a Rect: 1.0px

See Also:

Constant Field Values

Constructor Detail

Rect

public Rect()

Creates a new Rect at (0,0) with default width and height.

Rect

public Rect(Rect r)

Creates a new Rect using the same attributes values as the Rect given as parameter.

Parameters:

r - the Rect to be used for the attributes

Rect

public Rect(double x,
            double y,
            double w,
            double h)

Creates a new Rect with the given parameters.

Parameters:

x - coordinates along the X axis

y - coordinates along the Y axis

w - width

h - height

Method Detail

aspectRatio

public double aspectRatio()

Calculates the Rect aspect ratio.

Returns:

the Rect aspect ratio

setRect

public final void setRect(double x,
                          double y,
                          double w,
                          double h)

Updates the Rect with the given parameters.

Parameters:

x - coordinates along the X axis

y - coordinates along the Y axis

w - width

h - height

getX

public double getX()

Get x position.

Returns:

coordinates along the X axis

getY

public double getY()

get y position.

Returns:

coordinates along the y axis

getWidth

public double getWidth()

Get width

Returns:

width

getHeight

public double getHeight()

get Height.

Returns:

height