Chaos::FSimpleTransmissionSim Class Reference

#include <TransmissionSystem.h>

Inheritance diagram for Chaos::FSimpleTransmissionSim:

Public Member Functions
	FSimpleTransmissionSim (const FSimpleTransmissionConfig *SetupIn)
void	SetGear (int32 InGear, bool Immediate=false)
void	ChangeUp ()
void	ChangeDown ()
void	SetEngineRPM (float InRPM)
void	SetAllowedToChangeGear (bool OkToChangeIn)
int32	GetCurrentGear () const
int32	GetTargetGear () const
float	GetCurrentGearChangeTime () const
void	SetCurrentGear (const int32 InCurrentGear)
void	SetTargetGear (const int32 InTargetGear)
void	SetCurrentGearChangeTime (const float InCurrentGearChangeTime)
bool	IsCurrentlyChangingGear () const
bool	IsOutOfGear () const
float	GetGearRatio (int32 InGear)
float	GetTransmissionRPM (float InEngineRPM, int InGear)
float	GetTransmissionRPM ()
float	GetTransmissionTorque (float InEngineTorque)
float	GetEngineRPMFromWheelRPM (float InWheelRPM)
	‍** Given the transmission torque return the engine torque after taking into account the gear ratios *‍/
void	Simulate (float DeltaTime)
void	CorrectGearInputRange (int32 &GearIndexInOut)
Public Member Functions inherited from TVehicleSystem< FSimpleTransmissionConfig >
	TVehicleSystem ()
	TVehicleSystem (const FSimpleTransmissionConfig *SetupIn)
FSimpleTransmissionConfig &	AccessSetup ()
const FSimpleTransmissionConfig &	Setup () const

Additional Inherited Members
Public Attributes inherited from TVehicleSystem< FSimpleTransmissionConfig >
const FSimpleTransmissionConfig *	SetupPtr

Constructor & Destructor Documentation

FSimpleTransmissionSim()

Chaos::FSimpleTransmissionSim::FSimpleTransmissionSim

(

const FSimpleTransmissionConfig *

SetupIn

)

Member Function Documentation

ChangeDown()

void Chaos::FSimpleTransmissionSim::ChangeDown ( )

inline

set the target gear to one lower than current target, will clamp gear index within rage

ChangeUp()

void Chaos::FSimpleTransmissionSim::ChangeUp ( )

inline

set the target gear to one higher than current target, will clamp gear index within rage

CorrectGearInputRange()

void Chaos::FSimpleTransmissionSim::CorrectGearInputRange ( int32 &  GearIndexInOut )

inline

GetCurrentGear()

int32 Chaos::FSimpleTransmissionSim::GetCurrentGear ( ) const

inline

Get the current gear index, (reverse gears < 0, neutral 0, forward gears > 0)

GetCurrentGearChangeTime()

float Chaos::FSimpleTransmissionSim::GetCurrentGearChangeTime ( ) const

inline

Get the current gear change time

GetEngineRPMFromWheelRPM()

float Chaos::FSimpleTransmissionSim::GetEngineRPMFromWheelRPM ( float  InWheelRPM )

inline

‍** Given the transmission torque return the engine torque after taking into account the gear ratios *‍/

Get the expected engine RPM from the wheel RPM taking into account the current gear ratio (assuming no clutch slip)

GetGearRatio()

float Chaos::FSimpleTransmissionSim::GetGearRatio

(

int32

InGear

)

Get the final combined gear ratio for the specified gear (reverse gears < 0, neutral 0, forward gears > 0)

GetTargetGear()

int32 Chaos::FSimpleTransmissionSim::GetTargetGear ( ) const

inline

Get the target gear index, (reverse gears < 0, neutral 0, forward gears > 0)

GetTransmissionRPM() [1/2]

float Chaos::FSimpleTransmissionSim::GetTransmissionRPM ( )

inline

Get the transmission RPM for the current state of the engine RPM and gear selection

GetTransmissionRPM() [2/2]

float Chaos::FSimpleTransmissionSim::GetTransmissionRPM ( float  InEngineRPM, int  InGear  )

inline

Get the transmission RPM, from the specified engine RPM and gear selection

GetTransmissionTorque()

float Chaos::FSimpleTransmissionSim::GetTransmissionTorque ( float  InEngineTorque )

inline

Given the engine torque return the transmission torque taking into account the gear ratios and transmission losses

IsCurrentlyChangingGear()

bool Chaos::FSimpleTransmissionSim::IsCurrentlyChangingGear ( ) const

inline

Are we currently in the middle of a gear change

IsOutOfGear()

bool Chaos::FSimpleTransmissionSim::IsOutOfGear ( ) const

inline

SetAllowedToChangeGear()

void Chaos::FSimpleTransmissionSim::SetAllowedToChangeGear ( bool  OkToChangeIn )

inline

SetCurrentGear()

void Chaos::FSimpleTransmissionSim::SetCurrentGear ( const int32  InCurrentGear )

inline

Set the current gear index, (reverse gears < 0, neutral 0, forward gears > 0)

SetCurrentGearChangeTime()

void Chaos::FSimpleTransmissionSim::SetCurrentGearChangeTime ( const float  InCurrentGearChangeTime )

inline

Set the current gear change time

SetEngineRPM()

void Chaos::FSimpleTransmissionSim::SetEngineRPM ( float  InRPM )

inline

Tell the transmission system what the current engine RPM is, so we can decide when to change up/down with automatic transmission type

SetGear()

void Chaos::FSimpleTransmissionSim::SetGear	(	int32	InGear,
		bool	Immediate = false
	)

set the target gear number to change to, can change gear immediately if specified i.e. rather than waiting for the gear change time to elapse

SetTargetGear()

void Chaos::FSimpleTransmissionSim::SetTargetGear ( const int32  InTargetGear )

inline

Set the target gear index, (reverse gears < 0, neutral 0, forward gears > 0)

Simulate()

void Chaos::FSimpleTransmissionSim::Simulate

(

float

DeltaTime

)

---

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

• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/TransmissionSystem.h
• Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Private/TransmissionSystem.cpp