1. Epic GamesDeveloper
  3. FAnimNode_RigidBody

FAnimNode_RigidBody

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

Unreal Engine C++ API Reference > Runtime > AnimGraphRuntime > BoneControllers

Inheritance Hierarchy

References

   
Module AnimGraphRuntime
Header /Engine/Source/Runtime/AnimGraphRuntime/Public/BoneControllers/AnimNode_RigidBody.h
Include #include "BoneControllers/AnimNode_RigidBody.h"

Syntax

USTRUCT ()  
struct FAnimNode_RigidBody : 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 FBoneReference BaseBoneRef Matters if SimulationSpace is BaseBone
Public variable UProperty Category, EditAnywhere uint8: 1 bClampLinearTranslationLimitToRefPose Correct for linear tearing on bodies with all axes Locked.
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 uint8: 1 bEnableWorldGeometry  
Public variable UProperty Category, EditAnywhere bool 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, 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 bool 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 BlueprintReadWrite bool bUseLocalLODThresholdOnly Enable if you want to ignore the p.RigidBodyLODThreshold CVAR and force the node to solely use the LOD threshold.
Public variable UProperty Category, EditAnywhere, Meta float CachedBoundsScale Scale of cached bounds (vs. actual bounds).
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 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 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 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 Virtual void

GatherDebugData ( FNodeDebugData& DebugData
)

  
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 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.

Overridden from FAnimNode_SkeletalControlBase

  Type Name Description
Public function Virtual void

EvaluateComponentPose_AnyThread ( FComponentSpacePoseContext& Output
)

 Evaluate incoming component pose.
Public function Virtual void

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

 Evaluate the new component-space transforms for the affected bones.
Public function Virtual Const int32  
Public function Virtual void

Initialize_AnyThread ( const FAnimationInitializeContext& Context
)

  
Public function Virtual bool

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

 Return true if it is valid to Evaluate
Public function Virtual void

UpdateComponentPose_AnyThread ( const FAnimationUpdateContext& Context
)

 Update incoming component pose.
Public function Virtual void

UpdateInternal ( const FAnimationUpdateContext& Context
)

 Interface for derived skeletal controls to implement use this function to update for skeletal control base

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page