Torque3D Documentation / _generateds / WheeledVehicle

WheeledVehicle

Engine/source/T3D/vehicles/wheeledVehicle.h

More...

Classes:

class
WheeledVehicle::Wheel

Private Types

enum
MaskBits {
  WheelMask = Parent::NextFreeMask << 0
  NextFreeMask = Parent::NextFreeMask << 1
}

Vehicle

Parent

Private Attributes

bool

mBraking 

WheeledVehicleData *

mDataBlock 

SFXSource *

mEngineSound 

SFXSource *

mJetSound 

SFXSource *

mSquealSound 

TSThread *

mSteeringThread 

TSThread *

mTailLightThread 

Wheel

mWheel [WheeledVehicleData::MaxWheels]

Private Functions

void

extendWheels(bool clientHack)

Extend the wheels The wheels are extended until they contact a surface.

U32

getCollisionMask()

bool

onNewDataBlock(GameBaseData * dptr, bool reload)

Called when a new datablock is set.

void

prepBatchRender(SceneRenderState * state, S32 mountedImageIndex)

Used from ShapeBase::_prepRenderImage() to submit render instances for the main shape or its mounted elements.

void

processTick(const Move * move)

Processes a move event and updates object state once every 32 milliseconds.

void

updateEngineSound(F32 level)

Update engine sound This method is only invoked by clients.

void

updateForces(F32 dt)

Update the rigid body forces on the vehicle This method calculates the forces acting on the body, including gravity, suspension & tire forces.

void

updateJetSound()

Update jet sound This method is only invoked by clients.

void

updateMove(const Move * move)

void

updateSquealSound(F32 level)

Update wheel skid sound This method is only invoked by clients.

void

updateWheelParticles(F32 dt)

Update wheel particles effects These animations are purely cosmetic and this method is only invoked on the client.

void

updateWheelThreads()

Update wheel steering and suspension threads.

Public Functions

WheeledVehicle()

~WheeledVehicle()

void

advanceTime(F32 dt)

Interpolates between move ticks.
bool

buildPolyList(PolyListContext context, AbstractPolyList * polyList, const Box3F & box, const SphereF & sphere)

Build a collision polylist The polylist is filled with polygons representing the collision volume and the wheels.
DECLARE_CONOBJECT(WheeledVehicle )

Wheel *

getWheel(U32 index)

S32

getWheelCount()

void

getWheelInstAndTransform(U32 wheel, TSShapeInstance ** inst, MatrixF * xfrm)

bool

onAdd()

Called when the object is added to the sim.
void

onRemove()

Called when the object is removed from the sim.
U32

packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

Instructs this object to pack its state for transfer over the network.
void

readPacketData(GameConnection * conn, BitStream * stream)

Read data written with writePacketData() and update the object state.
void

setWheelPowered(S32 wheel, bool powered)

void

setWheelSpring(S32 wheel, WheeledVehicleSpring * )

void

setWheelSteering(S32 wheel, F32 steering)

void

setWheelTire(S32 wheel, WheeledVehicleTire * )

void

unpackUpdate(NetConnection * conn, BitStream * stream)

Instructs this object to read state data previously packed with packUpdate.
void

writePacketData(GameConnection * conn, BitStream * stream)

Write state information necessary to perform client side prediction of an object.
Public Static Functions
void

initPersistFields()

Detailed Description
Private Types
MaskBits

Enumerator
WheelMask = Parent::NextFreeMask << 0
NextFreeMask = Parent::NextFreeMask << 1
typedef Vehicle Parent 

Private Attributes
bool mBraking 

WheeledVehicleData * mDataBlock 

SFXSource * mEngineSound 

SFXSource * mJetSound 

SFXSource * mSquealSound 

TSThread * mSteeringThread 

TSThread * mTailLightThread 

Wheel mWheel [WheeledVehicleData::MaxWheels]

Private Functions
extendWheels(bool clientHack)

Extend the wheels The wheels are extended until they contact a surface.
The extension is instantaneous. The wheels are extended before force calculations and also on during client side interpolation (so that the wheels are glued to the ground).
getCollisionMask()

Reimplemented from: Vehicle
onNewDataBlock(GameBaseData * dptr, bool reload)

Reimplemented from: Vehicle
prepBatchRender(SceneRenderState * state, S32 mountedImageIndex)

Reimplemented from: Vehicle
processTick(const Move * move)

Reimplemented from: Vehicle
updateEngineSound(F32 level)

Update engine sound This method is only invoked by clients.
updateForces(F32 dt)

Reimplemented from: Vehicle
updateJetSound()

Update jet sound This method is only invoked by clients.
updateMove(const Move * move)

Reimplemented from: Vehicle
updateSquealSound(F32 level)

Update wheel skid sound This method is only invoked by clients.
updateWheelParticles(F32 dt)

Update wheel particles effects These animations are purely cosmetic and this method is only invoked on the client.
Particles are emitted as long as the moving.
updateWheelThreads()

Update wheel steering and suspension threads.
These animations are purely cosmetic and this method is only invoked on the client.
Public Functions
WheeledVehicle()

~WheeledVehicle()

advanceTime(F32 dt)

Reimplemented from: Vehicle
buildPolyList(PolyListContext context, AbstractPolyList * polyList, const Box3F & box, const SphereF & sphere)

Reimplemented from: ShapeBase
DECLARE_CONOBJECT(WheeledVehicle )

getWheel(U32 index)

getWheelCount()

getWheelInstAndTransform(U32 wheel, TSShapeInstance ** inst, MatrixF * xfrm)

onAdd()

Reimplemented from: Vehicle
onRemove()

Reimplemented from: Vehicle
packUpdate(NetConnection * conn, U32 mask, BitStream * stream)

Reimplemented from: Vehicle
readPacketData(GameConnection * conn, BitStream * stream)

Reimplemented from: Vehicle
setWheelPowered(S32 wheel, bool powered)

setWheelSpring(S32 wheel, WheeledVehicleSpring * )

setWheelSteering(S32 wheel, F32 steering)

setWheelTire(S32 wheel, WheeledVehicleTire * )

unpackUpdate(NetConnection * conn, BitStream * stream)

Reimplemented from: Vehicle
writePacketData(GameConnection * conn, BitStream * stream)

Reimplemented from: Vehicle
Public Static Functions
initPersistFields()