com.almasb.fxgl.physics

Class BoundingShape

java.lang.Object

com.almasb.fxgl.physics.BoundingShape

public final class BoundingShape
extends Object

Defines bounding shapes to be used for hit boxes.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Method Summary

Modifier and Type	Method and Description
static BoundingShape	box(double width, double height) Constructs new rectangular bounding shape with given width and height.
static BoundingShape	chain(javafx.geometry.Point2D... points) Constructs new closed chain shaped bounding shape.
static BoundingShape	circle(double radius) Constructs new circular bounding shape with given radius.
boolean	isCircle()
boolean	isRectangle()

Methods inherited from class java.lang.Object

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

Method Detail

isCircle

public boolean isCircle()

Returns:

true if the type of this shape is a circle

isRectangle

public boolean isRectangle()

Returns:

true if the type of this shape is a rectangle/square

circle

public static BoundingShape circle(double radius)

Constructs new circular bounding shape with given radius.

Parameters:

radius - circle radius

Returns:

circular bounding shape

box

public static BoundingShape box(double width,
                                double height)

Constructs new rectangular bounding shape with given width and height.

Parameters:

width - box width

height - box height

Returns:

rectangular bounding shape

chain

public static BoundingShape chain(javafx.geometry.Point2D... points)

Constructs new closed chain shaped bounding shape. Note: chain shape can only be used with static objects. Note: chain shape must have at least 2 points

Parameters:

points - points to use in a chain

Returns:

closed chain bounding shape

Throws:

IllegalArgumentException - if number of points is less than 2