com.jayfella.jme.vehicle.part

Class Gear

java.lang.Object

com.jayfella.jme.vehicle.part.Gear

public class Gear
extends java.lang.Object

A single configuration of a GearBox, including its redline speed and its downshift/upshift speeds in the automatic transmission. Derived from the Gear class in the Advanced Vehicles project.

Constructor Summary

Constructors

Constructor and Description
Gear()

Method Summary

Modifier and Type	Method and Description
float	getMaxKph() Determine the tread speed that triggers an automatic upshift.
float	getMinKph() Determine the tread speed that triggers an automatic downshift.
float	getRedlineKph() Determine the tread speed at the redline.
float	inverseRatio(Vehicle vehicle) Determine the inverse speed ratio, defined as axle (output) angular rate divided by crankshaft (input) angular rate: negative for reverse, 0 for neutral, positive for a forward gear, and >1 for overdrive
boolean	isForward() Test whether this is a forward gear.
boolean	isNeutral() Test whether this is neutral gear.
boolean	isReverse() Test whether this is a reverse gear.
java.lang.String	name() Determine the name of this gear.
void	setMaxKph(float upshiftKph) Alter the tread speed that triggers an automatic upshift.
void	setMinKph(float downshiftKph) Alter the tread speed that triggers an automatic downshift.
void	setMinMaxRedKph(float downshiftKph, float upshiftKph, float redlineKph) Convenience method to configure the speed range and ratio.
Gear	setName(java.lang.String newName) Alter the name of this Gear.
void	setRedlineKph(float redlineKph) Alter the tread speed at the redline.

Methods inherited from class java.lang.Object

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

Constructor Detail

Gear

public Gear()

Method Detail

getMaxKph

public float getMaxKph()

Determine the tread speed that triggers an automatic upshift.

Returns:

the signed speed (in kilometers per hour)

getMinKph

public float getMinKph()

Determine the tread speed that triggers an automatic downshift.

Returns:

the signed speed (in kilometers per hour)

getRedlineKph

public float getRedlineKph()

Determine the tread speed at the redline.

Returns:

the signed speed (in kilometers per hour)

inverseRatio

public float inverseRatio(Vehicle vehicle)

Determine the inverse speed ratio, defined as axle (output) angular rate divided by crankshaft (input) angular rate: negative for reverse, 0 for neutral, positive for a forward gear, and >1 for overdrive

Parameters:

vehicle - the Vehicle containing this Gear (not null, unaffected)

Returns:

the ratio

isForward

public boolean isForward()

Test whether this is a forward gear.

Returns:

true if forward gear, otherwise false

isNeutral

public boolean isNeutral()

Test whether this is neutral gear.

Returns:

true if neutral gear, otherwise false

isReverse

public boolean isReverse()

Test whether this is a reverse gear.

Returns:

true if reverse gear, otherwise false

name

public java.lang.String name()

Determine the name of this gear.

Returns:

the descriptive name (not null, not empty)

setMaxKph

public void setMaxKph(float upshiftKph)

Alter the tread speed that triggers an automatic upshift.

Parameters:

upshiftKph - the desired signed speed (in kilometers per hour)

setMinKph

public void setMinKph(float downshiftKph)

Alter the tread speed that triggers an automatic downshift.

Parameters:

downshiftKph - the desired signed speed (in kilometers per hour)

setName

public Gear setName(java.lang.String newName)

Alter the name of this Gear.

Parameters:

newName - the desired name (not null, not empty)

Returns:

this, for chaining

setMinMaxRedKph

public void setMinMaxRedKph(float downshiftKph,
                            float upshiftKph,
                            float redlineKph)

Convenience method to configure the speed range and ratio.

Parameters:

downshiftKph - the desired signed speed for downshift (in kilometers per hour)

upshiftKph - the desired signed speed for upshift (in kilometers per hour)

redlineKph - the desired signed tread speed at the redline (in kilometers per hour)

setRedlineKph

public void setRedlineKph(float redlineKph)

Alter the tread speed at the redline.

Parameters:

redlineKph - the desired signed speed (in kilometers per hour)