1. Epic GamesDeveloper
  3. UChaosWheeledVehicleMovementComponent

UChaosWheeledVehicleMovementComponent

API > API/Plugins > API/Plugins/ChaosVehicles

Inheritance Hierarchy

References

   
Module ChaosVehicles
Header /Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosWheeledVehicleMovementComponent.h
Include #include "ChaosWheeledVehicleMovementComponent.h"

Syntax

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bLegacyWheelFrictionPosition  
Public variable UProperty Category, EditAnywhere bool bMechanicalSimEnabled  
Public variable UProperty Category, EditAnywhere bool bSuspensionEnabled  
Public variable UProperty Category, EditAnywhere bool bWheelFrictionEnabled  
Public variable UProperty Category, EditAnywhere, Meta FVehicleDifferentialConfig DifferentialSetup Differential
Public variable UProperty Category, EditAnywhere, Meta FVehicleEngineConfig EngineSetup Engine
Public variable UProperty Category, EditAnywhere FVehicleSteeringConfig SteeringSetup Transmission data
Public variable UProperty Category, EditAnywhere, Meta FVehicleTransmissionConfig TransmissionSetup Transmission data
Public variable UProperty Category BlueprintReadOnly Transient duplicatetransient TArray< TObjectPtr< class UChaosVehicleWheel > > Wheels Our instanced wheels.
Public variable UProperty Category, EditAnywhere TArray< FChaosWheelSetup > WheelSetups Wheels to create
Public variable UProperty Category, EditAnywhere FCollisionResponseContainer WheelTraceCollisionResponses  

Constructors

  Type Name Description
Public function   UChaosWheeledVehicleMovementComponent

Functions

  Type Name Description
Public function Static UFunction BlueprintPure, Category void

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

  
Public function Static UFunction BlueprintPure, Category void

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

  
Public function Static UFunction BlueprintPure, Category 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
)

  
Protected function Virtual void Instantiate and setup our wheel objects
Protected function Virtual void Release our wheel objects
Public function UFunction BlueprintCallable, Category void

EnableMechanicalSim ( bool InState
)

 Enable or completely bypass the ProcessMechanicalSimulation call
Public function UFunction BlueprintCallable, Category void

EnableSuspension ( bool InState
)

 Enable or completely bypass the ApplySuspensionForces call
Public function UFunction BlueprintCallable, Category void

EnableWheelFriction ( bool InState
)

 Enable or completely bypass the ApplyWheelFrictionForces call
Protected function void Update.
Public function Const UFunction BlueprintCallable, Category float Get current engine's max rotation speed
Public function Const UFunction BlueprintCallable, Category float Get current engine's rotation speed
Public function Const UFunction BlueprintCallable, Category int  
Public function UPhysicalMaterial *

GetPhysMaterial ( int WheelIndex
)

  
Public function Virtual Const UFunction BlueprintCallable, Category FWheeledSnaphotData Grab a snapshot of the vehicle instance dynamic state
Protected function Const const FVector2D & Get distances between wheels - primarily a debug display helper
Protected function Virtual FVector Get the local position of the wheel at rest
Public function Const UFunction BlueprintCallable, Category const FWheelStatus &

GetWheelState ( int WheelIndex
)

 Get a wheels current simulation state
Public function Static UFunction BlueprintPure, Category FWheeledSnaphotData

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

  
Public function Static UFunction BlueprintPure, Category FWheelSnapshot

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

  
Public function Static UFunction BlueprintPure, Category 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
)

  
Public function Static void Display next debug page
Public function Virtual void  
Public function Static void Display previous debug page
Protected function void Maps UChaosVehicleWheel Axle to a wheel index
Public function UFunction BlueprintCallable, Category void

SetABSEnabled ( int WheelIndex,
bool Enabled
)

  
Public function UFunction BlueprintCallable, Category void

SetAffectedByBrake ( int WheelIndex,
bool Enabled
)

  
Public function UFunction BlueprintCallable, Category void

