Vehicle (MavLibrary API)

java.lang.Object
- com.jayfella.jme.vehicle.Vehicle

All Implemented Interfaces:

HasNode, VehicleSpeed, VehicleSteering, com.jme3.bullet.PhysicsTickListener, jme3utilities.Loadable
```
public abstract class Vehicle
extends java.lang.Object
implements HasNode, jme3utilities.Loadable, com.jme3.bullet.PhysicsTickListener, VehicleSpeed, VehicleSteering
```
A vehicle based on Bullet's btRaycastVehicle, with a single Engine and a single GearBox. Derived from the Car and Vehicle classes in the Advanced Vehicles project.

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`KPH_TO_MPH` factor to convert km/hr to miles per hour
`static float`	`KPH_TO_WUPS` factor to convert km/hr to wu/sec
`static java.util.logging.Logger`	`logger` message logger for this class

Constructor Summary

Constructors
Constructor and Description

Vehicle(java.lang.String name)
Instantiate a Vehicle with the specified name.

Constructors
Constructor and Description
`Vehicle(java.lang.String name)` Instantiate a Vehicle with the specified name.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`accelerateSignal()` Evaluate the "accelerate" control signal.
`void`	`addToWorld(VehicleWorld world, GlobalAudio globalAudio)` Add this Vehicle to the specified world.
`Wheel`	`addWheel(WheelModel wheelModel, com.jme3.math.Vector3f connectionLocation, boolean isSteering, boolean isSteeringFlipped, float mainBrakePeakForce, float parkingBrakePeakForce, float extraDamping)` Add a single Wheel to this Vehicle.
`protected void`	`build()` Should be invoked last, after all parts have been configured and added.
`float`	`chassisDamping()` Determine the linear damping due to air resistance.
`int`	`countWheels()` Count how many wheels this Vehicle has.
`float`	`driveWheelCircumference()` Determine the circumference of the first drive wheel.
`com.jme3.math.Vector3f`	`forwardDirection(com.jme3.math.Vector3f storeResult)` Determine the forward direction.
`float`	`forwardSpeed(SpeedUnit speedUnit)` Determine the forward component of the vehicle's inertial velocity.
`com.jme3.scene.Spatial`	`getChassis()` Access the computer-graphics (C-G) model for visualization.
`Engine`	`getEngine()` Access the Engine.
`GearBox`	`getGearBox()` Access the GearBox.
`Sound`	`getHornSound()` Access the horn sound.
`java.lang.String`	`getName()` Determine this vehicle's name.
`com.jme3.scene.Node`	`getNode()` Access the scene-graph subtree that represents this Vehicle.
`SpeedUnit`	`getSpeedometerUnits()` Determine which units to use in the speedometer.
`com.jme3.bullet.control.VehicleControl`	`getVehicleControl()` Access the PhysicsControl.
`Wheel`	`getWheel(int index)` Access the indexed Wheel.
`VehicleWorld`	`getWorld()` Access the world that contains this Vehicle.
`boolean`	`isBurningRubber()` Test whether the tires are forced to emit smoke.
`boolean`	`isHornRequested()` Test whether the driver is sounding the horn.
`Wheel[]`	`listWheels()` Enumerate all wheels.
`void`	`load(com.jme3.asset.AssetManager assetManager)` Load the assets of this Vehicle.
`abstract void`	`locateDashCam(com.jme3.math.Vector3f storeResult)` Determine the offset of the vehicle's DashCamera in scaled shape coordinates.
`com.jme3.math.Vector3f`	`locateTarget(float bias, com.jme3.math.Vector3f storeResult)` Determine the location of the ChaseCamera target.
`protected abstract void`	`locateTarget(com.jme3.math.Vector3f storeResult)` Determine the offset of the vehicle's ChaseCamera target in scaled shape coordinates.
`float`	`maxForwardSpeed(SpeedUnit speedUnit)` Estimate the vehicle's maximum forward speed.
`float`	`maxReverseSpeed(SpeedUnit speedUnit)` Estimate the vehicle's maximum reverse speed.
`void`	`physicsTick(com.jme3.bullet.PhysicsSpace space, float timeStep)` Callback from Bullet, invoked just after the physics has been stepped.
`void`	`prePhysicsTick(com.jme3.bullet.PhysicsSpace space, float timeStep)` Callback from Bullet, invoked just before the physics is stepped.
`void`	`removeFromWorld()` Remove this Vehicle from the world to which it was added.
`void`	`setAccelerateSignal(float strength)` Alter the "accelerate" control signal.
`void`	`setBrakeSignals(float mainStrength, float parkingStrength)` Alter the values of the brake control signals.
`void`	`setBurningRubber(boolean setting)` Alter whether the tires are forced to emit smoke.
`protected void`	`setChassis(com.jme3.scene.Spatial cgmRoot, com.jme3.bullet.collision.shapes.CollisionShape shape, float mass, float damping)` Configure the "chassis".
`protected void`	`setChassis(java.lang.String folderName, java.lang.String cgmBaseFileName, com.jme3.asset.AssetManager assetManager, float mass, float damping)` Configure a "chassis" that's loaded from J3O assets in the usual folders.
`protected void`	`setEngine(Engine desiredEngine)` Alter the vehicle's Engine.
`protected void`	`setGearBox(GearBox gearBox)` Alter the vehicle's GearBox.
`protected void`	`setHornSound(Sound sound)` Alter the horn sound.
`void`	`setHornStatus(boolean isRequested)` Update the status of the horn.
`void`	`setSpeedometerUnits(SpeedUnit units)` Alter which units to use in the speedometer.
`void`	`setTireSkidMarksEnabled(boolean enabled)`
`void`	`setTireSkidMarksVisible(boolean enabled)`
`void`	`setTireSmokeEnabled(boolean enabled)`
`void`	`setWheelModel(int wheelIndex, java.lang.Class<? extends WheelModel> modelClass)` Replace the WheelModel of the indexed wheel with a new instance of the specified class.
`void`	`startEngine()`
`void`	`steer(float wheelAngle)`
`float`	`steeringWheelAngle()` Determine the rotation angle of the steering wheel, handlebars, or tiller.
`void`	`stopEngine()`
`void`	`warpToStart()` Warp this vehicle to a suitable start position.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KPH_TO_MPH
```
public static final float KPH_TO_MPH
```
    factor to convert km/hr to miles per hour
    
    See Also:
    
    Constant Field Values
  - KPH_TO_WUPS
