Runtime controller class for vehicle with tank tracks. More...

#include <TrackedVehicleController.h>

Inheritance diagram for TrackedVehicleController:

Public Member Functions
JPH_OVERRIDE_NEW_DELETE	TrackedVehicleController (const TrackedVehicleControllerSettings &inSettings, VehicleConstraint &inConstraint)
	Constructor.

void	SetDriverInput (float inForward, float inLeftRatio, float inRightRatio, float inBrake)

void	SetForwardInput (float inForward)
	Value between -1 and 1 for auto transmission and value between 0 and 1 indicating desired driving direction and amount the gas pedal is pressed.

float	GetForwardInput () const

void	SetLeftRatio (float inLeftRatio)
	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the left track (used for steering)

float	GetLeftRatio () const

void	SetRightRatio (float inRightRatio)
	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the right track (used for steering)

float	GetRightRatio () const

void	SetBrakeInput (float inBrake)
	Value between 0 and 1 indicating how strong the brake pedal is pressed.

float	GetBrakeInput () const

const VehicleEngine &	GetEngine () const
	Get current engine state.

VehicleEngine &	GetEngine ()
	Get current engine state (writable interface, allows you to make changes to the configuration which will take effect the next time step)

const VehicleTransmission &	GetTransmission () const
	Get current transmission state.

VehicleTransmission &	GetTransmission ()
	Get current transmission state (writable interface, allows you to make changes to the configuration which will take effect the next time step)

const VehicleTracks &	GetTracks () const
	Get the tracks this vehicle has.

VehicleTracks &	GetTracks ()
	Get the tracks this vehicle has (writable interface, allows you to make changes to the configuration which will take effect the next time step)

void	SetRPMMeter (Vec3Arg inPosition, float inSize)
	Debug drawing of RPM meter.

Public Member Functions inherited from VehicleController
JPH_OVERRIDE_NEW_DELETE	VehicleController (VehicleConstraint &inConstraint)
	Constructor / destructor.

virtual	~VehicleController ()=default

Public Member Functions inherited from RefTarget< VehicleController >
	RefTarget ()=default
	Constructor.

	RefTarget (const RefTarget &)

	~RefTarget ()
	assert no one is referencing us

void	SetEmbedded () const

RefTarget &	operator= (const RefTarget &)
	Assignment operator.

uint32	GetRefCount () const
	Get current refcount of this object.

void	AddRef () const
	Add or release a reference to this object.

void	Release () const

Public Member Functions inherited from NonCopyable
	NonCopyable ()=default

	NonCopyable (const NonCopyable &)=delete

void	operator= (const NonCopyable &)=delete

Protected Member Functions
void	SyncLeftRightTracks ()
	Synchronize angular velocities of left and right tracks according to their ratios.

virtual Wheel *	ConstructWheel (const WheelSettings &inWheel) const override

virtual bool	AllowSleep () const override

virtual void	PreCollide (float inDeltaTime, PhysicsSystem &inPhysicsSystem) override

virtual void	PostCollide (float inDeltaTime, PhysicsSystem &inPhysicsSystem) override

virtual bool	SolveLongitudinalAndLateralConstraints (float inDeltaTime) override

virtual void	SaveState (StateRecorder &inStream) const override

virtual void	RestoreState (StateRecorder &inStream) override

virtual void	Draw (DebugRenderer *inRenderer) const override

Protected Attributes
float	mForwardInput = 0.0f
	Value between -1 and 1 for auto transmission and value between 0 and 1 indicating desired driving direction and amount the gas pedal is pressed.

float	mLeftRatio = 1.0f
	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the left track (used for steering)

float	mRightRatio = 1.0f
	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the right track (used for steering)

float	mBrakeInput = 0.0f
	Value between 0 and 1 indicating how strong the brake pedal is pressed.

VehicleEngine	mEngine
	Engine state of the vehicle.

VehicleTransmission	mTransmission
	Transmission state of the vehicle.

VehicleTracks	mTracks
	Tracks of the vehicle.

Vec3	mRPMMeterPosition { 0, 1, 0 }
	Position (in local space of the body) of the RPM meter when drawing the constraint.

float	mRPMMeterSize = 0.5f
	Size of the RPM meter when drawing the constraint.

