Module com.github.stephengold.joltjni

Package com.github.stephengold.joltjni

Class VehicleEngineSettings

java.lang.Object

com.github.stephengold.joltjni.JoltPhysicsObject

com.github.stephengold.joltjni.VehicleEngineSettings

All Implemented Interfaces:

ConstJoltPhysicsObject, ConstVehicleEngineSettings, AutoCloseable, Comparable<JoltPhysicsObject>

Direct Known Subclasses:

VehicleEngine

public class VehicleEngineSettings
extends JoltPhysicsObject
implements ConstVehicleEngineSettings

Settings used to configure the engine of a WheeledVehicleController.

Constructor Summary

Constructors

Constructor	Description
VehicleEngineSettings()	Instantiate default settings.
VehicleEngineSettings(ConstVehicleEngineSettings original)	Instantiate a copy of the specified settings.

Method Summary

Modifier and Type	Method	Description
float	getAngularDamping()	Return the angular damping factor.
float	getInertia()	Return the engine's rotational inertia.
float	getMaxRpm()	Return the maximum rotation rate.
float	getMaxTorque()	Return the maximum torque.
float	getMinRpm()	Return the minimum rotation rate to avoid stalling.
LinearCurve	getNormalizedTorque()	Access the normalized torque as a function of normalized RPM.
void	setAngularDamping(float damping)	Alter the angular damping factor.
void	setInertia(float inertia)	Alter the engine's rotational inertia.
void	setMaxRpm(float rpm)	Alter the maximum rotation rate.
void	setMaxTorque(float torque)	Alter the maximum torque.
void	setMinRpm(float rpm)	Alter the minimum rotation rate to avoid stalling.
void	setNormalizedTorque(ConstLinearCurve curve)	Copy the specified curve to the normalized-torque curve.

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

Constructor Details

VehicleEngineSettings

public VehicleEngineSettings()

Instantiate default settings.

VehicleEngineSettings

public VehicleEngineSettings(ConstVehicleEngineSettings original)

Instantiate a copy of the specified settings.

Parameters:

original - the settings to copy (not null, unaffected)

Method Details

setAngularDamping

public void setAngularDamping(float damping)

Alter the angular damping factor. (native attribute: mAngularDamping)

Parameters:

damping - the desired damping factor (per second, default=0.2)

setInertia

public void setInertia(float inertia)

Alter the engine's rotational inertia. (native attribute: mInertia)

Parameters:

inertia - the desired inertia (in kg.meter^2, default=0.5)

setMaxRpm

public void setMaxRpm(float rpm)

Alter the maximum rotation rate. (native attribute: mMaxRPM)

Parameters:

rpm - the desired limit (in revolutions per minute, default=6000)

setMaxTorque

public void setMaxTorque(float torque)

Alter the maximum torque. (native attribute: mMaxTorque)

Parameters:

torque - the desired limit (in Newton meters, default=500)

setMinRpm

public void setMinRpm(float rpm)

Alter the minimum rotation rate to avoid stalling. (native attribute: mMinRPM)

Parameters:

rpm - the desired limit (in revolutions per minute, default=1000)

setNormalizedTorque

public void setNormalizedTorque(ConstLinearCurve curve)

Copy the specified curve to the normalized-torque curve. (native attribute: mNormalizedTorque)

Parameters:

curve - the curve to copy (not null, unaffected)

getAngularDamping

public float getAngularDamping()

Return the angular damping factor. The settings are unaffected. (native attribute: mAngularDamping)

Specified by:

getAngularDamping in interface ConstVehicleEngineSettings

Returns:

the damping factor (per second)

getInertia

public float getInertia()

Return the engine's rotational inertia. The settings are unaffected. (native attribute: mInertia)

Specified by:

getInertia in interface ConstVehicleEngineSettings

Returns:

the inertia (in kilogram.meter^2)

getMaxRpm

public float getMaxRpm()

Return the maximum rotation rate. The settings are unaffected. (native attribute: mMaxRPM)

Specified by:

getMaxRpm in interface ConstVehicleEngineSettings

Returns:

the limit (in revolutions per minute)

getMaxTorque

public float getMaxTorque()

Return the maximum torque. The settings are unaffected. (native attribute: mMaxTorque)

Specified by:

getMaxTorque in interface ConstVehicleEngineSettings

Returns:

the limit (in Newton meters)

getMinRpm

public float getMinRpm()

Return the minimum rotation rate to avoid stalling. The settings are unaffected. (native attribute: mMinRPM)

Specified by:

getMinRpm in interface ConstVehicleEngineSettings

Returns:

the limit (in revolutions per minute)

getNormalizedTorque

public LinearCurve getNormalizedTorque()

Access the normalized torque as a function of normalized RPM. (native attribute: mNormalizedTorque)

Specified by:

getNormalizedTorque in interface ConstVehicleEngineSettings

Returns:

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