```
public static final float KPH_TO_WUPS
```
    factor to convert km/hr to wu/sec
    
    See Also:
    
    Constant Field Values
  - logger
```
public static final java.util.logging.Logger logger
```
    message logger for this class
- Constructor Detail
  - Vehicle
```
public Vehicle(java.lang.String name)
```
    Instantiate a Vehicle with the specified name.
    
    Parameters:
    
    name - the desired name (not null)
- Method Detail
  - accelerateSignal
```
public float accelerateSignal()
```
    Evaluate the "accelerate" control signal.
    
    Returns:
    
    a signal strength, between 0 (coasting) and 1 (full throttle)
  - addToWorld
```
public void addToWorld(VehicleWorld world,
                       GlobalAudio globalAudio)
```
    Add this Vehicle to the specified world.
    
    Parameters:
    
    world - where to attach (not null, alias created)
    
    globalAudio - the global audio controls (not null, alias created)
  - addWheel
```
public Wheel addWheel(WheelModel wheelModel,
                      com.jme3.math.Vector3f connectionLocation,
                      boolean isSteering,
                      boolean isSteeringFlipped,
                      float mainBrakePeakForce,
                      float parkingBrakePeakForce,
                      float extraDamping)
```
    Add a single Wheel to this Vehicle.
    
    Parameters:
    
    wheelModel - the desired WheelModel (not null)
    
    connectionLocation - the location where the suspension connects to the chassis (in chassis coordinates, not null, unaffected)
    
    isSteering - true if used for steering, otherwise false
    
    isSteeringFlipped - true for rear-wheel steering, otherwise false
    
    mainBrakePeakForce - (in Newtons, ≥0)
    
    parkingBrakePeakForce - (in Newtons, ≥0)
    
    extraDamping - (≥0, <1)
    
    Returns:
    
    the new Wheel
  - chassisDamping
