com.jayfella.jme.vehicle.part

Class Wheel

java.lang.Object

com.jayfella.jme.vehicle.part.Wheel

public class Wheel
extends java.lang.Object

A single wheel of a Vehicle, including its suspension and brakes. Derived from the Wheel class in the Advanced Vehicles project.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	logger message logger for this class

Constructor Summary

Constructors

Constructor and Description
Wheel(Vehicle vehicle, int wheelIndex, boolean isSteering, boolean steeringFlipped, Suspension suspension, Brake mainBrake, Brake parkingBrake, float extraDamping) Instantiate a wheel with the specified parameters.

Method Summary

Modifier and Type	Method and Description
float	calculateLateralSlipAngle()
float	calculateLongitudinalSlipAngle()
float	getDiameter()
float	getFriction() Determine the friction between this wheel's tire and the ground.
float	getGrip() Determine the tire's grip.
Brake	getMainBrake() Access the main brake for this wheel.
float	getMaxSteerAngle()
float	getPowerFraction() Determine the fraction of the engine's output power transmitted to this wheel.
float	getRotationDelta()
float	getSteeringAngle()
Suspension	getSuspension()
PacejkaTireModel	getTireModel() Access the tire model.
Vehicle	getVehicle() Access the Vehicle that contains this Wheel.
com.jme3.bullet.objects.VehicleWheel	getVehicleWheel() Access the wheel's physics object.
boolean	isBraking() Test whether this wheel's brakes are applied.
boolean	isPowered() Test whether this wheel receives power from the Engine.
boolean	isSteering() Test whether this wheel is used for steering.
boolean	isSteeringFlipped() Test whether this wheel turns in the opposite direction relative to the Vehicle.
float	linearDamping() Determine how much linear damping this Wheel contributes to its Vehicle.
void	setDiameter(float diameter)
void	setFriction(float friction)
void	setGrip(float grip) Alter the tire's grip.
void	setMaxSteerAngle(float maxSteerAngle)
void	setPowerFraction(float fraction) Alter the fraction of the of the engine's output power that gets transmitted this wheel.
void	setRotationDelta(float rotationDelta)
void	setSteering(boolean steering)
void	setSteering(boolean steering, boolean flipped)
void	setSteeringFlipped(boolean steeringFlipped)
void	setTireModel(PacejkaTireModel tireModel) Alter the tire model.
void	setTireSmokeColor(com.jme3.math.ColorRGBA color) Alter the color of smoke produced by the tire.
float	skidFraction() Determine how much the wheel is skidding.
void	steer(float strength)
com.jme3.math.ColorRGBA	tireSmokeColor(com.jme3.math.ColorRGBA storeResult) Determine the color of smoke produced by the tire.
float	traction() Determine how much traction this wheel has.
void	updateAccelerate(float force) Update the drive force applied via this wheel.
void	updateBrakes(float mainStrength, float parkingStrength) Update the braking impulse applied to this wheel.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final java.util.logging.Logger logger

message logger for this class

Constructor Detail

Wheel

public Wheel(Vehicle vehicle,
             int wheelIndex,
             boolean isSteering,
             boolean steeringFlipped,
             Suspension suspension,
             Brake mainBrake,
             Brake parkingBrake,
             float extraDamping)

Instantiate a wheel with the specified parameters.

Parameters:

vehicle - the vehicle that will contain this Wheel (not null, alias created)

wheelIndex - the index among the vehicle's wheels (≥0)

isSteering - true if used for steering, otherwise false

steeringFlipped - true for rear-wheel steering, otherwise false

suspension - the suspension spring (not null, alias created)

mainBrake - the main brake (not null, alias created)

parkingBrake - the parking brake (not null, alias created)

extraDamping - the additional linear damping (≥0, <1)

Method Detail

calculateLateralSlipAngle

public float calculateLateralSlipAngle()

calculateLongitudinalSlipAngle

public float calculateLongitudinalSlipAngle()

getDiameter

public float getDiameter()

getFriction

public float getFriction()

Determine the friction between this wheel's tire and the ground.

Returns:

the coefficient of friction

