Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class ClosestHitCastShapeCollector

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.CastShapeCollector

com.github.stephengold.joltjni.ClosestHitCastShapeCollector

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

public class ClosestHitCastShapeCollector
extends CastShapeCollector

Collect the closest result from a narrow-phase shape-cast query. (native type: ClosestHitCollisionCollector<CastShapeCollector>)

Constructor Summary

Constructors

Constructor	Description
ClosestHitCastShapeCollector()	Instantiate a default collector.

Method Summary

Modifier and Type	Method	Description
ShapeCastResult	getHit()	Access the result of the latest query.
boolean	hadHit()	Test whether the latest query resulted in a hit.
void	reset()	Reset the collector so it can be reused.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ClosestHitCastShapeCollector

public ClosestHitCastShapeCollector()

Instantiate a default collector.

Method Details

getHit

public ShapeCastResult getHit()

Access the result of the latest query. (native field: mHit)

Returns:

a new JVM object with the pre-existing native object assigned

hadHit

public boolean hadHit()

Test whether the latest query resulted in a hit. The collector is unaffected.

Returns:

true if there was a hit, otherwise false

reset

public void reset()

Reset the collector so it can be reused.

Specified by:

reset in class CastShapeCollector