Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class RRayCast

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.RRayCast

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class RRayCast
extends JoltPhysicsObject

A ray cast with an RVec3 start location.

Constructor Summary

Constructors

Constructor	Description
RRayCast(double xx, double yy, double zz, float dx, float dy, float dz)	Instantiate a ray cast with the specified endpoints.
RRayCast(RVec3Arg startLocation, Vec3Arg offset)	Instantiate a ray cast with the specified endpoints.

Method Summary

Modifier and Type	Method	Description
Vec3	getDirection()	Copy the end offset.
RVec3	getOrigin()	Copy the start location.
RVec3	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, isCleanerStarted, ownsNativeObject, setVirtualAddress, setVirtualAddress, startCleaner, targetVa, targetVaOrZero, toString, va

Methods inherited from class java.lang.Object

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

Constructor Details

RRayCast

public RRayCast(double xx,
 double yy,
 double zz,
 float dx,
 float dy,
 float dz)

Instantiate a ray cast with the specified endpoints.

Parameters:

xx - the desired X coordinate of the start location

yy - the desired Y coordinate of the start location

zz - the desired Z coordinate of the start location

dx - the X component of the end offset from the start

dy - the Y component of the end offset from the start

dz - the Z component of the end offset from the start

RRayCast

public RRayCast(RVec3Arg 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 RVec3 getOrigin()

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

Returns:

a new location vector

getPointOnRay

public RVec3 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