#include <TransmissionModule.h>

Inheritance diagram for Chaos::FTransmissionSimModule:

Public Member Functions
	DEFINE_CHAOSSIMTYPENAME (FTransmissionSimModule)

UE_API	FTransmissionSimModule (const FTransmissionSettings &Settings)

virtual TSharedPtr< FModuleNetData >	GenerateNetData (const int32 SimArrayIndex) const override

virtual FSimOutputData *	GenerateOutputData () const override

virtual const FString	GetDebugName () const

virtual UE_API bool	GetDebugString (FString &StringOut) const override

virtual bool	IsBehaviourType (eSimModuleTypeFlags InType) const override

virtual UE_API void	Simulate (float DeltaTime, const FAllInputs &Inputs, FSimModuleTree &VehicleModuleSystem) override

Public Member Functions inherited from Chaos::FTorqueSimModule
	DEFINE_CHAOSSIMTYPENAME (FTorqueSimModule)

	FTorqueSimModule ()

void	SetDriveTorque (float TorqueIn)

float	GetDriveTorque () const

void	SetLoadTorque (float TorqueIn)

float	GetLoadTorque () const

void	SetBrakingTorque (float TorqueIn)

float	GetBrakingTorque () const

void	SetAngularVelocity (float AngularVelocityIn)

float	GetAngularVelocity () const

void	AddAngularVelocity (float AngularVelocityIn)

void	SetAngularPosition (float AngularPositionIn)

float	GetAngularPosition () const

void	SetRPM (float InRPM)

float	GetRPM () const

UE_API void	TransmitTorque (const FSimModuleTree &BlockSystem, float PushedTorque, float BrakeTorque=0.f, float GearingRatio=1.0f, float ClutchSlip=1.0f)

UE_API void	IntegrateAngularVelocity (float DeltaTime, float Inertia, float MaxRotationVel=MAX_FLT)

Public Member Functions inherited from Chaos::ISimulationModuleBase
	DEFINE_CHAOSSIMTYPENAME (ISimulationModuleBase)

	ISimulationModuleBase ()

virtual	~ISimulationModuleBase ()

int	GetGuid () const

void	SetGuid (int GuidIn)

virtual bool	IsEnabled () const

void	SetStateFlags (eSimModuleState StateFlagsIn)

virtual void	OnConstruction_External (const Chaos::FPhysicsObjectHandle &PhysicsObject)

virtual void	OnTermination_External ()

virtual void	Simulate (IPhysicsProxyBase Proxy, Chaos::FPBDRigidParticleHandle ParticleHandle, float DeltaTime, const FAllInputs &Inputs, FSimModuleTree &VehicleModuleSystem)

virtual void	OnContactModification (Chaos::FCollisionContactModifier &Modifier, IPhysicsProxyBase *Proxy)

virtual void	Animate ()

void	SetAnimationEnabled (bool bInEnabled)

bool	IsAnimationEnabled ()

UE_API void	SetAnimationData (const FName &BoneNameIn, const FVector &AnimationOffsetIn, int AnimationSetupIndexIn)

const FSimModuleAnimationData &	GetAnimationData () const

const FVector &	GetAnimationOffset () const

const FName &	GetBoneName () const

int	GetAnimationSetupIndex ()

virtual void	DrawDebugInfo ()

void	SetTransformIndex (int TransformIndexIn)

const int	GetTransformIndex () const

void	SetParticleIndex (FUniqueIdx ParticleIndexIn)

const FUniqueIdx	GetParticleIndex () const

void	SetTreeIndex (int TreeIndexIn)

int	GetTreeIndex () const

void	SetSimModuleTree (FSimModuleTree *SimModuleTreeIn)

UE_API void	AddLocalForceAtPosition (const FVector &Force, const FVector &Position, bool bAllowSubstepping=true, bool bIsLocalForce=false, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)

UE_API void	AddForceAtCOMPosition (const FVector &Force, const FVector &OffsetFromCOM=FVector::ZeroVector, bool bAllowSubstepping=true, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)

UE_API void	AddLocalForce (const FVector &Force, bool bAllowSubstepping=true, bool bIsLocalForce=false, bool bLevelSlope=false, const FColor &DebugColorIn=FColor::Blue)