SetAffectedByEngine ( int WheelIndex,
bool Enabled
)

  
Public function UFunction BlueprintCallable, Category void

SetAffectedByHandbrake ( int WheelIndex,
bool Enabled
)

  
Public function UFunction BlueprintCallable, Category void

SetAffectedBySteering ( int WheelIndex,
bool Enabled
)

  
Public function UFunction BlueprintCallable, Category void

SetBrakeTorque ( float BrakeTorque,
int32 WheelIndex
)

  
Public function UFunction BlueprintCallable, Category void

SetDifferentialFrontRearSplit ( float FrontRearSlpit
)

  
Public function UFunction BlueprintCallable, Category void

SetDownforceCoefficient ( float DownforceCoeff
)

  
Public function UFunction BlueprintCallable, Category void

SetDragCoefficient ( float DragCoeff
)

  
Public function UFunction BlueprintCallable, Category void

SetDriveTorque ( float DriveTorque,
int32 WheelIndex
)

  
Public function UFunction BlueprintCallable, Category void

SetMaxEngineTorque ( float Torque
)

 Change handling via blueprint at runtime
Public function Virtual UFunction BlueprintCallable, Category void

SetSnapshot ( const FWheeledSnaphotData& SnapshotIn
)

 Set snapshot of vehicle instance dynamic state
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category void

SetTorqueCombineMethod ( ETorqueCombineMethod InCombineMethod,
int32 WheelIndex
)

  
Public function UFunction BlueprintCallable, Category void

SetTractionControlEnabled ( int WheelIndex,
bool Enabled
)

  
Protected function void Setup calculated suspension parameters
Protected function Virtual void Set up the chassis and wheel shapes
Public function UFunction BlueprintCallable, Category void

SetWheelClass ( int WheelIndex,
TSubclassOf< UChaosVehicleWheel > InWheelClass
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelFrictionMultiplier ( int WheelIndex,
float Friction
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelHandbrakeTorque ( int WheelIndex,
float Torque
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelMaxBrakeTorque ( int WheelIndex,
float Torque
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelMaxSteerAngle ( int WheelIndex,
float AngleDegrees
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelRadius ( int WheelIndex,
float Radius
)

  
Public function UFunction BlueprintCallable, Category void

SetWheelSlipGraphMultiplier ( int WheelIndex,
float Multiplier
)

  
Public function void

SetWheelTraceAllChannels ( ECollisionResponse NewResponse
)

 Set all channels to the specified response - for wheel raycasts
Public function void

SetWheelTraceResponseToChannel ( ECollisionChannel Channel,
ECollisionResponse NewResponse
)

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

Overridden from UChaosVehicleMovementComponent

  Type Name Description
Public function Virtual Const bool Are the configuration references configured sufficiently that the vehicle can be created
Protected function Virtual void Re-Compute any runtime constants values that rely on setup data
Public function Virtual TUniquePtr< Chaos::FSimpleWheeledVehicle >  
Protected function Virtual void Create and setup the Chaos vehicle
Protected function Virtual void

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

 Draw 2D debug text graphs on UI for the wheels, suspension and other systems
Protected function Virtual void Skeletal mesh needs some special handling in the vehicle case
Public function Virtual float

GetSuspensionOffset ( int WheelIndex
)

  
Public function Virtual void Used to create any physics engine information for this component
Public function Virtual void Used to shut down and pysics engine structure for this component
Public function Virtual void

ParallelUpdate ( float DeltaSeconds
)

 Get output data from Physics Thread.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 End UObject interface Respond to a property change in editor
Public function Virtual void  
Public function Virtual void Get Collision ResponseToChannels container for this component
Public function Virtual void Allocate and setup the Chaos vehicle
Protected function Virtual void

Update ( float DeltaTime
)

 Fill Async input state

Constants

Name Description
DebugPage  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page