com.almasb.fxgl.physics

Class RaycastResult

java.lang.Object

com.almasb.fxgl.physics.RaycastResult

public final class RaycastResult
extends Object

Result of a raycast. Contains optional entity and point which represent first non ignored physics entity and its point of collision in the ray's path.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static RaycastResult	NONE

Method Summary

Modifier and Type	Method and Description
Optional<Entity>	getEntity()
Optional<javafx.geometry.Point2D>	getPoint()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final RaycastResult NONE

Method Detail

getEntity

public Optional<Entity> getEntity()

Returns:

the first physics entity that collided with the ray whose raycastIgnored flag is false

getPoint

public Optional<javafx.geometry.Point2D> getPoint()

Returns:

the collision point in world coordinates