1. Epic GamesDeveloper
  3. UPhysicsControlComponent

UPhysicsControlComponent

This is the main Physics Control Component class which manages Controls and Body Modifiers associated with one or more static or skeletal meshes.

API > API/Plugins > API/Plugins/PhysicsControl

Inheritance Hierarchy

  • USceneComponent
  • UPhysicsControlComponent

References

   
Module PhysicsControl
Header /Engine/Plugins/Experimental/PhysicsControl/Source/PhysicsControl/Public/PhysicsControlComponent.h
Include #include "PhysicsControlComponent.h"

Syntax

UCLASS (Meta=(BlueprintSpawnableComponent), ClassGroup=Physics, Experimental)  
class UPhysicsControlComponent : public USceneComponent

Remarks

This is the main Physics Control Component class which manages Controls and Body Modifiers associated with one or more static or skeletal meshes. You can add this as a component to an actor containing a mesh and then use it to create, configure and destroy Controls/Body Modifiers:

Controls are used to control one physics body relative to another (or the world). These controls are done through physical spring/damper drives.

Body Modifiers are used to update the most important physical properties of physics bodies such as whether they are simulated vs kinematic, or whether they experience gravity.

Note that Controls and Body Modifiers are given names (which are predictable). These names can then be stored (perhaps in arrays) to make it easy to quickly change multiple Controls/Body Modifiers.

Variables

  Type Name Description
Protected variable TMap< FName, FPhysicsBodyModifierRecord > BodyModifierRecords  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowDebugBodyModifierList Display all the body modifiers and their basic properties when this component is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowDebugControlList Display all the controls and their basic properties when this component is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowDebugVisualization Visualize the controls when this component is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWarnAboutInvalidNames Warn if an an invalid control or body modifier name is used.
Protected variable TMap< TWeakObjectPtr< USkeletalMeshComponent >, UE::PhysicsControl::FPhysicsControlPoseData > CachedPoseDatas Cached transforms from each skeletal mesh we're working with.
Protected variable TMap< FName, FPhysicsControlRecord > ControlRecords  
Protected variable FGraphTraversalCounter CurrentUpdateCounter Update counter - incremented every tick, and used to check whether previous targets etc are valid when calculating velocities.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString DebugBodyModifierDetailFilter Display detailed info for body modifiers containing this string (if non-empty) when this component is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString DebugControlDetailFilter Display detailed info for controls containing this string (if non-empty) when this component is selected
Public variable UProperty Category, EditAnywhere BlueprintReadWrite int32 MaxNumControlsOrModifiersPerName Upper limit on the number of controls or modifiers that will be created using the same name (which will get a numerical postfix).
Protected variable TMap< TWeakObjectPtr< USkeletalMeshComponent >, FModifiedSkeletalMeshData > ModifiedSkeletalMeshDatas Track which skeletons have been affected by a body modifier - some settings get overridden and then need to be restored when the last body modifier is destroyed.
Protected variable FPhysicsControlNameRecords NameRecords Keep track of the names of everything we have created.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TSoftObjectPtr< UPhysicsControlAsset > PhysicsControlAsset Optional PhysicsControlAsset to use.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float TeleportDistanceThreshold If the component moves by more than this distance then it is treated as a teleport, which prevents velocities being used for a frame.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float TeleportRotationThreshold If the component rotates by more than this angle (in degrees) then it is treated as a teleport, which prevents velocities being used for a frame.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float VelocityPredictionTime The time used when "predicting" the target position/orientation.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float VisualizationSizeScale Size of the gizmos etc used during visualization

Constructors

  Type Name Description
Public function  

UPhysicsControlComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

AddBodyModifiersToSet ( FPhysicsControlNames& NewSet,
const TArray< FName >& BodyModifiers,
const FName Set
)

 Adds BodyModifiers to a Set.
Public function UFunction BlueprintCallable, Category void

AddBodyModifierToSet ( FPhysicsControlNames& NewSet,
const FName BodyModifier,
const FName Set
)

 Adds a BodyModifier to a Set.