```
public float chassisDamping()
```
    Determine the linear damping due to air resistance.
    
    Returns:
    
    a fraction (≥0, <1)
  - countWheels
```
public int countWheels()
```
    Count how many wheels this Vehicle has.
    
    Returns:
    
    the count (≥0)
  - driveWheelCircumference
```
public float driveWheelCircumference()
```
    Determine the circumference of the first drive wheel. (It's assumed they're all the same size.) Used to convert between axle angular speed and tread speed.
    
    Returns:
    
    the circumference (in world units, >0)
  - forwardDirection
```
public com.jme3.math.Vector3f forwardDirection(com.jme3.math.Vector3f storeResult)
```
    Determine the forward direction.
    
    Parameters:
    
    storeResult - storage for the result (modified if not null)
    
    Returns:
    
    a unit vector in physics-space coordinates (either storeResult or a new instance)
  - getChassis
```
public com.jme3.scene.Spatial getChassis()
```
    Access the computer-graphics (C-G) model for visualization.
    
    Returns:
    
    the pre-existing instance
  - getEngine
```
public Engine getEngine()
```
    Access the Engine.
    
    Returns:
    
    the pre-existing instance
  - getGearBox
```
public GearBox getGearBox()
```
    Access the GearBox.
    
    Returns:
    
    the pre-existing instance
  - getHornSound
```
public Sound getHornSound()
```
    Access the horn sound.
    
    Returns:
    
    the pre-existing instance, or null for silence
  - getName
```
public java.lang.String getName()
```
    Determine this vehicle's name.
    
    Returns:
    
    the descriptive name (not null)
  - getSpeedometerUnits
```
public SpeedUnit getSpeedometerUnits()
```
    Determine which units to use in the speedometer.
    
    Returns:
    
    an enum value, or null for no speedometer
  - getVehicleControl
```
public com.jme3.bullet.control.VehicleControl getVehicleControl()
```
    Access the PhysicsControl.
    
    Returns:
    
    the pre-existing instance
  - getWheel
```
public Wheel getWheel(int index)
```
    Access the indexed Wheel.
    
    Parameters:
    
    index - which Wheel to access (≥0)
    
    Returns:
    
    the pre-existing instance
  - getWorld
```
public VehicleWorld getWorld()
```
    Access the world that contains this Vehicle.
    
    Returns:
    
    the pre-existing instance, or null if none
  - isBurningRubber
```
public boolean isBurningRubber()
```
    Test whether the tires are forced to emit smoke.
    
    Returns:
    
    true if forced, otherwise false
  - isHornRequested
```
public boolean isHornRequested()
```
    Test whether the driver is sounding the horn.
    
    Returns:
    
    true if sounding, otherwise false
  - listWheels
```
public Wheel[] listWheels()
```
    Enumerate all wheels.
    
    Returns:
    
    a new array (not null)
  - locateDashCam
```
public abstract void locateDashCam(com.jme3.math.Vector3f storeResult)
```
    Determine the offset of the vehicle's DashCamera in scaled shape coordinates.
    
    Parameters:
    
    storeResult - storage for the result (not null)
  - locateTarget
```
public com.jme3.math.Vector3f locateTarget(float bias,
                                           com.jme3.math.Vector3f storeResult)
```
    Determine the location of the ChaseCamera target.
    
    Parameters:
    
    bias - how much to displace the target toward the rear (0=center of mass, 1=back bumper)
    
    storeResult - storage for the result (modified if not null)
    
    Returns:
    
    a location vector (in physics-space coordinates, either storeResult or a new instance)
  - removeFromWorld
```
public void removeFromWorld()
```
    Remove this Vehicle from the world to which it was added.
  - setAccelerateSignal
```
public void setAccelerateSignal(float strength)
```
    Alter the "accelerate" control signal.
    
    Parameters:
    
    strength - the desired strength of the "accelerate" control signal: between 0 (coasting) and 1 (full throttle)
  - setBrakeSignals
