com.jayfella.jme.vehicle.part

Class Engine

java.lang.Object

com.jayfella.jme.vehicle.part.Engine

All Implemented Interfaces:

EngineSpeed

public abstract class Engine
extends java.lang.Object
implements EngineSpeed

An engine to propel a Vehicle. Derived from the Engine class in the Advanced Vehicles project.

Field Summary

Fields

Modifier and Type	Field and Description
static float	HP_TO_W approximate factor to convert horsepower to Watts
static java.util.logging.Logger	logger message logger for this class

Constructor Summary

Constructors

Constructor and Description
Engine(java.lang.String name, float maxWatts, float idleRpm, float redlineRpm) Instantiate an Engine in the "off" state, without audio.

Method Summary

Modifier and Type	Method and Description
protected static float	evaluateSpline(com.jme3.math.Spline powerCurve, float rpm) Determine the power output for the specified speed, using a Spline.
float	getMaxOutputWatts() Determine the maximum power output.
java.lang.String	getName() Determine this engine's name.
Sound	getSound() Access the engine's sound.
float	idleFraction() Determine the idle speed as a fraction of the redline.
float	idleRpm() Determine the idle speed of the Engine.
boolean	isRunning() Test whether this Engine is running.
float	outputWatts() Determine the current power output.
abstract float	powerFraction(float rpm) Determine the power output for the specified speed.
float	redlineRpm() Determine the redline speed of the Engine.
float	rpm() Determine the current engine speed.
float	rpmFraction() Determine the current engine speed as a fraction of the redline.
void	setMaxOutputWatts(float watts) Alter this engine's maximum power output.
void	setRpmFraction(float revs) Alter the engine's speed as a fraction of the redline.
void	setRunning(boolean newState) Alter whether this Engine is running.
void	setSound(Sound desiredSound) Alter the engine's Sound.
void	setVehicle(HasNode desiredVehicle) Alter which vehicle (if any) contains this Engine.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HP_TO_W

public static final float HP_TO_W

approximate factor to convert horsepower to Watts

See Also:

Constant Field Values

logger

public static final java.util.logging.Logger logger

message logger for this class

Constructor Detail

Engine

public Engine(java.lang.String name,
              float maxWatts,
              float idleRpm,
              float redlineRpm)

Instantiate an Engine in the "off" state, without audio.

Parameters:

name - the desired name (not null)

maxWatts - the desired maximum power output (in Watts, >0)

idleRpm - the desired idle speed (in RPMs, ≥0, <redlineRpm)

redlineRpm - the desired redline speed (>0)

Method Detail

getMaxOutputWatts

public float getMaxOutputWatts()

Determine the maximum power output.

Returns:

the power (in Watts, >0)

getName

public java.lang.String getName()

Determine this engine's name.

Returns:

the descriptive name (not null)

getSound

public Sound getSound()

Access the engine's sound.

Returns:

the pre-existing Sound, or null for silence

isRunning

public boolean isRunning()

Test whether this Engine is running.

Returns:

true if running, otherwise false

outputWatts

public float outputWatts()

Determine the current power output.

Returns:

the power (in Watts, >0, ≤maxOutputWatts)

powerFraction

public abstract float powerFraction(float rpm)

Determine the power output for the specified speed.

Parameters:

rpm - the crankshaft rotation rate (in revolutions per minute, ≥0)

Returns:

the fractional power output (between 0 and 1)

setMaxOutputWatts

public void setMaxOutputWatts(float watts)

Alter this engine's maximum power output.

Parameters:

watts - the desired amount of power (>0)

setRpmFraction

public void setRpmFraction(float revs)

Alter the engine's speed as a fraction of the redline.

Parameters:

revs - the desired fraction (≥0)

setRunning

public void setRunning(boolean newState)

Alter whether this Engine is running.

Parameters:

newState - the desired state (default=false)

setSound

public void setSound(Sound desiredSound)

Alter the engine's Sound.

Parameters:

desiredSound - the desired Sound (loaded), or null for silence

setVehicle

public void setVehicle(HasNode desiredVehicle)

Alter which vehicle (if any) contains this Engine.

Parameters:

desiredVehicle - the desired Vehicle, or null for none

evaluateSpline

protected static float evaluateSpline(com.jme3.math.Spline powerCurve,
                                      float rpm)

Determine the power output for the specified speed, using a Spline.

Parameters:

powerCurve - the spline to use (not null, unaffected)

rpm - the crankshaft rotation rate (in revolutions per minute)

Returns:

the power as a fraction of the maximum (≥0, ≤1)

idleFraction

public float idleFraction()

Determine the idle speed as a fraction of the redline.

Specified by:

idleFraction in interface EngineSpeed

Returns:

the fraction (≥0)

idleRpm

public float idleRpm()

Determine the idle speed of the Engine.

Specified by:

idleRpm in interface EngineSpeed

Returns:

the crankshaft rotation rate (in revolutions per minute, ≥0, ≤redlineRpm)

redlineRpm

public float redlineRpm()

Determine the redline speed of the Engine.

Specified by:

redlineRpm in interface EngineSpeed

Returns:

the crankshaft rotation rate (in revolutions per minute, >0, ≥idleRpm)

rpm

public float rpm()

Determine the current engine speed.

Specified by:

rpm in interface EngineSpeed

Returns:

the crankshaft rotation rate (in revolutions per minute, ≥0)

rpmFraction

public float rpmFraction()

Determine the current engine speed as a fraction of the redline.

Specified by:

rpmFraction in interface EngineSpeed

Returns:

the fraction (≥0, ≤1)