Public function UFunction BlueprintCallable, Category void

AddControlsToSet ( FPhysicsControlNames& NewSet,
const TArray< FName >& Controls,
const FName Set
)

 Adds Controls to a Set.
Public function UFunction BlueprintCallable, Category void

AddControlToSet ( FPhysicsControlNames& NewSet,
const FName Control,
const FName Set
)

 Adds a Control to a Set.
Protected function void

AddSkeletalMeshReferenceForCaching ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Starts caching skeletal mesh poses, and registers for a tick pre-requisite
Protected function void

AddSkeletalMeshReferenceForModifier ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Records that a modifier is working with the skeletal mesh and stores original data if necessary
Protected function void Updates the body based on the modifier
Protected function void Update the constraint based on the record.
Protected function void Applies the updates to controls and body modifiers
Protected function bool

ApplyControlStrengths ( FPhysicsControlRecord& Record,
FConstraintInstance* ConstraintInstance
)

 Updates the constraint strengths.
Protected function Const void This will set the kinematic target for the appropriate body based on the weighted target position and orientation (and whether any were found) for any controls that are related to the body modifier.
Protected function Virtual void  
Protected function Const void

CalculateControlTargetData ( FTransform& OutTargetTM,
FTransform& OutSkeletalTargetTM,
FVector& OutTargetVelocity,
FVector& OutTargetAngularVelocity,
const FPhysicsControlRecord& Record,
bool bUsePreviousSkeletalTargetTM
)

 Calculates the Target TM and velocities that will get passed to the constraint - so this is a target that is defined in the space of the parent body (or in world space, if it doesn't exist).
Public function UFunction BlueprintCallable, Category FName

CreateBodyModifier ( UPrimitiveComponent* Component,
const FName BoneName,
const FName Set,
const FPhysicsControlModifierData BodyModifierData
)

 Creates a new body modifier for mesh components
Public function UFunction BlueprintCallable, Category TMap< FName, FPhysicsControlNames >

CreateBodyModifiersFromLimbBones ( FPhysicsControlNames& AllBodyModifiers,
const TMap< FName, FPhysicsControlLimbBones >& LimbBones,
const FPhysicsControlModifierData BodyModifierData
)

 Creates a collection of controls controlling a skeletal mesh, grouped together in limbs
Public function UFunction BlueprintCallable, Category TArray< FName >

CreateBodyModifiersFromSkeletalMeshBelow ( USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName,
const bool bIncludeSelf,
const FName Set,
const FPhysicsControlModifierData BodyModifierData
)

 Creates new body modifiers for skeletal mesh components
Public function UFunction BlueprintCallable, Category FName

CreateControl ( UPrimitiveComponent* ParentComponent,
FName ParentBoneName,
UPrimitiveComponent* ChildComponent,
const FName ChildBoneName,
const FPhysicsControlData ControlData,
const FPhysicsControlTarget ControlTarget,
FName Set,
FString NamePrefix
)

 Creates a new control for mesh components
Public function UFunction BlueprintCallable, Category, Meta bool

CreateControlsAndBodyModifiersFromLimbBones ( FPhysicsControlNames& AllWorldSpaceControls,
TMap< FName, FPhysicsControlNames >& LimbWorldSpaceControls,
FPhysicsControlNames& AllParentSpaceControls,
TMap< FName, FPhysicsControlNames >& LimbParentSpaceControls,
FPhysicsControlNames& AllBodyModifiers,
TMap< FName, FPhysicsControlNames >& LimbBodyModifiers,
USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FPhysicsControlLimbSetupData >& LimbSetupData,
const FPhysicsControlData WorldSpaceControlData,
const FPhysicsControlData ParentSpaceControlData,
const FPhysicsControlModifierData BodyModifierData,
UPrimitiveComponent* WorldComponent,
FName WorldBoneName
)

 Creates a collections of controls and body modifiers for a character, based on the description passed in.
Public function UFunction BlueprintCallable, Category, Meta bool

CreateControlsAndBodyModifiersFromPhysicsControlAsset ( USkeletalMeshComponent* SkeletalMeshComponent,
UPrimitiveComponent* WorldComponent,
FName WorldBoneName
)

 This uses the control profile asset (that should have already been assigned in our data) to create controls and body modifiers.
Public function UFunction BlueprintCallable, Category TMap< FName, FPhysicsControlNames >

CreateControlsFromLimbBones ( FPhysicsControlNames& AllControls,
const TMap< FName, FPhysicsControlLimbBones >& LimbBones,
const EPhysicsControlType ControlType,
const FPhysicsControlData ControlData,
UPrimitiveComponent* WorldComponent,
FName WorldBoneName,
FString NamePrefix
)

 Creates a collection of controls controlling a skeletal mesh, grouped together in limbs
Public function UFunction BlueprintCallable, Category TMap< FName, FPhysicsControlNames >

CreateControlsFromLimbBonesAndConstraintProfile ( FPhysicsControlNames& AllControls,
const TMap< FName, FPhysicsControlLimbBones >& LimbBones,
const FName ConstraintProfile,
const bool bEnabled
)

 Creates a collection of ParentSpace controls controlling a skeletal mesh, grouped together in limbs, initializing them with a constraint profile
Public function UFunction BlueprintCallable, Category TArray< FName >

CreateControlsFromSkeletalMesh ( USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FName >& BoneNames,
const EPhysicsControlType ControlType,
const FPhysicsControlData ControlData,
const FName Set
)

 Creates a collection of controls controlling a skeletal mesh
Public function UFunction BlueprintCallable, Category TArray< FName >

CreateControlsFromSkeletalMeshAndConstraintProfile ( USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FName >& BoneNames,
const FName ConstraintProfile,
const FName Set,
const bool bEnabled
)

 Creates a collection of ParentSpace controls controlling a skeletal mesh, initializing them with a constraint profile
Public function UFunction BlueprintCallable, Category TArray< FName >

CreateControlsFromSkeletalMeshAndConstraintProfileBelow ( USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName,
const bool bIncludeSelf,
const FName ConstraintProfile,
const FName Set,
const bool bEnabled
)

 Creates a collection of ParentSpace controls controlling a skeletal mesh, initializing them with a constraint profile
Public function UFunction BlueprintCallable, Category TArray< FName >

CreateControlsFromSkeletalMeshBelow ( USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName,
const bool bIncludeSelf,
const EPhysicsControlType ControlType,
const FPhysicsControlData ControlData,
const FName Set
)

 Creates a collection of controls controlling a skeletal mesh
Public function UFunction BlueprintCallable, Category, Meta bool

CreateNamedBodyModifier ( const FName Name,
UPrimitiveComponent* Component,
const FName BoneName,
const FName Set,
const FPhysicsControlModifierData BodyModifierData
)

 Creates a new body modifier for mesh components
Public function UFunction BlueprintCallable, Category, Meta bool

CreateNamedControl ( FName Name,
UPrimitiveComponent* ParentComponent,
const FName ParentBoneName,
UPrimitiveComponent* ChildComponent,
const FName ChildBoneName,
const FPhysicsControlData ControlData,
const FPhysicsControlTarget ControlTarget,
const FName Set
)

 Creates a new control for mesh components
Public function Virtual Const void

DebugDraw ( FPrimitiveDrawInterface* PDI
)

 Used by the component visualizer.
Public function Virtual Const void

DebugDrawControl ( FPrimitiveDrawInterface* PDI,
const FPhysicsControlRecord& Record,
const FName ControlName
)

  
Public function UFunction BlueprintCallable, Category void Destroys all controls and body modifiers
Public function UFunction BlueprintCallable, Category, Meta bool

DestroyBodyModifier ( const FName Name
)

 Destroys a BodyModifier
Protected function bool

DestroyBodyModifier ( const FName Name,
const EDestroyBehavior DestroyBehavior
)

 Destroys the modifier. It will optionally be removed from the array of records too
Public function UFunction BlueprintCallable, Category void

DestroyBodyModifiers ( const TArray< FName >& Names
)

 Destroys BodyModifiers
Public function UFunction BlueprintCallable, Category void

DestroyBodyModifiersInSet ( const FName Set
)

 Destroys BodyModifiers
Public function UFunction BlueprintCallable, Category, Meta bool

DestroyControl ( const FName Name
)

 Destroys a control
Protected function bool

DestroyControl ( const FName Name,
const EDestroyBehavior DestroyBehavior
)

 Destroys the control. It will optionally be removed from the array of records too
Public function UFunction BlueprintCallable, Category void

DestroyControls ( const TArray< FName >& Names
)

 Destroys all controls
Public function UFunction BlueprintCallable, Category void

DestroyControlsInSet ( const FName Set
)

 Destroys all controls in a set
Protected function void Terminates everything we have made in physics.
Protected function Const const FPhysicsBodyModifierRecord *

FindBodyModifierRecord ( const FName Name
)

  
Protected function FPhysicsBodyModifierRecord *

FindBodyModifierRecord ( const FName Name
)

 Retrieves the body modifier for the name.
Protected function Const const FPhysicsControl *

FindControl ( const FName Name
)

  
Protected function FPhysicsControl *

FindControl ( const FName Name
)

 Retrieves the control for the name. Returns a null pointer if the name cannot be found
Protected function FPhysicsControlRecord *

FindControlRecord ( const FName Name
)

 Retrieves the control record for the name. Returns a null pointer if the name cannot be found
Protected function Const const FPhysicsControlRecord *

FindControlRecord ( const FName Name
)

  
Public function Const UFunction BlueprintCallable, Category const TArray< FName > & Returns a reference to all the body modifier names that have been created.
Public function Const UFunction BlueprintCallable, Category const TArray< FName > & Returns a reference to all the control names that have been created.
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetBodyModifierExists ( const FName Name
)

 Indicates if a body modifier with the name exists (doesn't produce a warning if it doesn't)
Public function Const UFunction BlueprintCallable, Category const TArray< FName > &

GetBodyModifierNamesInSet ( const FName Set
)

 Returns a reference to all the body modifier names that have been created and are in the specified set, which could be a limb, or a subsequently created set.
Protected function Const bool

GetBoneData ( UE::PhysicsControl::FBoneData& OutBoneData,
const UE::PhysicsControl::FPhysicsControlPoseData*& OutPoseData,
const USkeletalMeshComponent* InSkeletalMeshComponent,
const FName InBoneName
)

 Retrieves the bone data for the specified bone given the skeletal mesh component.
Public function UFunction BlueprintCallable, Category FRotator

GetCachedBoneOrientation ( const USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName
)

 Gets the orientation of the requested bone that will be used as a target (in world space).
Public function UFunction BlueprintCallable, Category TArray< FRotator >

GetCachedBoneOrientations ( const USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FName >& BoneNames
)

 Gets the orientations of the requested bones that will be used as targets (in world space).
Public function UFunction BlueprintCallable, Category FVector

GetCachedBonePosition ( const USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName
)

 Gets the position of the requested bone that will be used as a target (in world space).
Public function UFunction BlueprintCallable, Category TArray< FVector >

GetCachedBonePositions ( const USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FName >& BoneNames
)

 Gets the positions of the requested bones that will be used as targets (in world space).
Public function UFunction BlueprintCallable, Category FTransform

GetCachedBoneTransform ( const USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName
)

 Gets the transforms of the requested bone that will be used as a target (in world space).
Public function UFunction BlueprintCallable, Category TArray< FTransform >

GetCachedBoneTransforms ( const USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FName >& BoneNames
)

 Gets the transforms of the requested bones that will be used as targets (in world space).
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetControlData ( const FName Name,
FPhysicsControlData& ControlData
)

  
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetControlEnabled ( const FName Name
)

  
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetControlExists ( const FName Name
)

 Indicates if a control with the name exists (doesn't produce a warning if it doesn't)
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetControlMultiplier ( const FName Name,
FPhysicsControlMultiplier& ControlMultiplier
)

  
Public function Const UFunction BlueprintCallable, Category const TArray< FName > &

GetControlNamesInSet ( const FName Set
)

 Returns a reference to all the control names that have been created and are in the specified set, which could be a limb, or a subsequently created set.
Public function Const UFunction BlueprintCallable, Category, Meta bool

GetControlTarget ( const FName Name,
FPhysicsControlTarget& ControlTarget
)

  
Public function Const UFunction BlueprintCallable, Category TMap< FName, FPhysicsControlLimbBones >

GetLimbBonesFromSkeletalMesh ( USkeletalMeshComponent* SkeletalMeshComponent,
const TArray< FPhysicsControlLimbSetupData >& LimbSetupData
)

 Calculates which bones belong to which limb in a skeletal mesh
Protected function bool

GetModifiableBoneData ( UE::PhysicsControl::FBoneData*& OutBoneData,
const USkeletalMeshComponent* InSkeletalMeshComponent,
const FName InBoneName
)

 Retrieves the bone data for the specified bone given the skeletal mesh component, for modification
Public function Const UFunction BlueprintCallable, Category TArray< FName >

GetSetsContainingBodyModifier ( const FName Control
)

 Returns the names of all sets containing the body modifier (may be empty - e.g. if it doesn't exist)
Public function Const UFunction BlueprintCallable, Category TArray< FName >

GetSetsContainingControl ( const FName Control
)

 Returns the names of all sets containing the control (may be empty - e.g. if it doesn't exist)
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category, Meta bool

InvokeControlProfile ( FName ProfileName
)

 Looks up the profile which should exist in the registered control profile asset, and invokes it.
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Protected function bool

RemoveSkeletalMeshReferenceForCaching ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Stops caching skeletal mesh poses (if this is the last one), and deregisters for a tick pre-requisite.
Protected function bool

RemoveSkeletalMeshReferenceForModifier ( USkeletalMeshComponent* SkeletalMeshComponent
)

 Records that a modifier has stopped working with the skeletal mesh and restores original data if necessary.
Public function UFunction BlueprintCallable, Category void Calls ResetBodyModifierToCachedTarget for each of the body modifiers in the set
Public function UFunction BlueprintCallable, Category void

ResetBodyModifiersToCachedBoneTransforms ( const TArray< FName >& Names,
const EResetToCachedTargetBehavior Behavior
)

 Calls ResetBodyModifierToCachedTarget for each of the body modifiers
Public function UFunction BlueprintCallable, Category, Meta bool This flags the body associated with the modifier to set (using teleport) its position and velocity to the cached animation target.
Public function UFunction BlueprintCallable, Category, Meta bool

ResetControlPoint ( const FName Name
)

 Resets the control point to the center of mass of the mesh
Protected function void

ResetControls ( bool bKeepControlRecords
)

 Terminates the underlying physical constraints, resets our internal stored state for each control, and optionally deletes all record of the controls.
Protected function Const void Sets the body (simulated or kinematic) to have the position/velocity etc state that has been cached.
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierCollisionType ( const FName Name,
const ECollisionEnabled::Type CollisionType
)

 Sets the collision type for a body modifier
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierData ( const FName Name,
const FPhysicsControlModifierData ModifierData
)

 Modifies an existing Body Modifier Data
Public function UFunction BlueprintCallable, Category void

SetBodyModifierDatas ( const TArray< FName >& Names,
const FPhysicsControlModifierData ModifierData
)

 Modifies existing Body Modifier Data
Public function UFunction BlueprintCallable, Category void

SetBodyModifierDatasInSet ( const FName Set,
const FPhysicsControlModifierData ModifierData
)

 Modifies existing Body Modifier Data
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierGravityMultiplier ( const FName Name,
const float GravityMultiplier
)

 Sets the gravity multiplier for a body modifier
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierKinematicTarget ( const FName Name,
const FVector KinematicTargetPosition,
const FRotator KinematicTargetOrienation,
const bool bMakeKinematic
)

 Sets the kinematic target transform for a body modifier.
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierMovementType ( const FName Name,
const EPhysicsMovementType MovementType
)

 Sets the movement type for a body modifier
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierPhysicsBlendWeight ( const FName Name,
const float PhysicsBlendWeight
)

 Sets the physics blend weight for a body modifier
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersCollisionType ( const TArray< FName >& Names,
const ECollisionEnabled::Type CollisionType
)

 Sets the collision type for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersGravityMultiplier ( const TArray< FName >& Names,
const float GravityMultiplier
)

 Sets the gravity multiplier for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetCollisionType ( const FName Set,
const ECollisionEnabled::Type CollisionType
)

 Sets the collision type for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetGravityMultiplier ( const FName Set,
const float GravityMultiplier
)

 Sets the gravity multiplier for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetMovementType ( const FName Set,
const EPhysicsMovementType MovementType
)

 Sets the movement type for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetPhysicsBlendWeight ( const FName Set,
const float PhysicsBlendWeight
)

 Sets the physics blend weight for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetUpdateKinematicFromSimulation ( const FName Set,
const bool bUpdateKinematicFromSimulation
)

 Sets whether body modifiers should update kinematics from the simulation results
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersInSetUseSkeletalAnimation ( const FName Set,
const bool bUseSkeletalAnimation
)

 Sets whether body modifiers should use skeletal animation for their kinematic targets
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersMovementType ( const TArray< FName >& Names,
const EPhysicsMovementType MovementType
)

 Sets the movement type for body modifiers
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierSparseData ( const FName Name,
const FPhysicsControlModifierSparseData ModifierData
)

 Modifies an existing Body Modifier Data
Public function UFunction BlueprintCallable, Category void

SetBodyModifierSparseDatas ( const TArray< FName >& Names,
const FPhysicsControlModifierSparseData ModifierData
)

 Modifies existing Body Modifier Data
Public function UFunction BlueprintCallable, Category void

SetBodyModifierSparseDatasInSet ( const FName Set,
const FPhysicsControlModifierSparseData ModifierData
)

 Modifies existing Body Modifier Data
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersPhysicsBlendWeight ( const TArray< FName >& Names,
const float PhysicsBlendWeight
)

 Sets the physics blend weight for body modifiers
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersUpdateKinematicFromSimulation ( const TArray< FName >& Names,
const bool bUpdateKinematicFromSimulation
)

 Sets whether body modifiers should update kinematics from the simulation results
Public function UFunction BlueprintCallable, Category void

SetBodyModifiersUseSkeletalAnimation ( const TArray< FName >& Names,
const bool bUseSkeletalAnimation
)

 Sets whether body modifiers should use skeletal animation for their kinematic targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierUpdateKinematicFromSimulation ( const FName Name,
const bool bUpdateKinematicFromSimulation
)

 Sets whether a body modifier should update kinematics from the simulation results
Public function UFunction BlueprintCallable, Category, Meta bool

SetBodyModifierUseSkeletalAnimation ( const FName Name,
const bool bUseSkeletalAnimation
)

 Sets whether a body modifier should use skeletal animation for its kinematic targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetCachedBoneData ( const USkeletalMeshComponent* SkeletalMeshComponent,
const FName BoneName,
const FTransform& TM
)

 This allows the caller to override the target that will have been calculated and cached at the start of the Physics Control Component update.
Public function UFunction BlueprintCallable, Category void This sets cached bone velocities to zero, by forgetting any previously used transform.
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlAngularData ( const FName Name,
const float Strength,
const float DampingRatio,
const float ExtraDamping,
const float MaxTorque,
const bool bEnableControl
)

 Modifies an existing control's angular data - i.e. the strengths etc of the control driving towards the target
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlData ( const FName Name,
const FPhysicsControlData ControlData
)

 Modifies an existing control data - i.e. the strengths etc of the control driving towards the target
Public function UFunction BlueprintCallable, Category void

SetControlDatas ( const TArray< FName >& Names,
const FPhysicsControlData ControlData
)

 Modifies existing control data - i.e. the strengths etc of the controls driving towards the targets
Public function UFunction BlueprintCallable, Category void

SetControlDatasInSet ( const FName Set,
const FPhysicsControlData ControlData
)

 Modifies existing control data - i.e. the strengths etc of the controls driving towards the targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlDisableCollision ( const FName Name,
const bool bDisableCollision
)

  
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlEnabled ( const FName Name,
const bool bEnable
)

 Activates or deactivates a control
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlLinearData ( const FName Name,
const float Strength,
const float DampingRatio,
const float ExtraDamping,
const float MaxForce,
const bool bEnableControl
)

 Modifies an existing control's linear data - i.e. the strengths etc of the control driving towards the target
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlMultiplier ( const FName Name,
const FPhysicsControlMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies an existing control data using the multipliers
Public function UFunction BlueprintCallable, Category void

SetControlMultipliers ( const TArray< FName >& Names,
const FPhysicsControlMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies existing control data using the multipliers
Public function UFunction BlueprintCallable, Category void

SetControlMultipliersInSet ( const FName Set,
const FPhysicsControlMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies existing control data using the multipliers
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlParent ( const FName Name,
UPrimitiveComponent* ParentComponent,
const FName ParentBoneName
)

 Updates the parent object part of a control.
Public function UFunction BlueprintCallable, Category void

SetControlParents ( const TArray< FName >& Names,
UPrimitiveComponent* ParentComponent,
const FName ParentBoneName
)

 Updates the parent object part of controls.
Public function UFunction BlueprintCallable, Category void

SetControlParentsInSet ( const FName Set,
UPrimitiveComponent* ParentComponent,
const FName ParentBoneName
)

  
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlPoint ( const FName Name,
const FVector Position
)

 Sets the point at which controls will "push" the child object.
Public function UFunction BlueprintCallable, Category void

SetControlsDisableCollision ( const TArray< FName >& Names,
const bool bDisableCollision
)

  
Public function UFunction BlueprintCallable, Category void

SetControlsEnabled ( const TArray< FName >& Names,
const bool bEnable
)

 Activates or deactivates controls
Public function UFunction BlueprintCallable, Category void

SetControlsInSetDisableCollision ( const FName Set,
const bool bDisableCollision
)

  
Public function UFunction BlueprintCallable, Category void

SetControlsInSetEnabled ( const FName Set,
const bool bEnable
)

 Activates or deactivates controls
Public function UFunction BlueprintCallable, Category void

SetControlsInSetUseSkeletalAnimation ( const FName Set,
const bool bUseSkeletalAnimation,
const float SkeletalAnimationVelocityMultiplier
)

 Sets whether or not the controls should use skeletal animation for the targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlSparseData ( const FName Name,
const FPhysicsControlSparseData ControlData
)

 Modifies an existing control data - i.e. the strengths etc of the control driving towards the target
Public function UFunction BlueprintCallable, Category void

SetControlSparseDatas ( const TArray< FName >& Names,
const FPhysicsControlSparseData ControlData
)

 Modifies existing control data - i.e. the strengths etc of the controls driving towards the targets
Public function UFunction BlueprintCallable, Category void

SetControlSparseDatasInSet ( const FName Set,
const FPhysicsControlSparseData ControlData
)

 Modifies existing control data - i.e. the strengths etc of the controls driving towards the targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlSparseMultiplier ( const FName Name,
const FPhysicsControlSparseMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies an existing control data using the multipliers
Public function UFunction BlueprintCallable, Category void

SetControlSparseMultipliers ( const TArray< FName >& Names,
const FPhysicsControlSparseMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies existing control data using the multipliers
Public function UFunction BlueprintCallable, Category void

SetControlSparseMultipliersInSet ( const FName Set,
const FPhysicsControlSparseMultiplier ControlMultiplier,
const bool bEnableControl
)

 Modifies existing control data using the multipliers
Public function UFunction BlueprintCallable, Category void

SetControlsUseSkeletalAnimation ( const TArray< FName >& Names,
const bool bUseSkeletalAnimation,
const float SkeletalAnimationVelocityMultiplier
)

 Sets whether or not the controls should use skeletal animation for the targets
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTarget ( const FName Name,
const FPhysicsControlTarget ControlTarget,
const bool bEnableControl
)

 Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetOrientation ( const FName Name,
const FRotator Orientation,
const float AngularVelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
Public function UFunction BlueprintCallable, Category void

SetControlTargetOrientations ( const TArray< FName >& Names,
const FRotator Orientation,
const float AngularVelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetOrientation for each of the control names
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetOrientationsFromArray ( const TArray< FName >& Names,
const TArray< FRotator >& Orientations,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPosition for each element of the control names and positions.
Public function UFunction BlueprintCallable, Category void

SetControlTargetOrientationsInSet ( const FName SetName,
const FRotator Orientation,
const float AngularVelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetOrientation for each of the controls in the set
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetPoses ( const FName Name,
const FVector ParentPosition,
const FRotator ParentOrientation,
const FVector ChildPosition,
const FRotator ChildOrientation,
const float VelocityDeltaTime,
const bool bEnableControl
)

 Calculates and sets an existing control target.
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetPosition ( const FName Name,
const FVector Position,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetPositionAndOrientation ( const FName Name,
const FVector Position,
const FRotator Orientation,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Modifies an existing control target - i.e. what it is driving towards, relative to the parent object
Public function UFunction BlueprintCallable, Category void

SetControlTargetPositions ( const TArray< FName >& Names,
const FVector Position,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPosition for each of the control names
Public function UFunction BlueprintCallable, Category void

SetControlTargetPositionsAndOrientations ( const TArray< FName >& Names,
const FVector Position,
const FRotator Orientation,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPositionAndOrientation for each of the control names
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetPositionsAndOrientationsFromArray ( const TArray< FName >& Names,
const TArray< FVector >& Positions,
const TArray< FRotator >& Orientations,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPositionAndOrientation for each element of the control names, positions and orientations.
Public function UFunction BlueprintCallable, Category void

SetControlTargetPositionsAndOrientationsInSet ( const FName SetName,
const FVector Position,
const FRotator Orientation,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPositionAndOrientation for each control in the set
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlTargetPositionsFromArray ( const TArray< FName >& Names,
const TArray< FVector >& Positions,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPosition for each element of the control names and positions.
Public function UFunction BlueprintCallable, Category void

SetControlTargetPositionsInSet ( const FName SetName,
const FVector Position,
const float VelocityDeltaTime,
const bool bEnableControl,
const bool bApplyControlPointToTarget
)

 Calls SetControlTargetPosition for each of the controls in the set
Public function UFunction BlueprintCallable, Category void

SetControlTargets ( const TArray< FName >& Names,
const FPhysicsControlTarget ControlTarget,
const bool bEnableControl
)

 Modifies existing control targets - i.e. what they are driving towards, relative to the parent objects
Public function UFunction BlueprintCallable, Category void

SetControlTargetsInSet ( const FName Set,
const FPhysicsControlTarget ControlTarget,
const bool bEnableControl
)

 Modifies existing control targets - i.e. what they are driving towards, relative to the parent objects
Public function UFunction BlueprintCallable, Category, Meta bool

SetControlUseSkeletalAnimation ( const FName Name,
const bool bUseSkeletalAnimation,
const float SkeletalAnimationVelocityMultiplier
)

 Sets whether or not the control should use skeletal animation for the targets
Public function Virtual Const bool  
Protected function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  
Protected function void

UpdateCachedSkeletalBoneData ( float DeltaTime
)

 Updates the world-space bone positions etc for each skeleton we're tracking
Public function UFunction BlueprintCallable, Category void

UpdateControls ( float DeltaTime
)

 Allows manual ticking so that your code can run in between updating the target caches and updating the controls and body modifiers.
Public function UFunction BlueprintCallable, Category void

UpdateTargetCaches ( float DeltaTime
)

 Allows manual ticking so that your code can run in between updating the target caches and updating the controls.

Enums

  Type Name Description
Protected enum EDestroyBehavior When destroying a control or modifier, the record will normally be removed, but it can be retained if you will subsequently update the records  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page