Protected Attributes inherited from VehicleController
VehicleConstraint &	mConstraint
	The vehicle constraint we belong to.

Protected Attributes inherited from RefTarget< VehicleController >
atomic< uint32 >	mRefCount
	Current reference count.

Additional Inherited Members
Static Public Member Functions inherited from RefTarget< VehicleController >
static int	sInternalGetRefCountOffset ()
	INTERNAL HELPER FUNCTION USED BY SERIALIZATION.

Static Protected Attributes inherited from RefTarget< VehicleController >
static constexpr uint32	cEmbedded
	A large value that gets added to the refcount to mark the object as embedded.

Detailed Description

Runtime controller class for vehicle with tank tracks.

Constructor & Destructor Documentation

◆ TrackedVehicleController()

TrackedVehicleController::TrackedVehicleController	(	const TrackedVehicleControllerSettings &	inSettings,
		VehicleConstraint &	inConstraint
	)

Constructor.

Member Function Documentation

◆ AllowSleep()

bool TrackedVehicleController::AllowSleep ( ) const

overrideprotectedvirtual

Implements VehicleController.

◆ ConstructWheel()

virtual Wheel * TrackedVehicleController::ConstructWheel ( const WheelSettings & inWheel ) const

inlineoverrideprotectedvirtual

Implements VehicleController.

◆ Draw()

void TrackedVehicleController::Draw ( DebugRenderer * inRenderer ) const

overrideprotectedvirtual

Implements VehicleController.

◆ GetBrakeInput()

float TrackedVehicleController::GetBrakeInput ( ) const

inline

◆ GetEngine() [1/2]

VehicleEngine & TrackedVehicleController::GetEngine ( )

inline

Get current engine state (writable interface, allows you to make changes to the configuration which will take effect the next time step)

◆ GetEngine() [2/2]

const VehicleEngine & TrackedVehicleController::GetEngine ( ) const

inline

Get current engine state.

◆ GetForwardInput()

float TrackedVehicleController::GetForwardInput ( ) const

inline

◆ GetLeftRatio()

float TrackedVehicleController::GetLeftRatio ( ) const

inline

◆ GetRightRatio()

float TrackedVehicleController::GetRightRatio ( ) const

inline

◆ GetTracks() [1/2]

VehicleTracks & TrackedVehicleController::GetTracks ( )

inline

Get the tracks this vehicle has (writable interface, allows you to make changes to the configuration which will take effect the next time step)

◆ GetTracks() [2/2]

const VehicleTracks & TrackedVehicleController::GetTracks ( ) const

inline

Get the tracks this vehicle has.

◆ GetTransmission() [1/2]

VehicleTransmission & TrackedVehicleController::GetTransmission ( )

inline

Get current transmission state (writable interface, allows you to make changes to the configuration which will take effect the next time step)

◆ GetTransmission() [2/2]

const VehicleTransmission & TrackedVehicleController::GetTransmission ( ) const

inline

Get current transmission state.

◆ PostCollide()

void TrackedVehicleController::PostCollide	(	float	inDeltaTime,
		PhysicsSystem &	inPhysicsSystem
	)

overrideprotectedvirtual

Implements VehicleController.

◆ PreCollide()

void TrackedVehicleController::PreCollide	(	float	inDeltaTime,
		PhysicsSystem &	inPhysicsSystem
	)

overrideprotectedvirtual

Implements VehicleController.

◆ RestoreState()

void TrackedVehicleController::RestoreState ( StateRecorder & inStream )

overrideprotectedvirtual

Implements VehicleController.

◆ SaveState()

void TrackedVehicleController::SaveState ( StateRecorder & inStream ) const

overrideprotectedvirtual

Implements VehicleController.

◆ SetBrakeInput()

void TrackedVehicleController::SetBrakeInput ( float inBrake )

inline

Value between 0 and 1 indicating how strong the brake pedal is pressed.

◆ SetDriverInput()

void TrackedVehicleController::SetDriverInput	(	float	inForward,
		float	inLeftRatio,
		float	inRightRatio,
		float	inBrake
	)

inline

Set input from driver

Parameters

