1. Epic GamesDeveloper
  3. UChaosWheeledVehicleMovementComponent

UChaosWheeledVehicleMovementComponent

API > API/Plugins > API/Plugins/ChaosVehicles

   
Name UChaosWheeledVehicleMovementComponent
Type class
Header File /Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosWheeledVehicleMovementComponent.h
Include Path #include "ChaosWheeledVehicleMovementComponent.h"

Syntax

UCLASS (ClassGroup=(Physics), Meta=(BlueprintSpawnableComponent),  
       HideCategories=(PlanarMovement, "Components|Movement|Planar", Activation, "Components|Activation"))  
class UChaosWheeledVehicleMovementComponent : public UChaosVehicleMovementComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosWheeledVehicleMovementComponent ( const FObjectInitializer& ObjectInitializer
)

 UChaosWheeledVehicleMovementComponent ChaosWheeledVehicleMovementComponent.h  

Structs

Name Remarks
FCachedState  

Constants

Name Type Remarks Include Path
DebugPage EDebugPages   ChaosWheeledVehicleMovementComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bLegacyWheelFrictionPosition bool   ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=WheelSetup
bMechanicalSimEnabled bool   ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=MechanicalSetup
bSuspensionEnabled bool   ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=WheelSetup
bWheelFrictionEnabled bool   ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=WheelSetup
DifferentialSetup FVehicleDifferentialConfig Differential ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=MechanicalSetup
  • Meta=(EditCondition="bMechanicalSimEnabled")
EngineSetup FVehicleEngineConfig Engine ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=MechanicalSetup
  • Meta=(EditCondition="bMechanicalSimEnabled")
SteeringSetup FVehicleSteeringConfig Transmission data ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=SteeringSetup
TransmissionSetup FVehicleTransmissionConfig Transmission data ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=MechanicalSetup
  • Meta=(EditCondition="bMechanicalSimEnabled")
Wheels TArray< TObjectPtr< class UChaosVehicleWheel > > Our instanced wheels. ChaosWheeledVehicleMovementComponent.h
  • Transient
  • DuplicateTransient
  • BlueprintReadOnly
  • Category=Vehicle
WheelSetups TArray< FChaosWheelSetup > Wheels to create ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=WheelSetup
WheelTraceCollisionResponses FCollisionResponseContainer   ChaosWheeledVehicleMovementComponent.h
  • EditAnywhere
  • Category=Custom

Protected

Name Type Remarks Include Path Unreal Specifiers
AxleToWheelMap TMap< UChaosVehicleWheel *, TArray< int > >   ChaosWheeledVehicleMovementComponent.h  
CachedState TArray< FCachedState > Wheel output status ChaosWheeledVehicleMovementComponent.h  
ConstraintHandles TArray< FPhysicsConstraintHandle >   ChaosWheeledVehicleMovementComponent.h  
NumDrivenWheels uint32   ChaosWheeledVehicleMovementComponent.h  
PerformanceMeasure Chaos::FPerformanceMeasure   ChaosWheeledVehicleMovementComponent.h  
WheelStatus TArray< FWheelStatus >   ChaosWheeledVehicleMovementComponent.h  
WheelTrackDimensions FVector2D The number of wheels that have engine enabled checked ChaosWheeledVehicleMovementComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EnableMechanicalSim ( bool InState
)

 Enable or completely bypass the ProcessMechanicalSimulation call ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void EnableSuspension ( bool InState
)

 Enable or completely bypass the ApplySuspensionForces call ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void EnableWheelFriction ( bool InState
)

 Enable or completely bypass the ApplyWheelFrictionForces call ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

float GetEngineMaxRotationSpeed()

 Get current engine's max rotation speed ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

float GetEngineRotationSpeed()

 Get current engine's rotation speed ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

int GetNumWheels()

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

