Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class PathConstraintPath

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.SerializableObject

com.github.stephengold.joltjni.PathConstraintPath

All Implemented Interfaces:

ConstJoltPhysicsObject, ConstPathConstraintPath, ConstSerializableObject, RefTarget, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

PathConstraintPathHermite

public class PathConstraintPath
extends SerializableObject
implements ConstPathConstraintPath

The path for a path constraint.

Method Summary

Modifier and Type	Method	Description
float	getClosestPoint(Vec3Arg location, float fractionHint)	Return the path amount of the location on the path that's closest to the specified location.
float	getPathMaxFraction()	Return the path amount of the end of the path.
void	getPointOnPath(float amount, Vec3 storeLocation, Vec3 storeTangent, Vec3 storeNormal, Vec3 storeBinormal)	Calculate the location, normal, and binormal of the location on the path with the specified path amount.
int	getRefCount()	Count the active references to the native PathConstraintPath.
boolean	isLooping()	Test whether the path is looping.
void	saveBinaryState(StreamOut stream)	Save the path to the specified binary stream.
void	setEmbedded()	Mark the native PathConstraintPath as embedded.
void	setIsLooping(boolean setting)	Alter whether the path is looping.
protected final void	setVirtualAddressAsCoOwner(long pathVa)	Assign a native object (assuming there's none already assigned) and designate the JVM object as a co-owner.
static PathResult	sRestoreFromBinaryState(StreamIn stream)	Read a path from the specified binary stream.
PathConstraintPathRef	toRef()	Create a counted reference to the native PathConstraintPath.

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

getRtti

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

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

getRtti

Method Details

setIsLooping

public void setIsLooping(boolean setting)

Alter whether the path is looping.

Parameters:

setting - true for looping, or false for no looping (default=false)

sRestoreFromBinaryState

public static PathResult sRestoreFromBinaryState(StreamIn stream)

Read a path from the specified binary stream.

Parameters:

stream - where to read objects (not null)

Returns:

a new object

setVirtualAddressAsCoOwner

protected final void setVirtualAddressAsCoOwner(long pathVa)

Assign a native object (assuming there's none already assigned) and designate the JVM object as a co-owner.

Parameters:

pathVa - the virtual address of the native object to assign (not zero)

getClosestPoint

public float getClosestPoint(Vec3Arg location,
 float fractionHint)

Return the path amount of the location on the path that's closest to the specified location. The path is unaffected.

Specified by:

getClosestPoint in interface ConstPathConstraintPath

Parameters:

location - the input location (in system coordinates, not null, unaffected)

fractionHint - where to start searching

Returns:

the path amount (≥0)

getPathMaxFraction

public float getPathMaxFraction()

Return the path amount of the end of the path. The path is unaffected.

Specified by:

getPathMaxFraction in interface ConstPathConstraintPath

Returns:

the path amount (≥0)

getPointOnPath

public void getPointOnPath(float amount,
 Vec3 storeLocation,
 Vec3 storeTangent,
 Vec3 storeNormal,
 Vec3 storeBinormal)

Calculate the location, normal, and binormal of the location on the path with the specified path amount. The path is unaffected.

Specified by:

getPointOnPath in interface ConstPathConstraintPath

Parameters:

amount - the path amount (≥0)

storeLocation - storage for the location (in system coordinates)

storeTangent - storage for the tangent direction (in system coordinates)

storeNormal - storage for the normal direction (in system coordinates)

storeBinormal - storage for the binormal direction (in system coordinates)

isLooping

public boolean isLooping()

Test whether the path is looping. The path is unaffected.

Specified by:

isLooping in interface ConstPathConstraintPath

Returns:

true if looping, otherwise false

saveBinaryState

public void saveBinaryState(StreamOut stream)

Save the path to the specified binary stream. The path is unaffected.

Specified by:

saveBinaryState in interface ConstPathConstraintPath

Parameters:

stream - the stream to write to (not null)

getRefCount

public int getRefCount()

Count the active references to the native PathConstraintPath. The path is unaffected.

Specified by:

getRefCount in interface RefTarget

Returns:

the count (≥0)

setEmbedded

public void setEmbedded()

Mark the native PathConstraintPath as embedded.

Specified by:

setEmbedded in interface RefTarget

toRef

public PathConstraintPathRef toRef()

Create a counted reference to the native PathConstraintPath.

Specified by:

toRef in interface RefTarget

Returns:

a new JVM object with a new native object assigned