UE_API void	AddLocalTorque (const FVector &Torque, bool bAllowSubstepping=true, bool bAccelChangeIn=true, const FColor &DebugColorIn=FColor::Magenta)

void	SetClustered (bool IsClusteredIn)

bool	IsClustered () const

void	SetClusteredTransform (const FTransform &TransformIn)

const FTransform &	GetClusteredTransform () const

void	SetInitialParticleTransform (const FTransform &TransformIn)

const FTransform &	GetInitialParticleTransform () const

void	SetComponentTransform (const FTransform &TransformIn)

const FTransform &	GetComponentTransform () const

void	SetIntactTransform (const FTransform &TransformIn)

const FTransform &	GetIntactTransform () const

UE_API const FTransform &	GetParentRelativeTransform () const

void	SetLocalLinearVelocity (const FVector &VelocityIn)

const FVector &	GetLocalLinearVelocity () const

void	SetLocalAngularVelocity (const FVector &VelocityIn)

const FVector &	GetLocalAngularVelocity () const

UE_API ISimulationModuleBase *	GetParent ()

UE_API ISimulationModuleBase *	GetFirstChild ()

UE_API FVehicleBlackboard *	GetSimBlackboard ()

const FVector &	GetAppliedForce ()

UE_API Chaos::FPBDRigidClusteredParticleHandle *	GetClusterParticle (Chaos::FClusterUnionPhysicsProxy *Proxy)

UE_API Chaos::FPBDRigidParticleHandle *	GetParticleFromUniqueIndex (int32 ParticleUniqueIdx, TArray< Chaos::FPBDRigidParticleHandle * > &Particles)

Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
void	AddType (FName InType)

bool	IsSimType (FName InType) const

FName	GetSimType () const

template<typename U >
bool	IsSimType () const

template<typename U >
U *	Cast ()

template<typename U >
const U *	Cast () const

Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< ISimulationModuleBase >
	TSimulationModuleTypeableBase ()

Public Member Functions inherited from Chaos::TSimModuleSettings< FTransmissionSettings >
	TSimModuleSettings (const FTransmissionSettings &SetupIn)

FORCEINLINE FTransmissionSettings &	AccessSetup ()

FORCEINLINE const FTransmissionSettings &	Setup () const

Protected Member Functions
UE_API void	SetGear (int32 InGear, bool Immediate=false)

UE_API float	GetGearRatio (int32 InGear) const

void	ChangeUp ()

void	ChangeDown ()

bool	IsCurrentlyChangingGear () const

void	CorrectGearInputRange (int32 &GearIndexInOut) const

int32	GetCurrentGear ()

int32	GetTargetGear ()

Additional Inherited Members
Static Public Member Functions inherited from Chaos::FTorqueSimModule
static FTorqueSimModule *	CastToTorqueInterface (ISimulationModuleBase *SimModule)

Static Public Member Functions inherited from Chaos::FSimulationModuleTypeContainer
template<typename U >
static FName	GetStaticSimType ()

Static Public Member Functions inherited from Chaos::TSimulationModuleTypeableBase< ISimulationModuleBase >
static FName	StaticSimTypeBase ()

Public Attributes inherited from Chaos::ISimulationModuleBase
bool	IsInitialized = false

Public Attributes inherited from Chaos::FSimulationModuleTypeContainer
TSet< FName >	MyTypes

FName	MostRecentAdd = NAME_None

Static Public Attributes inherited from Chaos::ISimulationModuleBase
static const int	INVALID_IDX = -1

Protected Attributes inherited from Chaos::FTorqueSimModule
float	DriveTorque

float	LoadTorque

float	BrakingTorque

float	AngularVelocity

float	AngularPosition

Protected Attributes inherited from Chaos::ISimulationModuleBase
FSimModuleTree *	SimModuleTree

int	SimTreeIndex

eSimModuleState	StateFlags

int	TransformIndex

FUniqueIdx	ParticleIdx

FTransform	InitialParticleTransform

FTransform	RelativeOffsetTransform

FTransform	ComponentTransform

FTransform	ClusteredCOMRelativeTransform

