Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class RayCast

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.RayCast

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class RayCast
extends JoltPhysicsObject

A ray cast with a single-precision start location.

Constructor Summary

Constructors

Constructor	Description
RayCast(Vec3Arg startLocation, Vec3Arg offset)	Instantiate a ray cast with the specified endpoints.

Method Summary

Modifier and Type	Method	Description
Vec3	getDirection()	Copy the end offset.
Vec3	getOrigin()	Copy the start location.
Vec3	getPointOnRay(float fraction)	Return a point on the ray with the specified fraction.

Methods inherited from class com.github.stephengold.joltjni.JoltPhysicsObject

close, compareTo, equals, getContainingObject, hasAssignedNativeObject, hashCode, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, toString, va

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RayCast

public RayCast(Vec3Arg startLocation,
 Vec3Arg offset)

Instantiate a ray cast with the specified endpoints.

Parameters:

startLocation - the desired start location (not null, unaffected)

offset - the desired end offset from the start (not null, unaffected)

Method Details

getDirection

public Vec3 getDirection()

Copy the end offset. The ray cast is unaffected. (native attribute: mDirection)

Returns:

a new offset vector (relative to the start location)

getOrigin

public Vec3 getOrigin()

Copy the start location. The ray cast is unaffected. (native attribute: mOrigin)

Returns:

a new location vector

getPointOnRay

public Vec3 getPointOnRay(float fraction)

Return a point on the ray with the specified fraction. The ray cast is unaffected.

Parameters:

fraction - (0→start of ray, 1→end of ray)

Returns:

a new location vector