Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class CollideSettingsBase

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.CollideSettingsBase

All Implemented Interfaces:

ConstJoltPhysicsObject, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

CollideShapeSettings, ShapeCastSettings

public class CollideSettingsBase
extends JoltPhysicsObject

Configurable options for a shape-oriented collision query.

Method Summary

Modifier and Type	Method	Description
EActiveEdgeMode	getActiveEdgeMode()	Return how edge collisions should be handled.
Vec3	getActiveEdgeMovementDirection()	Copy the movement direction for inactive edges.
ECollectFacesMode	getCollectFacesMode()	Return how face information should be handled.
float	getCollisionTolerance()	Return the collision tolerance for the GJK algorithm.
float	getPenetrationTolerance()	Return the termination tolerance for calculating penetration depth.
void	setActiveEdgeMode(EActiveEdgeMode mode)	Alter how edge collisions should be handled.
void	setActiveEdgeMovementDirection(Vec3Arg direction)	Alter the movement direction for inactive edges.
void	setCollectFacesMode(ECollectFacesMode mode)	Alter how face information should be handled.
void	setCollisionTolerance(float tolerance)	Alter the collision tolerance for the GJK algorithm.
void	setPenetrationTolerance(float tolerance)	Alter the termination tolerance for calculating penetration depth.

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

Method Details

getActiveEdgeMode

public EActiveEdgeMode getActiveEdgeMode()

Return how edge collisions should be handled. The settings are unaffected. (native attribute: mActiveEdgeMode)

Returns:

an enum value (not null)

getActiveEdgeMovementDirection

public Vec3 getActiveEdgeMovementDirection()

Copy the movement direction for inactive edges. The settings are unaffected. (native attribute: mActiveEdgeMovementDirection)

Returns:

a new direction vector

getCollectFacesMode

public ECollectFacesMode getCollectFacesMode()

Return how face information should be handled. The settings are unaffected. (native attribute: mCollectFacesMode)

Returns:

an enum value (not null)

getCollisionTolerance

public float getCollisionTolerance()

Return the collision tolerance for the GJK algorithm. The settings are unaffected. (native attribute: mCollisionTolerance)

Returns:

an enum value (not null)

getPenetrationTolerance

public float getPenetrationTolerance()

Return the termination tolerance for calculating penetration depth. The settings are unaffected. (native attribute: mPenetrationTolerance)

Returns:

the tolerance

setActiveEdgeMode

public void setActiveEdgeMode(EActiveEdgeMode mode)

Alter how edge collisions should be handled. (native attribute: mActiveEdgeMode)

Parameters:

mode - the desired mode (not null, default=CollideOnlyWithActive)

setActiveEdgeMovementDirection

public void setActiveEdgeMovementDirection(Vec3Arg direction)

Alter the movement direction for inactive edges. (native attribute: mActiveEdgeMovementDirection)

Parameters:

direction - the desired direction (not null, unaffected, default=(0,0,0))

setCollectFacesMode

public void setCollectFacesMode(ECollectFacesMode mode)

Alter how face information should be handled. (native attribute: mCollectFacesMode)

Parameters:

mode - the desired mode (not null, default=NoFaces)

setCollisionTolerance

public void setCollisionTolerance(float tolerance)

Alter the collision tolerance for the GJK algorithm. (native attribute: mCollisionTolerance)

Parameters:

tolerance - the desired tolerance (in meters, default=cDefaultCollisionTolerance)

setPenetrationTolerance

public void setPenetrationTolerance(float tolerance)

Alter the termination tolerance for calculating penetration depth. (native attribute: mPenetrationTolerance)

Parameters:

tolerance - the desired tolerance (default=cDefaultPenetrationTolerance)