1. Epic GamesDeveloper
  3. FAnimNode_RigidBodyWithControl

FAnimNode_RigidBodyWithControl

Controller that simulates physics based on the physics asset of the skeletal mesh component

API > API/Plugins > API/Plugins/PhysicsControl

Inheritance Hierarchy

  • FAnimNode_SkeletalControlBase
  • FAnimNode_RigidBodyWithControl

References

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

Syntax

USTRUCT ()  
struct FAnimNode_RigidBodyWithControl : public FAnimNode_SkeletalControlBase

Remarks

Controller that simulates physics based on the physics asset of the skeletal mesh component

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlAndBodyModifierCreationDatas AdditionalControlsAndBodyModifiers Controls and modifiers that should be created, in addition to those made as part of the limb setup.
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlSetUpdates AdditionalSets Allows additional sets of controls or modifiers to be created, and existing sets to be modified
Public variable UProperty Category, EditAnywhere FBoneReference BaseBoneRef Matters if SimulationSpace is BaseBone
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bCalculateVelocitiesForWorldGeometry Whether or not to calculate velocities for world geometry.
Public variable UProperty Category, EditAnywhere bool bDefaultToSkeletalMeshPhysicsAsset Use the skeletal mesh physics asset as default in case set to True.
Public variable UProperty Category, EditAnywhere, Meta bool bEnableCharacterSetupData  
Public variable UProperty Category, EditAnywhere, Meta bool bEnableControls If false, then controls will not be created.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bEnableWorldGeometry  
Public variable UProperty Category, EditAnywhere uint8: 1 bForceDisableCollisionBetweenConstraintBodies Whether to allow collisions between two bodies joined by a constraint
Public variable UProperty Category, EditAnywhere uint8: 1 bFreezeIncomingPoseOnStart When simulation starts, freeze incoming pose.
Public variable UProperty Category, EditAnywhere uint8: 1 bMakeKinematicConstraints If true, constraints will be made even when both objects are kinematic, in case they are subsequently made dynamic.
Public variable UProperty Category, EditAnywhere, Meta TMap< FName, FName > BoneToBodyNameMap A map of bone names to "body" names, the latter being used to assign names to controls/modifiers.
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bOverrideWorldGravity  
Public variable UProperty Category, EditAnywhere, Meta uint8: 1 bTransferBoneVelocities When simulation starts, transfer previous bone velocities (from animation) to make transition into simulation seamless.
Public variable UProperty Category, EditAnywhere, Meta bool bUpdateCacheEveryFrame This can be used to force the cached collision objects to be updated every frame, even when we are not moving.
Public variable UProperty Category, EditAnywhere uint8: 1 bUseExternalClothCollision If true, kinematic objects will be added to the simulation at runtime to represent any cloth colliders defined for the parent object.
Public variable UProperty Category, EditAnywhere, Meta float CachedBoundsScale Scale of cached bounds (vs. actual bounds) used for obtaining the list of objects we might collide with.
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlCharacterSetupData CharacterSetupData Setup data for creating the main controls (world- and parent-space) and modifiers, based on splitting the skeleton up into limbs.
Public variable UProperty Category, EditAnywhere FVector ComponentAppliedLinearAccClamp When using non-world-space sim, this is an overall clamp on acceleration derived from ComponentLinearAccScale and ComponentLinearVelScale, to ensure it is not too large.
Public variable UProperty Category, EditAnywhere, Meta FVector ComponentLinearAccScale When using non-world-space sim, this controls how much of the components world-space acceleration is passed on to the local-space simulation.
Public variable UProperty Category, EditAnywhere, Meta FVector ComponentLinearVelScale When using non-world-space sim, this applies a 'drag' to the bodies in the local space simulation, based on the components world-space velocity.
Public variable UProperty Category, EditAnywhere, Meta FName ConstraintProfile The constraint profile to use on all the joints in the physics asset.
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlControlAndModifierParameters ControlAndModifierParameters Controls that should be applied each frame, and can be expected to change.
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlControlAndModifierUpdates ControlAndModifierUpdates Updates to controls that can be applied. Note that these update the normal/original state.
Public variable UProperty Category, EditAnywhere, Meta FName ControlProfile The control profile to use.
Public variable UProperty Category, EditAnywhere, Meta FRigidBodyControlTargets ControlTargets Targets that should be applied to the controls.
Public variable UProperty Category, EditAnywhere float EvaluationResetTime If the node is not evaluated for this amount of time (seconds), either because a lower LOD was in use for a while or the component was not visible, reset the simulation to the default pose on the next evaluation.
Public variable UProperty Category, EditAnywhere, Meta FVector ExternalForce Applies a uniform external force in world space.
Public variable UProperty Category, EditAnywhere, Meta FPhysicsControlControlAndModifierParameters InitialControlAndBodyModifierUpdates An initial set of controls that should be applied immediately after setup.
Public variable UProperty Category, EditAnywhere, Meta FRigidBodyKinematicTargets KinematicTargets Targets that should be applied to kinematic bodies that are under the influence of a body modifier.
Public variable UProperty Category, EditAnywhere, Meta TEnumAsByte< ECollisionChannel > OverlapChannel The channel we use to find static geometry to collide with
Public variable UProperty Category, EditAnywhere TObjectPtr< UPhysicsAsset > OverridePhysicsAsset Physics asset to use.
Public variable UProperty Category, EditAnywhere, Meta FVector OverrideWorldGravity Override gravity
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< USkeletalMesh > PhysicsAssetAuthoredSkeletalMesh These options configure the way constraint transforms can be modified at runtime to match the current Skeletal Mesh.
Public variable UProperty Category, EditAnywhere, Meta MapConstraintsBehaviorType PhysicsAssetConditioningConstraintOrientation Configure the way constraint orientations can be modified at runtime to match the current Skeletal Mesh.
Public variable UProperty Category, EditAnywhere, Meta MapConstraintsBehaviorType PhysicsAssetConditioningConstraintPosition Configure the way constraint positions can be modified at runtime to match the current Skeletal Mesh.
Public variable UProperty Category, EditAnywhere TObjectPtr< UPhysicsControlAsset > PhysicsControlAsset Physics control asset to use.
Public variable UProperty Category, EditAnywhere, Meta FSimSpaceSettings SimSpaceSettings Settings for the system which passes motion of the simulation's space into the simulation.
Public variable UProperty Category, EditAnywhere ESimulationSpace SimulationSpace What space to simulate the bodies in. This affects how velocities are generated
Public variable UProperty Category, EditAnywhere, AdvancedDisplay ESimulationTiming SimulationTiming Whether the physics simulation runs synchronously with the node's evaluation or is run in the background until the next frame.
Public variable UProperty Category, EditAnywhere float WorldSpaceMinimumScale For world-space simulations, if the magnitude of the component's 3D scale is less than WorldSpaceMinimumScale, do not update the node.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void

