com.jayfella.jme.vehicle

Interface VehicleSpeed

All Known Implementing Classes:

Vehicle

public interface VehicleSpeed

Interface to the speed (and maximum speed) of a Vehicle, for use in speedometers.

Method Summary

Modifier and Type	Method and Description
float	forwardSpeed(SpeedUnit speedUnit) Determine the forward component of the vehicle's inertial velocity.
float	maxForwardSpeed(SpeedUnit speedUnit) Estimate the vehicle's maximum forward speed.
float	maxReverseSpeed(SpeedUnit speedUnit) Estimate the vehicle's maximum reverse speed.

Method Detail

forwardSpeed

float forwardSpeed(SpeedUnit speedUnit)

Determine the forward component of the vehicle's inertial velocity.

Parameters:

speedUnit - the unit of measurement to use (not null)

Returns:

the speed (in the specified units, may be negative)

maxForwardSpeed

float maxForwardSpeed(SpeedUnit speedUnit)

Estimate the vehicle's maximum forward speed.

Parameters:

speedUnit - the unit of measurement to use (not null)

Returns:

the speed (in the specified units, ≥0)

maxReverseSpeed

float maxReverseSpeed(SpeedUnit speedUnit)

Estimate the vehicle's maximum reverse speed.

Parameters:

speedUnit - the unit of measurement to use (not null)

Returns:

the speed (in the specified units, ≤0)