getGrip

public float getGrip()

Determine the tire's grip.

Returns:

the fraction of the original grip remaining (≥0, ≤1)

getMainBrake

public Brake getMainBrake()

Access the main brake for this wheel. (The main brakes are typically hydraulic.)

Returns:

the pre-existing instance

getMaxSteerAngle

public float getMaxSteerAngle()

getPowerFraction

public float getPowerFraction()

Determine the fraction of the engine's output power transmitted to this wheel.

Returns:

the power fraction (≥0, ≤1)

getRotationDelta

public float getRotationDelta()

getSteeringAngle

public float getSteeringAngle()

getSuspension

public Suspension getSuspension()

getTireModel

public PacejkaTireModel getTireModel()

Access the tire model.

Returns:

the pre-existing instance

getVehicle

public Vehicle getVehicle()

Access the Vehicle that contains this Wheel.

Returns:

the pre-existing instance (not null)

getVehicleWheel

public com.jme3.bullet.objects.VehicleWheel getVehicleWheel()

Access the wheel's physics object.

Returns:

the pre-existing instance (not null)

isBraking

public boolean isBraking()

Test whether this wheel's brakes are applied.

Returns:

false if the braking impulse is negligible, otherwise true

isPowered

public boolean isPowered()

Test whether this wheel receives power from the Engine.

Returns:

true if receives power, otherwise false

isSteering

public boolean isSteering()

Test whether this wheel is used for steering.

Returns:

true if used for steering, otherwise false

isSteeringFlipped

public boolean isSteeringFlipped()

Test whether this wheel turns in the opposite direction relative to the Vehicle.

Returns:

true if opposite, otherwise false

linearDamping

public float linearDamping()

Determine how much linear damping this Wheel contributes to its Vehicle.

Returns:

(≥0, <1)

setDiameter

public void setDiameter(float diameter)

setFriction

public void setFriction(float friction)

setGrip

public void setGrip(float grip)

Alter the tire's grip.

Parameters:

grip - the fraction of the original grip remaining (≥0, ≤1, default=1)

setMaxSteerAngle

public void setMaxSteerAngle(float maxSteerAngle)

setPowerFraction

public void setPowerFraction(float fraction)

Alter the fraction of the of the engine's output power that gets transmitted this wheel.

Parameters:

fraction - the desired power fraction (≥0, ≤1)

setRotationDelta

public void setRotationDelta(float rotationDelta)

setSteering

public void setSteering(boolean steering)

setSteering

public void setSteering(boolean steering,
                        boolean flipped)

setSteeringFlipped

public void setSteeringFlipped(boolean steeringFlipped)

setTireModel

public void setTireModel(PacejkaTireModel tireModel)

Alter the tire model.

Parameters:

tireModel - the desired model (alias created)

setTireSmokeColor

public void setTireSmokeColor(com.jme3.math.ColorRGBA color)

Alter the color of smoke produced by the tire.

Parameters:

color - the desired color (not null, unaffected)

skidFraction

public float skidFraction()

Determine how much the wheel is skidding.

Returns:

the relative amount of skidding (≥0, ≤1, 0→ unsupported or full traction, 1→complete slippage)

steer

public void steer(float strength)

tireSmokeColor

public com.jme3.math.ColorRGBA tireSmokeColor(com.jme3.math.ColorRGBA storeResult)

Determine the color of smoke produced by the tire.

Parameters:

storeResult - storage for the result (modified if not null)

Returns:

the color (either storeResult or a new instance)

traction

public float traction()

Determine how much traction this wheel has.

Returns:

the relative amount of traction (≥0, ≤1, 0→unsupported or complete slippage, 1→full traction)

updateAccelerate

public void updateAccelerate(float force)

Update the drive force applied via this wheel.

Parameters:

force - the desired drive force (negative if reversing)

updateBrakes

public void updateBrakes(float mainStrength,
                         float parkingStrength)

Update the braking impulse applied to this wheel.

Parameters:

mainStrength - the strength of the main-brake control signal (≥0, ≤1)

parkingStrength - the strength of the parking-brake control signal (≥0, ≤1)