Navigation
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
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UMovementComponent → UNavMovementComponent → UPawnMovementComponent → UChaosVehicleMovementComponent → UChaosWheeledVehicleMovementComponent
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 |
|
|
| bMechanicalSimEnabled | bool | ChaosWheeledVehicleMovementComponent.h |
|
|
| bSuspensionEnabled | bool | ChaosWheeledVehicleMovementComponent.h |
|
|
| bWheelFrictionEnabled | bool | ChaosWheeledVehicleMovementComponent.h |
|
|
| DifferentialSetup | FVehicleDifferentialConfig | Differential | ChaosWheeledVehicleMovementComponent.h |
|
| EngineSetup | FVehicleEngineConfig | Engine | ChaosWheeledVehicleMovementComponent.h |
|
| SteeringSetup | FVehicleSteeringConfig | Transmission data | ChaosWheeledVehicleMovementComponent.h |
|
| TransmissionSetup | FVehicleTransmissionConfig | Transmission data | ChaosWheeledVehicleMovementComponent.h |
|
| Wheels | TArray< TObjectPtr< class UChaosVehicleWheel > > | Our instanced wheels. | ChaosWheeledVehicleMovementComponent.h |
|
| WheelSetups | TArray< FChaosWheelSetup > | Wheels to create | ChaosWheeledVehicleMovementComponent.h |
|
| WheelTraceCollisionResponses | FCollisionResponseContainer | ChaosWheeledVehicleMovementComponent.h |
|
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 |
|
void EnableSuspension
(
bool InState |
Enable or completely bypass the ApplySuspensionForces call | ChaosWheeledVehicleMovementComponent.h |
|
void EnableWheelFriction
(
bool InState |
Enable or completely bypass the ApplyWheelFrictionForces call | ChaosWheeledVehicleMovementComponent.h |
|
float GetEngineMaxRotationSpeed() |
Get current engine's max rotation speed | ChaosWheeledVehicleMovementComponent.h |
|
float GetEngineRotationSpeed() |
Get current engine's rotation speed | ChaosWheeledVehicleMovementComponent.h |
|
int GetNumWheels() |
ChaosWheeledVehicleMovementComponent.h |
|
|
UPhysicalMaterial * GetPhysMaterial
(
int WheelIndex |
ChaosWheeledVehicleMovementComponent.h | ||
virtual FWheeledSnaphotData GetSnapshot() |
Grab a snapshot of the vehicle instance dynamic state | ChaosWheeledVehicleMovementComponent.h |
|
const FWheelStatus & GetWheelState
(
int WheelIndex |
Get a wheels current simulation state | ChaosWheeledVehicleMovementComponent.h |
|
void SetABSEnabled
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetAffectedByBrake
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetAffectedByEngine
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetAffectedByHandbrake
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetAffectedBySteering
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetBrakeTorque
(
float BrakeTorque, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetDifferentialFrontRearSplit
(
float FrontRearSlpit |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetDownforceCoefficient
(
float DownforceCoeff |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetDragCoefficient
(
float DragCoeff |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetDriveTorque
(
float DriveTorque, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetMaxEngineTorque
(
float Torque |
Change handling via blueprint at runtime | ChaosWheeledVehicleMovementComponent.h |
|
virtual void SetSnapshot
(
const FWheeledSnaphotData& SnapshotIn |
Set snapshot of vehicle instance dynamic state | ChaosWheeledVehicleMovementComponent.h |
|
void SetSuspensionParams
(
float Rate, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetTorqueCombineMethod
(
ETorqueCombineMethod InCombineMethod, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetTractionControlEnabled
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelClass
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelFrictionMultiplier
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelHandbrakeTorque
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelMaxBrakeTorque
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelMaxSteerAngle
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelRadius
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelSlipGraphMultiplier
(
int WheelIndex, |
ChaosWheeledVehicleMovementComponent.h |
|
|
void SetWheelTraceAllChannels
(
ECollisionResponse NewResponse |
Set all channels to the specified response - for wheel raycasts | ChaosWheeledVehicleMovementComponent.h | |
void SetWheelTraceResponseToChannel
(
ECollisionChannel Channel, |
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, |
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, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static void BreakWheelSnapshot
(
const FWheelSnapshot& Snapshot, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static void BreakWheelStatus
(
const FWheelStatus& Status, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static FWheeledSnaphotData MakeWheeledSnapshot
(
FTransform Transform, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static FWheelSnapshot MakeWheelSnapshot
(
float SuspensionOffset, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static FWheelStatus MakeWheelStatus
(
bool bInContact, |
ChaosWheeledVehicleMovementComponent.h |
|
|
static void NextDebugPage() |
Display next debug page | ChaosWheeledVehicleMovementComponent.h | |
static void PrevDebugPage() |
Display previous debug page | ChaosWheeledVehicleMovementComponent.h |