inForward	Value between -1 and 1 for auto transmission and value between 0 and 1 indicating desired driving direction and amount the gas pedal is pressed
inLeftRatio	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the left track (used for steering)
inRightRatio	Value between -1 and 1 indicating an extra multiplier to the rotation rate of the right track (used for steering)
inBrake	Value between 0 and 1 indicating how strong the brake pedal is pressed

◆ SetForwardInput()

void TrackedVehicleController::SetForwardInput ( float inForward )

inline

Value between -1 and 1 for auto transmission and value between 0 and 1 indicating desired driving direction and amount the gas pedal is pressed.

◆ SetLeftRatio()

void TrackedVehicleController::SetLeftRatio ( float inLeftRatio )

inline

Value between -1 and 1 indicating an extra multiplier to the rotation rate of the left track (used for steering)

◆ SetRightRatio()

void TrackedVehicleController::SetRightRatio ( float inRightRatio )

inline

Value between -1 and 1 indicating an extra multiplier to the rotation rate of the right track (used for steering)

◆ SetRPMMeter()

void TrackedVehicleController::SetRPMMeter	(	Vec3Arg	inPosition,
		float	inSize
	)

inline

Debug drawing of RPM meter.

◆ SolveLongitudinalAndLateralConstraints()

bool TrackedVehicleController::SolveLongitudinalAndLateralConstraints ( float inDeltaTime )

overrideprotectedvirtual

Implements VehicleController.

◆ SyncLeftRightTracks()

void TrackedVehicleController::SyncLeftRightTracks ( )

protected

Synchronize angular velocities of left and right tracks according to their ratios.

Member Data Documentation

◆ mBrakeInput

float TrackedVehicleController::mBrakeInput = 0.0f

protected

Value between 0 and 1 indicating how strong the brake pedal is pressed.

◆ mEngine

VehicleEngine TrackedVehicleController::mEngine

protected

Engine state of the vehicle.

◆ mForwardInput

float TrackedVehicleController::mForwardInput = 0.0f

protected

Value between -1 and 1 for auto transmission and value between 0 and 1 indicating desired driving direction and amount the gas pedal is pressed.

◆ mLeftRatio

float TrackedVehicleController::mLeftRatio = 1.0f

protected

Value between -1 and 1 indicating an extra multiplier to the rotation rate of the left track (used for steering)

◆ mRightRatio

float TrackedVehicleController::mRightRatio = 1.0f

protected

Value between -1 and 1 indicating an extra multiplier to the rotation rate of the right track (used for steering)

◆ mRPMMeterPosition

Vec3 TrackedVehicleController::mRPMMeterPosition { 0, 1, 0 }

protected

Position (in local space of the body) of the RPM meter when drawing the constraint.

◆ mRPMMeterSize

float TrackedVehicleController::mRPMMeterSize = 0.5f

protected

Size of the RPM meter when drawing the constraint.

◆ mTracks

VehicleTracks TrackedVehicleController::mTracks

protected

Tracks of the vehicle.

◆ mTransmission

VehicleTransmission TrackedVehicleController::mTransmission

protected

Transmission state of the vehicle.

The documentation for this class was generated from the following files:

Jolt/Physics/Vehicle/TrackedVehicleController.h
Jolt/Physics/Vehicle/TrackedVehicleController.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrackedVehicleController()

Member Function Documentation

◆ AllowSleep()

◆ ConstructWheel()

◆ Draw()

◆ GetBrakeInput()

◆ GetEngine() [1/2]

◆ GetEngine() [2/2]

◆ GetForwardInput()

◆ GetLeftRatio()

◆ GetRightRatio()

◆ GetTracks() [1/2]

◆ GetTracks() [2/2]

◆ GetTransmission() [1/2]

◆ GetTransmission() [2/2]

◆ PostCollide()

◆ PreCollide()

◆ RestoreState()

◆ SaveState()

◆ SetBrakeInput()

◆ SetDriverInput()

◆ SetForwardInput()

◆ SetLeftRatio()

◆ SetRightRatio()

◆ SetRPMMeter()

◆ SolveLongitudinalAndLateralConstraints()

◆ SyncLeftRightTracks()

Member Data Documentation

◆ mBrakeInput

◆ mEngine

◆ mForwardInput

◆ mLeftRatio

◆ mRightRatio

◆ mRPMMeterPosition

◆ mRPMMeterSize

◆ mTracks

◆ mTransmission