UPhysicalMaterial * GetPhysMaterial ( int WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h  

virtual FWheeledSnaphotData GetSnapshot()

 Grab a snapshot of the vehicle instance dynamic state ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

const FWheelStatus & GetWheelState ( int WheelIndex
) const

 Get a wheels current simulation state ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetABSEnabled ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetAffectedByBrake ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetAffectedByEngine ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetAffectedByHandbrake ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetAffectedBySteering ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetBrakeTorque ( float BrakeTorque,
int32 WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetDifferentialFrontRearSplit ( float FrontRearSlpit
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetDownforceCoefficient ( float DownforceCoeff
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetDragCoefficient ( float DragCoeff
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetDriveTorque ( float DriveTorque,
int32 WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetMaxEngineTorque ( float Torque
)

 Change handling via blueprint at runtime ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

virtual void SetSnapshot ( const FWheeledSnaphotData& SnapshotIn
)

 Set snapshot of vehicle instance dynamic state ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetSuspensionParams ( float Rate,
float Damping,
float Preload,
float MaxRaise,
float MaxDrop,
int32 WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetTorqueCombineMethod ( ETorqueCombineMethod InCombineMethod,
int32 WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetTractionControlEnabled ( int WheelIndex,
bool Enabled
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelClass ( int WheelIndex,
TSubclassOf< UChaosVehicleWheel > InWheelClass
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelFrictionMultiplier ( int WheelIndex,
float Friction
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelHandbrakeTorque ( int WheelIndex,
float Torque
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelMaxBrakeTorque ( int WheelIndex,
float Torque
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelMaxSteerAngle ( int WheelIndex,
float AngleDegrees
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelRadius ( int WheelIndex,
float Radius
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelSlipGraphMultiplier ( int WheelIndex,
float Multiplier
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintCallable
  • Category="Game|Components|ChaosWheeledVehicleMovement"

void SetWheelTraceAllChannels ( ECollisionResponse NewResponse
)

 Set all channels to the specified response - for wheel raycasts ChaosWheeledVehicleMovementComponent.h  

void SetWheelTraceResponseToChannel ( ECollisionChannel Channel,
ECollisionResponse NewResponse
)

 Set the response of this body to the supplied settings - for wheel raycasts ChaosWheeledVehicleMovementComponent.h  

Overridden from UChaosVehicleMovementComponent

Name Remarks Include Path Unreal Specifiers

virtual bool CanCreateVehicle()

 Are the configuration references configured sufficiently that the vehicle can be created ChaosWheeledVehicleMovementComponent.h  

virtual TUniquePtr< Chaos::FSimpleWheeledVehicle > CreatePhysicsVehicle()

   ChaosWheeledVehicleMovementComponent.h  

virtual float GetSuspensionOffset ( int WheelIndex
)

   ChaosWheeledVehicleMovementComponent.h  

virtual void ParallelUpdate ( float DeltaSeconds
)

 Get output data from Physics Thread. ChaosWheeledVehicleMovementComponent.h  

virtual void ResetVehicleState()

   ChaosWheeledVehicleMovementComponent.h  

virtual void SetupVehicle ( TUniquePtr< Chaos::FSimpleWheeledVehicle >& PVehicle
)

 Allocate and setup the Chaos vehicle ChaosWheeledVehicleMovementComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnCreatePhysicsState()

 Used to create any physics engine information for this component ChaosWheeledVehicleMovementComponent.h  

virtual void OnDestroyPhysicsState()

 Used to shut down and pysics engine structure for this component ChaosWheeledVehicleMovementComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 End UObject interface Respond to a property change in editor ChaosWheeledVehicleMovementComponent.h  

virtual void PostLoad()

   ChaosWheeledVehicleMovementComponent.h  

virtual void Serialize ( FArchive& Ar
)

 Get Collision ResponseToChannels container for this component ChaosWheeledVehicleMovementComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CreateWheels()

 Instantiate and setup our wheel objects ChaosWheeledVehicleMovementComponent.h  

virtual void DestroyWheels()

 Release our wheel objects ChaosWheeledVehicleMovementComponent.h  

void FillWheelOutputState()

 Update. ChaosWheeledVehicleMovementComponent.h  

const FVector2D & GetWheelLayoutDimensions()

 Get distances between wheels - primarily a debug display helper ChaosWheeledVehicleMovementComponent.h  

virtual FVector GetWheelRestingPosition ( const FChaosWheelSetup& WheelSetup
)

 Get the local position of the wheel at rest ChaosWheeledVehicleMovementComponent.h  

void RecalculateAxles()

 Maps UChaosVehicleWheel Axle to a wheel index ChaosWheeledVehicleMovementComponent.h  

void SetupSuspension ( TUniquePtr< Chaos::FSimpleWheeledVehicle >& PVehicle
)

 Setup calculated suspension parameters ChaosWheeledVehicleMovementComponent.h  

virtual void SetupVehicleShapes()

 Set up the chassis and wheel shapes ChaosWheeledVehicleMovementComponent.h  

Overridden from UChaosVehicleMovementComponent

Name Remarks Include Path Unreal Specifiers

virtual void ComputeConstants()

 Re-Compute any runtime constants values that rely on setup data ChaosWheeledVehicleMovementComponent.h  

virtual void CreateVehicle()

 Create and setup the Chaos vehicle ChaosWheeledVehicleMovementComponent.h  

virtual void DrawDebug ( UCanvas* Canvas,
float& YL,
float& YPos
)

 Draw 2D debug text graphs on UI for the wheels, suspension and other systems ChaosWheeledVehicleMovementComponent.h  

virtual void FixupSkeletalMesh()

 Skeletal mesh needs some special handling in the vehicle case ChaosWheeledVehicleMovementComponent.h  

virtual void Update ( float DeltaTime
)

 Fill Async input state ChaosWheeledVehicleMovementComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BreakWheeledSnapshot ( const FWheeledSnaphotData& Snapshot,
FTransform& Transform,
FVector& LinearVelocity,
FVector& AngularVelocity,
int& SelectedGear,
float& EngineRPM,
TArray< FWheelSnapshot >& WheelSnapshots
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static void BreakWheelSnapshot ( const FWheelSnapshot& Snapshot,
float& SuspensionOffset,
float& WheelRotationAngle,
float& SteeringAngle,
float& WheelRadius,
float& WheelAngularVelocity
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static void BreakWheelStatus ( const FWheelStatus& Status,
bool& bInContact,
FVector& ContactPoint,
UPhysicalMaterial*& PhysMaterial,
float& NormalizedSuspensionLength,
float& SpringForce,
float& SlipAngle,
bool& bIsSlipping,
float& SlipMagnitude,
bool& bIsSkidding,
float& SkidMagnitude,
FVector& SkidNormal,
float& DriveTorque,
float& BrakeTorque,
bool& bABSActivated
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static FWheeledSnaphotData MakeWheeledSnapshot ( FTransform Transform,
FVector LinearVelocity,
FVector AngularVelocity,
int SelectedGear,
float EngineRPM,
const TArray< FWheelSnapshot >& WheelSnapshots
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static FWheelSnapshot MakeWheelSnapshot ( float SuspensionOffset,
float WheelRotationAngle,
float SteeringAngle,
float WheelRadius,
float WheelAngularVelocity
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static FWheelStatus MakeWheelStatus ( bool bInContact,
FVector& ContactPoint,
UPhysicalMaterial* PhysMaterial,
float NormalizedSuspensionLength,
float SpringForce,
float SlipAngle,
bool bIsSlipping,
float SlipMagnitude,
bool bIsSkidding,
float SkidMagnitude,
FVector& SkidNormal,
float DriveTorque,
float BrakeTorque,
bool bABSActivated
)

   ChaosWheeledVehicleMovementComponent.h
  • BlueprintPure
  • Category="Vehicles"

static void NextDebugPage()

 Display next debug page ChaosWheeledVehicleMovementComponent.h  

static void PrevDebugPage()

 Display previous debug page ChaosWheeledVehicleMovementComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page