Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni.readonly

Interface ConstGradient

All Superinterfaces:

AutoCloseable, Comparable<JoltPhysicsObject>, ConstJoltPhysicsObject

All Known Implementing Classes:

Gradient

public interface ConstGradient
extends ConstJoltPhysicsObject

Read-only access to a Gradient. (native type: HairSettings::Gradient)

Method Summary

Modifier and Type	Method	Description
float	getMax()	Return the parameter value when the fraction is maxFraction.
float	getMaxFraction()	Return the fraction at which the parameter value is max.
float	getMin()	Return the parameter value when the fraction is minFraction.
float	getMinFraction()	Return the fraction at which the parameter value is min.
void	saveBinaryState(StreamOut stream)	Write the state of this gradient to the specified stream.

Methods inherited from interface java.lang.Comparable

compareTo

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

close, hasAssignedNativeObject, ownsNativeObject, targetVa

Method Details

getMax

float getMax()

Return the parameter value when the fraction is maxFraction. The gradient is unaffected.

Returns:

the parameter value

getMaxFraction

float getMaxFraction()

Return the fraction at which the parameter value is max. The gradient is unaffected.

Returns:

the fraction

getMin

float getMin()

Return the parameter value when the fraction is minFraction. The gradient is unaffected.

Returns:

the parameter value

getMinFraction

float getMinFraction()

Return the fraction at which the parameter value is min. The gradient is unaffected.

Returns:

the fraction

saveBinaryState

void saveBinaryState(StreamOut stream)

Write the state of this gradient to the specified stream. The gradient is unaffected.

Parameters:

stream - where to write objects (not null)