org.lazywizard.lazylib

Class CollisionUtils

Object

CollisionUtils

public class CollisionUtils
extends Object

Contains methods for line intersection, bounds and collision detection tests.

Since:

1.0

Author:

LazyWizard

Method Summary

Modifier and Type	Method and Description
static boolean	getCollides(Vector2f lineStart, Vector2f lineEnd, Vector2f circleCenter, float circleRadius) Checks if a line connects with a circle.
static @Nullable Vector2f	getCollisionPoint(Vector2f lineStart, Vector2f lineEnd, CombatEntityAPI target) Finds the part of the ship that would be intersected by a given path.
static @Nullable Vector2f	getCollisionPoint(Vector2f start1, Vector2f end1, Vector2f start2, Vector2f end2) Finds the point of intersection between two lines.
static @NotNull Vector2f	getNearestPointOnBounds(Vector2f source, CombatEntityAPI entity) Returns the closest point on a CombatEntityAPI's collision bounds to a point.
static boolean	isPointOnSegment(Vector2f point, BoundsAPI.SegmentAPI segment) Check if a point is along a BoundsAPI.SegmentAPI.
static boolean	isPointWithinBounds(Vector2f point, CombatEntityAPI entity) Checks if a point is inside or on the bounds of a CombatEntityAPI.
static boolean	isPointWithinCollisionCircle(Vector2f point, CombatEntityAPI entity) Checks if a point is inside the collision circle of a CombatEntityAPI.

Methods inherited from class Object

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

Method Detail

getCollisionPoint

@Nullable
public static @Nullable Vector2f getCollisionPoint(Vector2f lineStart,
                                                              Vector2f lineEnd,
                                                              CombatEntityAPI target)

Finds the part of the ship that would be intersected by a given path. Important note: if the line is completely within target's bounds, no collision will be detected!

Parameters:

target - The CombatEntityAPI to check collision with.

lineStart - The start of the line to test collision with.

lineEnd - The end of the line to test collision with.

Returns:

The Vector2f of the point the line would hit at, or null if it doesn't hit.

Since:

1.0

getCollisionPoint

@Nullable
public static @Nullable Vector2f getCollisionPoint(Vector2f start1,
                                                              Vector2f end1,
                                                              Vector2f start2,
                                                              Vector2f end2)

Finds the point of intersection between two lines. Accurate to within 1/3 su.

Parameters:

start1 - The start of the first line to test collision with.

end1 - The end of the first line to test collision with.

start2 - The start of the second line to test collision with.

end2 - The end of the second line to test collision with.

Returns:

The Vector2f that the two lines intersect at, null if they don't collide.

Since:

1.0

getCollides

public static boolean getCollides(Vector2f lineStart,
                                  Vector2f lineEnd,
                                  Vector2f circleCenter,
                                  float circleRadius)

Checks if a line connects with a circle.

Parameters:

lineStart - The start point of the line to test.

lineEnd - The end point of the line to test.

circleCenter - The center point of the circle.

circleRadius - The radius of the circle.

Returns:

true if the line collides with the circle, false otherwise.

Since:

1.0

getNearestPointOnBounds

@NotNull
public static @NotNull Vector2f getNearestPointOnBounds(Vector2f source,
                                                                  CombatEntityAPI entity)

Returns the closest point on a CombatEntityAPI's collision bounds to a point. If the entity lacks collision bounds, the closest point on its collision radius will be returned instead.

Parameters:

source - The point to check distance from.

entity - The entity whose bounds will be checked.

Returns:

The closest point to source on entity's BoundsAPI, or the closest point on its collision radius if it lacks collision bounds.

Since:

2.3

isPointWithinCollisionCircle

public static boolean isPointWithinCollisionCircle(Vector2f point,
                                                   CombatEntityAPI entity)

Checks if a point is inside the collision circle of a CombatEntityAPI.

Parameters:

point - The Vector2f to check.

entity - The CombatEntityAPI whose BoundsAPI we are checking against.

Returns:

true if point is within the collision circle of entity, false otherwise.

Since:

1.4

isPointOnSegment

public static boolean isPointOnSegment(Vector2f point,
                                       BoundsAPI.SegmentAPI segment)

Check if a point is along a BoundsAPI.SegmentAPI. Accurate to within 1/3 su, use MathUtils.isPointOnLine(Vector2f, Vector2f, Vector2f) if you need higher precision.

Parameters:

point - The point to check.

segment - The BoundsAPI.SegmentAPI to check for collision with.

Returns:

true if the point is along the line, false otherwise.

Since:

1.6b

isPointWithinBounds

public static boolean isPointWithinBounds(Vector2f point,
                                          CombatEntityAPI entity)

Checks if a point is inside or on the bounds of a CombatEntityAPI.

Parameters:

point - The Vector2f to check.

entity - The CombatEntityAPI whose BoundsAPI we are checking against.

Returns:

true if point is within or on the bounds of entity, false otherwise.

Since:

1.0