#include <TorqueSimModule.h>

Inheritance diagram for Chaos::FTorqueSimModule:

Public Member Functions
	DEFINE_CHAOSSIMTYPENAME (FTorqueSimModule)

	FTorqueSimModule ()

virtual bool	IsBehaviourType (eSimModuleTypeFlags InType) const

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 const FString	GetDebugName () const =0

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	Simulate (float DeltaTime, const FAllInputs &Inputs, FSimModuleTree &VehicleModuleSystem)

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 ()

virtual UE_API bool	GetDebugString (FString &StringOut) const

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 ()

virtual TSharedPtr< FModuleNetData >	GenerateNetData (const int32 NodeArrayIndex) const =0

virtual FSimOutputData *	GenerateOutputData () const

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 ()

Static Public Member Functions
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 ()

Additional Inherited Members
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

Constructor & Destructor Documentation

◆ FTorqueSimModule()

Chaos::FTorqueSimModule::FTorqueSimModule ( )

inline

Member Function Documentation

◆ AddAngularVelocity()

void Chaos::FTorqueSimModule::AddAngularVelocity ( float AngularVelocityIn )

inline

◆ CastToTorqueInterface()

static FTorqueSimModule * Chaos::FTorqueSimModule::CastToTorqueInterface ( ISimulationModuleBase * SimModule )

inlinestatic

Cast an ISimulationModuleBase to a FTorqueSimModule if compatible class

◆ DEFINE_CHAOSSIMTYPENAME()

Chaos::FTorqueSimModule::DEFINE_CHAOSSIMTYPENAME ( FTorqueSimModule )

◆ GetAngularPosition()

float Chaos::FTorqueSimModule::GetAngularPosition ( ) const

inline

◆ GetAngularVelocity()

float Chaos::FTorqueSimModule::GetAngularVelocity ( ) const

inline

◆ GetBrakingTorque()

float Chaos::FTorqueSimModule::GetBrakingTorque ( ) const

inline

◆ GetDriveTorque()

float Chaos::FTorqueSimModule::GetDriveTorque ( ) const

inline

◆ GetLoadTorque()

float Chaos::FTorqueSimModule::GetLoadTorque ( ) const

inline

◆ GetRPM()

float Chaos::FTorqueSimModule::GetRPM ( ) const

inline

◆ IntegrateAngularVelocity()

void Chaos::FTorqueSimModule::IntegrateAngularVelocity	(	float	DeltaTime,
		float	Inertia,
		float	MaxRotationVel = `MAX_FLT`
	)

Integrate angular velocity using specified DeltaTime & Inertia value, Note the inertia should be the combined inertia of all the connected pieces otherwise things will rotate at different rates

◆ IsBehaviourType()

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

inlinevirtual

Is Module of a specific type - used for casting

Implements Chaos::ISimulationModuleBase.

Reimplemented in Chaos::FTransmissionSimModule, and Chaos::FWheelSimModule.

◆ SetAngularPosition()

void Chaos::FTorqueSimModule::SetAngularPosition ( float AngularPositionIn )

inline

◆ SetAngularVelocity()

void Chaos::FTorqueSimModule::SetAngularVelocity ( float AngularVelocityIn )

inline

◆ SetBrakingTorque()

void Chaos::FTorqueSimModule::SetBrakingTorque ( float TorqueIn )

inline

◆ SetDriveTorque()

void Chaos::FTorqueSimModule::SetDriveTorque ( float TorqueIn )

inline

◆ SetLoadTorque()

void Chaos::FTorqueSimModule::SetLoadTorque ( float TorqueIn )

inline

◆ SetRPM()

void Chaos::FTorqueSimModule::SetRPM ( float InRPM )

inline

◆ TransmitTorque()

void Chaos::FTorqueSimModule::TransmitTorque	(	const FSimModuleTree &	BlockSystem,
		float	PushedTorque,
		float	BrakeTorque = `0.f`,
		float	GearingRatio = `1.0f`,
		float	ClutchSlip = `1.0f`
	)

Transmit torque between this module and its Parent and Children. DriveTorque passed down to children, LoadTorque passed from child to parent

Member Data Documentation

◆ AngularPosition

float Chaos::FTorqueSimModule::AngularPosition

protected

◆ AngularVelocity

float Chaos::FTorqueSimModule::AngularVelocity

protected

◆ BrakingTorque

float Chaos::FTorqueSimModule::BrakingTorque

protected

◆ DriveTorque

float Chaos::FTorqueSimModule::DriveTorque

protected

◆ LoadTorque

float Chaos::FTorqueSimModule::LoadTorque

protected

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

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

Protected Attributes
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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FTorqueSimModule()

Member Function Documentation

◆ AddAngularVelocity()

◆ CastToTorqueInterface()

◆ DEFINE_CHAOSSIMTYPENAME()

◆ GetAngularPosition()

◆ GetAngularVelocity()

◆ GetBrakingTorque()

◆ GetDriveTorque()

◆ GetLoadTorque()

◆ GetRPM()

◆ IntegrateAngularVelocity()

◆ IsBehaviourType()

◆ SetAngularPosition()

◆ SetAngularVelocity()

◆ SetBrakingTorque()

◆ SetDriveTorque()

◆ SetLoadTorque()

◆ SetRPM()

◆ TransmitTorque()

Member Data Documentation

◆ AngularPosition

◆ AngularVelocity

◆ BrakingTorque

◆ DriveTorque

◆ LoadTorque