FTransform	IntactCOMRelativeTransform

FVector	LocalLinearVelocity

FVector	LocalAngularVelocity

bool	bClustered

bool	bAnimationEnabled

FVector	AnimationOffset

FSimModuleAnimationData	AnimationData

FVector	AppliedForce

int	Guid

FPBDRigidClusteredParticleHandle *	CachedParticle

Constructor & Destructor Documentation

◆ FTransmissionSimModule()

Chaos::FTransmissionSimModule::FTransmissionSimModule ( const FTransmissionSettings & Settings )

Member Function Documentation

◆ ChangeDown()

void Chaos::FTransmissionSimModule::ChangeDown ( )

inlineprotected

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

◆ ChangeUp()

void Chaos::FTransmissionSimModule::ChangeUp ( )

inlineprotected

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

◆ CorrectGearInputRange()

void Chaos::FTransmissionSimModule::CorrectGearInputRange ( int32 & GearIndexInOut ) const

inlineprotected

◆ DEFINE_CHAOSSIMTYPENAME()

Chaos::FTransmissionSimModule::DEFINE_CHAOSSIMTYPENAME ( FTransmissionSimModule )

◆ GenerateNetData()

virtual TSharedPtr< FModuleNetData > Chaos::FTransmissionSimModule::GenerateNetData ( const int32 SimArrayIndex ) const

inlineoverridevirtual

Implements Chaos::ISimulationModuleBase.

◆ GenerateOutputData()

virtual FSimOutputData * Chaos::FTransmissionSimModule::GenerateOutputData ( ) const

inlineoverridevirtual

Reimplemented from Chaos::ISimulationModuleBase.

◆ GetCurrentGear()

int32 Chaos::FTransmissionSimModule::GetCurrentGear ( )

inlineprotected

◆ GetDebugName()

virtual const FString Chaos::FTransmissionSimModule::GetDebugName ( ) const

inlinevirtual

Get the friendly name for this module, primarily for logging & debugging module tree

Implements Chaos::ISimulationModuleBase.

◆ GetDebugString()

bool Chaos::FTransmissionSimModule::GetDebugString ( FString & StringOut ) const

overridevirtual

Option to return debug text for drawing on the HUD in the Game Thread

Reimplemented from Chaos::ISimulationModuleBase.

◆ GetGearRatio()

float Chaos::FTransmissionSimModule::GetGearRatio ( int32 InGear ) const

protected

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

◆ GetTargetGear()

int32 Chaos::FTransmissionSimModule::GetTargetGear ( )

inlineprotected

◆ IsBehaviourType()

virtual bool Chaos::FTransmissionSimModule::IsBehaviourType ( eSimModuleTypeFlags InType ) const

inlineoverridevirtual

Is Module of a specific type - used for casting

Reimplemented from Chaos::FTorqueSimModule.

◆ IsCurrentlyChangingGear()

bool Chaos::FTransmissionSimModule::IsCurrentlyChangingGear ( ) const

inlineprotected

Are we currently in the middle of a gear change

◆ SetGear()

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

protected

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

◆ Simulate()

void Chaos::FTransmissionSimModule::Simulate	(	float	DeltaTime,
		const FAllInputs &	Inputs,
		FSimModuleTree &	VehicleModuleSystem
	)

overridevirtual

The main Simulation function that is called from the physics async callback thread

Reimplemented from Chaos::ISimulationModuleBase.

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

Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Public/SimModule/TransmissionModule.h
Engine/Source/Runtime/Experimental/ChaosVehicles/ChaosVehiclesCore/Private/SimModule/TransmissionModule.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ FTransmissionSimModule()

Member Function Documentation

◆ ChangeDown()

◆ ChangeUp()

◆ CorrectGearInputRange()

◆ DEFINE_CHAOSSIMTYPENAME()

◆ GenerateNetData()

◆ GenerateOutputData()

◆ GetCurrentGear()

◆ GetDebugName()

◆ GetDebugString()

◆ GetGearRatio()

◆ GetTargetGear()

◆ IsBehaviourType()

◆ IsCurrentlyChangingGear()

◆ SetGear()

◆ Simulate()