```
public void setBrakeSignals(float mainStrength,
                            float parkingStrength)
```
    Alter the values of the brake control signals.
    
    Parameters:
    
    mainStrength - the desired strength of the main-brake control signal, between 0 (not applied) and 1 (applied as strongly as possible)
    
    parkingStrength - the desired strength of the parking-brake control signal, between 0 (not applied) and 1 (applied as strongly as possible)
  - setBurningRubber
```
public void setBurningRubber(boolean setting)
```
    Alter whether the tires are forced to emit smoke.
    
    Parameters:
    
    setting - true→forced, false→not forced
  - setHornStatus
```
public void setHornStatus(boolean isRequested)
```
    Update the status of the horn.
    
    Parameters:
    
    isRequested - true → requested, false → not requested
  - setSpeedometerUnits
```
public void setSpeedometerUnits(SpeedUnit units)
```
    Alter which units to use in the speedometer.
    
    Parameters:
    
    units - an enum value, or null for no speedometer
  - setTireSkidMarksEnabled
```
public void setTireSkidMarksEnabled(boolean enabled)
```
  - setTireSkidMarksVisible
```
public void setTireSkidMarksVisible(boolean enabled)
```
  - setTireSmokeEnabled
```
public void setTireSmokeEnabled(boolean enabled)
```
  - setWheelModel
```
public void setWheelModel(int wheelIndex,
                          java.lang.Class<? extends WheelModel> modelClass)
```
    Replace the WheelModel of the indexed wheel with a new instance of the specified class.
    
    Parameters:
    
    wheelIndex - which wheel to replace (≥0, <numWheels-1)
    
    modelClass - the desired type of wheel (not null)
  - startEngine
```
public void startEngine()
```
  - steer
```
public void steer(float wheelAngle)
```
  - stopEngine
```
public void stopEngine()
```
  - warpToStart
```
public void warpToStart()
```
    Warp this vehicle to a suitable start position.
  - build
```
protected void build()
```
    Should be invoked last, after all parts have been configured and added.
  - locateTarget
```
protected abstract void locateTarget(com.jme3.math.Vector3f storeResult)
```
    Determine the offset of the vehicle's ChaseCamera target in scaled shape coordinates.
    
    Parameters:
    
    storeResult - storage for the result (not null)
  - setChassis
```
protected void setChassis(java.lang.String folderName,
                          java.lang.String cgmBaseFileName,
                          com.jme3.asset.AssetManager assetManager,
                          float mass,
                          float damping)
```
    Configure a "chassis" that's loaded from J3O assets in the usual folders. (Bullet refers to everything except the wheels as the "chassis".)
    
    Parameters:
    
    folderName - the name of the folder containing the C-G model asset (not null, not empty)
    
    cgmBaseFileName - the base filename of the C-G model asset (not null, not empty)
    
    assetManager - to load assets (not null)
    
    mass - the mass of the chassis (in kilos, >0)
    
    damping - the drag on the chassis due to air resistance (≥0, <1)
  - setChassis
```
protected void setChassis(com.jme3.scene.Spatial cgmRoot,
                          com.jme3.bullet.collision.shapes.CollisionShape shape,
                          float mass,
                          float damping)
```
    Configure the "chassis". (Bullet refers to everything except the wheels as the "chassis".)
    
    Parameters:
    
    cgmRoot - the root of the C-G model to visualize the chassis (not null, alias created)
    
    shape - the shape for the chassis (not null, alias created)
    
    mass - the mass of the chassis (in kilos, >0)
    
    damping - the drag on the chassis due to air resistance (≥0, <1)
  - setEngine
```
protected void setEngine(Engine desiredEngine)
```
    Alter the vehicle's Engine.
    
    Parameters:
    
    desiredEngine - the desired Engine (not null)
  - setGearBox
```
protected void setGearBox(GearBox gearBox)
```
    Alter the vehicle's GearBox.
    
    Parameters:
    
    gearBox - the desired GearBox
  - setHornSound
