Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class BroadPhaseQuery

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.NonCopyable

com.github.stephengold.joltjni.BroadPhaseQuery

All Implemented Interfaces:

ConstBroadPhaseQuery, ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

BroadPhase

public class BroadPhaseQuery
extends NonCopyable
implements ConstBroadPhaseQuery

Interface for crude collision detection against the bounding boxes in a PhysicsSystem.

Method Summary

Modifier and Type	Method	Description
void	castAaBox(AaBoxCast boxCast, CastShapeBodyCollector collector)	Cast a box along a line segment and collect the resulting hits.
void	castAaBox(AaBoxCast boxCast, CastShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Cast a box along a line segment and collect the resulting hits.
void	castAaBox(AaBoxCast boxCast, CastShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Cast a box along a line segment and collect the resulting hits.
void	castRay(RayCast raycast, RayCastBodyCollector collector)	Cast a ray and collect the resulting hits.
void	castRay(RayCast raycast, RayCastBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Cast a ray and collect the resulting hits.
void	castRay(RayCast raycast, RayCastBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Cast a ray and collect the resulting hits.
void	collideAaBox(ConstAaBox box, CollideShapeBodyCollector collector)	Collect bodies whose bounding boxes overlap with the specified test box.
void	collideAaBox(ConstAaBox box, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Collect bodies whose bounding boxes overlap with the specified test box.
void	collideAaBox(ConstAaBox box, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Collect bodies whose bounding boxes overlap with the specified test box.
void	collideOrientedBox(ConstOrientedBox box, CollideShapeBodyCollector collector)	Collect bodies whose bounding boxes intersect the specified oriented box.
void	collideOrientedBox(ConstOrientedBox box, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Collect bodies whose bounding boxes intersect the specified oriented box.
void	collideOrientedBox(ConstOrientedBox box, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Collect bodies whose bounding boxes intersect the specified oriented box.
void	collidePoint(Vec3Arg point, CollideShapeBodyCollector collector)	Collect bodies whose bounding boxes intersect the specified point.
void	collidePoint(Vec3Arg point, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Collect bodies whose bounding boxes intersect the specified point.
void	collidePoint(Vec3Arg point, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Collect bodies whose bounding boxes intersect the specified point.
void	collideSphere(Vec3Arg center, float radius, CollideShapeBodyCollector collector)	Collect bodies whose bounding boxes intersect the specified test sphere.
void	collideSphere(Vec3Arg center, float radius, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter)	Collect bodies whose bounding boxes intersect the specified test sphere.
void	collideSphere(Vec3Arg center, float radius, CollideShapeBodyCollector collector, BroadPhaseLayerFilter bplFilter, ObjectLayerFilter olFilter)	Collect bodies whose bounding boxes intersect the specified test sphere.
PhysicsSystem	getSystem()	Access the underlying PhysicsSystem.

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

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.github.stephengold.joltjni.readonly.ConstJoltPhysicsObject

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Method Details

getSystem

public PhysicsSystem getSystem()

Access the underlying PhysicsSystem.

Returns:

the pre-existing instance, or null if none

castAaBox

public void castAaBox(AaBoxCast boxCast,
 CastShapeBodyCollector collector)

Cast a box along a line segment and collect the resulting hits.

Specified by:

castAaBox in interface ConstBroadPhaseQuery

Parameters:

boxCast - the test box and route (not null, unaffected)

collector - the hit collector to use (not null)

castAaBox

public void castAaBox(AaBoxCast boxCast,
 CastShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Cast a box along a line segment and collect the resulting hits.

Specified by:

castAaBox in interface ConstBroadPhaseQuery

Parameters:

boxCast - the test box and route (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

castAaBox

public void castAaBox(AaBoxCast boxCast,
 CastShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Cast a box along a line segment and collect the resulting hits.

Specified by:

castAaBox in interface ConstBroadPhaseQuery

Parameters:

boxCast - the test box and route (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)

castRay

public void castRay(RayCast raycast,
 RayCastBodyCollector collector)

Cast a ray and collect the resulting hits.

Specified by:

castRay in interface ConstBroadPhaseQuery

Parameters:

raycast - the test ray (not null, unaffected)

collector - the hit collector to use (not null)

castRay

public void castRay(RayCast raycast,
 RayCastBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Cast a ray and collect the resulting hits.

Specified by:

castRay in interface ConstBroadPhaseQuery

Parameters:

raycast - the test ray (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

castRay

public void castRay(RayCast raycast,
 RayCastBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Cast a ray and collect the resulting hits.

Specified by:

castRay in interface ConstBroadPhaseQuery

Parameters:

raycast - the test ray (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)

collideAaBox

public void collideAaBox(ConstAaBox box,
 CollideShapeBodyCollector collector)

Collect bodies whose bounding boxes overlap with the specified test box.

Specified by:

collideAaBox in interface ConstBroadPhaseQuery

Parameters:

box - the test box (not null, unaffected)

collector - the hit collector to use (not null)

collideAaBox

public void collideAaBox(ConstAaBox box,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Collect bodies whose bounding boxes overlap with the specified test box.

Specified by:

collideAaBox in interface ConstBroadPhaseQuery

Parameters:

box - the test box (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

collideAaBox

public void collideAaBox(ConstAaBox box,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Collect bodies whose bounding boxes overlap with the specified test box.

Specified by:

collideAaBox in interface ConstBroadPhaseQuery

Parameters:

box - the test box (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)

collideOrientedBox

public void collideOrientedBox(ConstOrientedBox box,
 CollideShapeBodyCollector collector)

Collect bodies whose bounding boxes intersect the specified oriented box.

Specified by:

collideOrientedBox in interface ConstBroadPhaseQuery

Parameters:

box - the box to test (not null, unaffected)

collector - the hit collector to use (not null)

collideOrientedBox

public void collideOrientedBox(ConstOrientedBox box,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Collect bodies whose bounding boxes intersect the specified oriented box.

Specified by:

collideOrientedBox in interface ConstBroadPhaseQuery

Parameters:

box - the box to test (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

collideOrientedBox

public void collideOrientedBox(ConstOrientedBox box,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Collect bodies whose bounding boxes intersect the specified oriented box.

Specified by:

collideOrientedBox in interface ConstBroadPhaseQuery

Parameters:

box - the box to test (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)

collidePoint

public void collidePoint(Vec3Arg point,
 CollideShapeBodyCollector collector)

Collect bodies whose bounding boxes intersect the specified point.

Specified by:

collidePoint in interface ConstBroadPhaseQuery

Parameters:

point - the location to test (not null, unaffected)

collector - the hit collector to use (not null)

collidePoint

public void collidePoint(Vec3Arg point,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Collect bodies whose bounding boxes intersect the specified point.

Specified by:

collidePoint in interface ConstBroadPhaseQuery

Parameters:

point - the location to test (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

collidePoint

public void collidePoint(Vec3Arg point,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Collect bodies whose bounding boxes intersect the specified point.

Specified by:

collidePoint in interface ConstBroadPhaseQuery

Parameters:

point - the location to test (not null, unaffected)

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)

collideSphere

public void collideSphere(Vec3Arg center,
 float radius,
 CollideShapeBodyCollector collector)

Collect bodies whose bounding boxes intersect the specified test sphere.

Specified by:

collideSphere in interface ConstBroadPhaseQuery

Parameters:

center - the center of the test sphere (not null, unaffected)

radius - the radius of the test sphere

collector - the hit collector to use (not null)

collideSphere

public void collideSphere(Vec3Arg center,
 float radius,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter)

Collect bodies whose bounding boxes intersect the specified test sphere.

Specified by:

collideSphere in interface ConstBroadPhaseQuery

Parameters:

center - the center of the test sphere (not null, unaffected)

radius - the radius of the test sphere

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

collideSphere

public void collideSphere(Vec3Arg center,
 float radius,
 CollideShapeBodyCollector collector,
 BroadPhaseLayerFilter bplFilter,
 ObjectLayerFilter olFilter)

Collect bodies whose bounding boxes intersect the specified test sphere.

Specified by:

collideSphere in interface ConstBroadPhaseQuery

Parameters:

center - the center of the test sphere (not null, unaffected)

radius - the radius of the test sphere

collector - the hit collector to use (not null)

bplFilter - the broadphase-layer filter to apply (not null, unaffected)

olFilter - the object-layer filter to apply (not null, unaffected)