AddImpulseAtLocation ( FVector Impulse,
FVector Location,
FName BoneName
)

  
Public function FName

CreateBodyModifier ( const FName BoneName,
const FPhysicsControlModifierData& ModifierData
)

  
Public function FName

CreateControl ( const FName ParentBoneName,
const FName ChildBoneName,
const FPhysicsControlData& ControlData
)

  
Public function bool

CreateNamedBodyModifier ( const FName ModifierName,
const FName BoneName,
const FPhysicsControlModifierData& ModifierData
)

  
Public function bool

CreateNamedControl ( const FName ControlName,
const FName ParentBoneName,
const FName ChildBoneName,
const FPhysicsControlData& ControlData
)

  
Public function Virtual void

EvaluateComponentPose_AnyThread ( FComponentSpacePoseContext& Output
)

  
Public function Virtual void

EvaluateSkeletalControl_AnyThread ( FComponentSpacePoseContext& Output,
TArray< FBoneTransform >& OutBoneTransforms
)

  
Public function Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  
Public function Const const FTransform

GetBodyTransform ( const int32 BodyIndex
)

  
Public function Virtual Const int32  
Public function Const const FPhysicsControlNameRecords &  
Public function Const const int32  
Public function Const UPhysicsAsset *  
Public function Virtual ImmediatePhysics::FSimulation * TEMP: Exposed for use in PhAT as a quick way to get drag handles working with Chaos.
Public function Virtual Const bool  
Public function Virtual void

Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

  
Public function void

InvokeControlProfile ( FName ControlProfileName
)

 Invoke the profile stored in the control profile asset, and sets the current profile.
Public function Virtual bool

IsValidToEvaluate ( const USkeleton* Skeleton,
const FBoneContainer& RequiredBones
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnInitializeAnimInstance ( const FAnimInstanceProxy* InProxy,
const UAnimInstance* InAnimInstance
)

  
Public function void

PostSerialize ( const FArchive& Ar
)

  
Public function Virtual void

PreUpdate ( const UAnimInstance* InAnimInstance
)

  
Public function Virtual void

ResetDynamics ( ETeleportType InTeleportType
)

  
Public function void

SetOverridePhysicsAsset ( UPhysicsAsset* PhysicsAsset
)

 Set the override physics asset.
Public function Virtual void

UpdateComponentPose_AnyThread ( const FAnimationUpdateContext& Context
)

  
Public function Virtual void

UpdateInternal ( const FAnimationUpdateContext& Context
)

  

Deprecated Variables

  Type Name Description
Public variable UProperty uint8: 1 bModifyConstraintTransformsToMatchSkeleton_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page