```
protected void setHornSound(Sound sound)
```
    Alter the horn sound.
    
    Parameters:
    
    sound - the desired Sound (loaded), or null for silence
  - getNode
```
public com.jme3.scene.Node getNode()
```
    Access the scene-graph subtree that represents this Vehicle.
    
    Specified by:
    
    getNode in interface HasNode
    
    Returns:
    
    the pre-existing instance (not null)
  - load
```
public void load(com.jme3.asset.AssetManager assetManager)
```
    Load the assets of this Vehicle.
    
    Specified by:
    
    load in interface jme3utilities.Loadable
    
    Parameters:
    
    assetManager - for loading assets (not null)
  - physicsTick
```
public void physicsTick(com.jme3.bullet.PhysicsSpace space,
                        float timeStep)
```
    Callback from Bullet, invoked just after the physics has been stepped.
    
    Specified by:
    
    physicsTick in interface com.jme3.bullet.PhysicsTickListener
    
    Parameters:
    
    space - the space that was just stepped (not null)
    
    timeStep - the time per physics step (in seconds, ≥0)
  - prePhysicsTick
```
public void prePhysicsTick(com.jme3.bullet.PhysicsSpace space,
                           float timeStep)
```
    Callback from Bullet, invoked just before the physics is stepped.
    
    Specified by:
    
    prePhysicsTick in interface com.jme3.bullet.PhysicsTickListener
    
    Parameters:
    
    space - the space that is about to be stepped (not null)
    
    timeStep - the time per physics step (in seconds, ≥0)
  - forwardSpeed
```
public float forwardSpeed(SpeedUnit speedUnit)
```
    Determine the forward component of the vehicle's inertial velocity.
    
    Specified by:
    
    forwardSpeed in interface VehicleSpeed
    
    Parameters:
    
    speedUnit - the unit of measurement to use (not null)
    
    Returns:
    
    the speed (in the specified units, may be negative)
  - maxForwardSpeed
```
public float maxForwardSpeed(SpeedUnit speedUnit)
```
    Estimate the vehicle's maximum forward speed.
    
    Specified by:
    
    maxForwardSpeed in interface VehicleSpeed
    
    Parameters:
    
    speedUnit - the unit of measurement to use (not null)
    
    Returns:
    
    the speed (in the specified units, ≥0)
  - maxReverseSpeed
```
public float maxReverseSpeed(SpeedUnit speedUnit)
```
    Estimate the vehicle's maximum reverse speed.
    
    Specified by:
    
    maxReverseSpeed in interface VehicleSpeed
    
    Parameters:
    
    speedUnit - the unit of measurement to use (not null)
    
    Returns:
    
    the speed (in the specified units, ≤0)
  - steeringWheelAngle
```
public float steeringWheelAngle()
```
    Determine the rotation angle of the steering wheel, handlebars, or tiller.
    
    Specified by:
    
    steeringWheelAngle in interface VehicleSteering
    
    Returns:
    
    the angle (in radians, negative = left, 0 = neutral, positive = right)

Class Vehicle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KPH_TO_MPH

KPH_TO_WUPS

logger

Constructor Detail

Vehicle

Method Detail

accelerateSignal

addToWorld

addWheel

chassisDamping

countWheels

driveWheelCircumference

forwardDirection

getChassis

getEngine

getGearBox

getHornSound

getName

getSpeedometerUnits

getVehicleControl

getWheel

getWorld

isBurningRubber

isHornRequested

listWheels

locateDashCam

locateTarget

removeFromWorld

setAccelerateSignal

setBrakeSignals

setBurningRubber

setHornStatus

setSpeedometerUnits

setTireSkidMarksEnabled

setTireSkidMarksVisible

setTireSmokeEnabled

setWheelModel

startEngine

steer

stopEngine

warpToStart

build

locateTarget

setChassis

setChassis

setEngine

setGearBox

setHornSound

getNode

load

physicsTick

prePhysicsTick

forwardSpeed

maxForwardSpeed

maxReverseSpeed

steeringWheelAngle