Navigation
API > API/Plugins > API/Plugins/ChaosVehicles
| Name | UChaosVehicleWheel |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ChaosVehiclesPlugin/Source/ChaosVehicles/Public/ChaosVehicleWheel.h |
| Include Path | #include "ChaosVehicleWheel.h" |
Syntax
UCLASS (BlueprintType, Blueprintable)
class UChaosVehicleWheel : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UChaosVehicleWheel
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AxleType | EAxleType | If left undefined then the bAffectedByEngine value is used, if defined then bAffectedByEngine is ignored and the differential setup on the vehicle defines which wheels get power from the engine | ChaosVehicleWheel.h |
|
| bABSEnabled | bool | Advanced Braking System Enabled | ChaosVehicleWheel.h |
|
| bAffectedByBrake | bool | Whether brake should affect this wheel | ChaosVehicleWheel.h |
|
| bAffectedByEngine | bool | Whether engine should power this wheel | ChaosVehicleWheel.h |
|
| bAffectedByHandbrake | bool | Whether handbrake should affect this wheel | ChaosVehicleWheel.h |
|
| bAffectedBySteering | bool | Whether steering should affect this wheel | ChaosVehicleWheel.h |
|
| bTractionControlEnabled | bool | Straight Line Traction Control Enabled | ChaosVehicleWheel.h |
|
| CollisionMesh | TObjectPtr< class UStaticMesh > | Static mesh with collision setup for wheel, will be used to create wheel shape (if empty, sphere will be added as wheel shape, check bDontCreateShape flag) | ChaosVehicleWheel.h |
|
| CorneringStiffness | float | Tyre Cornering Ability | ChaosVehicleWheel.h |
|
| DebugLatForce | float | Lateral force the wheel is applying to the chassis. | ChaosVehicleWheel.h |
|
| DebugLatSlip | float | Lateral slip experienced by the wheel. | ChaosVehicleWheel.h |
|
| DebugLongForce | float | Longitudinal force the wheel is applying to the chassis. | ChaosVehicleWheel.h |
|
| DebugLongSlip | float | Longitudinal slip experienced by the wheel. | ChaosVehicleWheel.h |
|
| DebugNormalizedTireLoad | float | How much force the tire experiences at rest divided by how much force it is experiencing now. | ChaosVehicleWheel.h |
|
| DebugTireLoad | float | How much force the tire is experiencing now. | ChaosVehicleWheel.h | |
| DebugWheelTorque | float | Wheel torque. | ChaosVehicleWheel.h |
|
| ExternalTorqueCombineMethod | ETorqueCombineMethod | Determines how the SetDriveTorque/SetBrakeTorque inputs are combined with the internal torques | ChaosVehicleWheel.h |
|
| FrictionForceMultiplier | float | Friction Force Multiplier | ChaosVehicleWheel.h |
|
| LateralSlipGraph | FRuntimeFloatCurve | ChaosVehicleWheel.h |
|
|
| Location | FVector | Worldspace location of this wheel. | ChaosVehicleWheel.h |
|
| MaxBrakeTorque | float | Max brake torque for this wheel (Nm) | ChaosVehicleWheel.h |
|
| MaxHandBrakeTorque | float | Max handbrake brake torque for this wheel (Nm). | ChaosVehicleWheel.h |
|
| MaxSteerAngle | float | Steer angle in degrees for this wheel | ChaosVehicleWheel.h |
|
| MaxWheelspinRotation | float | Max Wheelspin rotation rad/sec | ChaosVehicleWheel.h |
|
| ObjectInitializer | const FObjectInitializer & | ChaosVehicleWheel.h | ||
| Offset | FVector | If BoneName is specified, offset the wheel from the bone's location. | ChaosVehicleWheel.h |
|
| OldLocation | FVector | Worldspace location of this wheel last frame. | ChaosVehicleWheel.h |
|
| RollbarScaling | float | Anti-roll effect | ChaosVehicleWheel.h |
|
| SideSlipModifier | float | Wheel Lateral Skid Grip Loss, lower number less grip on skid | ChaosVehicleWheel.h |
|
| SkidThreshold | float | Wheel Lateral Skid Threshold | ChaosVehicleWheel.h |
|
| SlipThreshold | float | Wheel Longitudinal Slip Threshold | ChaosVehicleWheel.h |
|
| SpringPreload | float | Spring Preload (N/m) | ChaosVehicleWheel.h |
|
| SpringRate | float | Spring Force (N/m) | ChaosVehicleWheel.h |
|
| SuspensionAxis | FVector | Local body direction in which where suspension forces are applied (typically along -Z-axis) | ChaosVehicleWheel.h |
|
| SuspensionDampingRatio | float | Suspension damping, larger value causes the suspension to come to rest faster [range 0 to 1] | ChaosVehicleWheel.h |
|
| SuspensionForceOffset | FVector | Vertical offset from where suspension forces are applied (along Z-axis) | ChaosVehicleWheel.h |
|
| SuspensionMaxDrop | float | How far the wheel can drop below the resting position | ChaosVehicleWheel.h |
|
| SuspensionMaxRaise | float | How far the wheel can go above the resting position | ChaosVehicleWheel.h |
|
| SuspensionSmoothing | int | Smooth suspension [0-off, 10-max] - Warning might cause momentary visual inter-penetration of the wheel against objects/terrain | ChaosVehicleWheel.h |
|
| SweepShape | ESweepShape | Wheel suspension trace type, defaults to ray trace | ChaosVehicleWheel.h |
|
| SweepType | ESweepType | Whether wheel suspension considers simple, complex | ChaosVehicleWheel.h |
|
| UChaosWheeledVehicleMovementComponent | ChaosVehicleWheel.h | |||
| VehicleComponent | TObjectPtr< class UChaosWheeledVehicleMovementComponent > | The vehicle that owns us | ChaosVehicleWheel.h |
|
| Velocity | FVector | Current velocity of the wheel center (change in location over time) | ChaosVehicleWheel.h |
|
| WheelIndex | int32 | Our index in the vehicle's (and setup's) wheels array. | ChaosVehicleWheel.h |
|
| WheelLoadRatio | float | Amount wheel load effects wheel friction. | ChaosVehicleWheel.h |
|
| WheelMass | float | Mass of the wheel Kg | ChaosVehicleWheel.h |
|
| WheelRadius | float | Radius of the wheel | ChaosVehicleWheel.h |
|
| WheelWidth | float | Width of the wheel | ChaosVehicleWheel.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PSuspensionConfig | Chaos::FSimpleSuspensionConfig | ChaosVehicleWheel.h | ||
| PWheelConfig | Chaos::FSimpleWheelConfig | ChaosVehicleWheel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EAxleType GetAxleType() |
ChaosVehicleWheel.h |
|
|
UPhysicalMaterial * GetContactSurfaceMaterial() |
Get contact surface material | ChaosVehicleWheel.h | |
const Chaos::FSimpleSuspensionConfig & GetPhysicsSuspensionConfig() |
ChaosVehicleWheel.h | ||
const Chaos::FSimpleWheelConfig & GetPhysicsWheelConfig() |
ChaosVehicleWheel.h | ||
float GetRotationAngle() |
ChaosVehicleWheel.h |
|
|
float GetRotationAngularVelocity() |
ChaosVehicleWheel.h |
|
|
float GetSteerAngle() |
ChaosVehicleWheel.h |
|
|
FVector GetSuspensionAxis() |
ChaosVehicleWheel.h |
|
|
float GetSuspensionOffset() |
ChaosVehicleWheel.h |
|
|
float GetWheelAngularVelocity() |
ChaosVehicleWheel.h |
|
|
float GetWheelRadius() |
ChaosVehicleWheel.h |
|
|
FChaosWheelSetup & GetWheelSetup() |
Get the Axle setup we were created from | ChaosVehicleWheel.h | |
virtual void Init
(
UChaosWheeledVehicleMovementComponent* InVehicleSim, |
Initialize this wheel instance | ChaosVehicleWheel.h | |
bool IsInAir() |
ChaosVehicleWheel.h |
|
|
virtual void Shutdown() |
Notify this wheel it will be removed from the scene | ChaosVehicleWheel.h | |
virtual void Tick
(
float DeltaTime |
Tick this class when the vehicle ticks | ChaosVehicleWheel.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Respond to a property change in editor | ChaosVehicleWheel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector GetPhysicsLocation() |
Get the wheel's location in physics land | ChaosVehicleWheel.h |