1. Epic GamesDeveloper
  3. UPhysicsAsset

UPhysicsAsset

PhysicsAsset contains a set of rigid bodies and constraints that make up a single ragdoll.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/PhysicsEngine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsAsset.h
Include #include "PhysicsEngine/PhysicsAsset.h"

Syntax

UCLASS (HideCategories=Object, BlueprintType, MinimalAPI, Config=Game, PerObjectConfig,  
       AutoCollapseCategories=(OldSolverSettings))  
class UPhysicsAsset :  
    public UObject ,  
    public IInterface_PreviewMeshProvider

Remarks

PhysicsAsset contains a set of rigid bodies and constraints that make up a single ragdoll. The asset is not limited to human ragdolls, and can be used for any physical simulation using bodies and constraints. A SkeletalMesh has a single PhysicsAsset, which allows for easily turning ragdoll physics on or off for many SkeletalMeshComponents The asset can be configured inside the Physics Asset Editor.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, AdvancedDisplay uint8: 1 bNotForDedicatedServer If true, we skip instancing bodies for this PhysicsAsset on dedicated servers
Public variable TMap< FName, int32 > BodySetupIndexMap This caches the BodySetup Index by BodyName to speed up FindBodyIndex
Public variable UProperty TArray< int32 > BoundsBodies Index of bodies that are marked bConsiderForBounds
Public variable TMap< FRigidBodyIndexPair, bool > CollisionDisableTable Table indicating which pairs of bodies have collision disabled between them.
Public variable UProperty Category, EditAnywhere, Meta TArray< FName > ConstraintProfiles  
Public variable UProperty instanced TArray< TObjectPtr< class UPhysicsConstraintTemplate > > ConstraintSetup Array of RB_ConstraintSetup objects.
Public variable UProperty Transient FName CurrentConstraintProfileName  
Public variable UProperty Transient FName CurrentPhysicalAnimationProfileName  
Public variable UProperty Category, EditAnywhere, Meta TArray< FName > PhysicalAnimationProfiles  
Public variable UProperty assetregistrysearchable TSoftObjectPtr< class USkeletalMesh > PreviewSkeletalMesh  
Public variable UProperty instanced TArray< TObjectPtr< USkeletalBodySetup > > SkeletalBodySetups Array of SkeletalBodySetup objects.
Public variable UProperty Category, Meta Config visibleanywhere FSolverIterations SolverIterations Old solver settings shown for reference.
Public variable UProperty Category, EditAnywhere Config FPhysicsAssetSolverSettings SolverSettings Solver settings when the asset is used with a RigidBody Anim Node (RBAN).
Public variable UProperty Category, EditAnywhere EPhysicsAssetSolverType SolverType Solver type used in physics asset editor.
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UThumbnailInfo > ThumbnailInfo Information for thumbnail rendering

Constructors

  Type Name Description
Public function  

UPhysicsAsset ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

BodyFindConstraints ( int32 BodyIndex,
TArray< int32 >& Constraints
)

 Find all the constraints that are connected to a particular body.
Public function Const FBox

CalcAABB ( const USkinnedMeshComponent* MeshComponent,
const FTransform& LocalToWorld
)

  
Public function Const bool

CanCalculateValidAABB ( const USkinnedMeshComponent* MeshComponent,
const FTransform& LocalToWorld
)

 Check if the Bounds can be calculate for the specified MeshComponent.
Public function void Clears physics meshes from all bodies
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function void

DisableCollision ( int32 BodyIndexA,
int32 BodyIndexB
)

 Disable collsion between the bodies specified by index.
Public function void

DrawConstraints ( int32 ViewIndex,
FMeshElementCollector& Collector,
const FReferenceSkeleton& RefSkeleton,
const TArray< FTransform >& SpaceBases,
const FTransform& LocalToWorld,
float Scale
)

  
Public function void

EnableCollision ( int32 BodyIndexA,
int32 BodyIndexB
)

 Enable collsion between the bodies specified by index.
Public function Const int32

FindBodyIndex ( FName BodyName
)

  
Public function Const FName

FindConstraintBoneName ( int32 ConstraintIndex
)

  
Public function Const int32

FindConstraintIndex ( FName Bone1Name,
FName Bone2Name
)

  
Public function Const int32

FindConstraintIndex ( FName ConstraintName
)

  
Public function Const int32

FindControllingBodyIndex ( const USkeletalMesh* skelMesh,
int32 BoneIndex
)

 Find the index of the physics bone that is controlling this graphics bone.
Public function Const int32

FindMirroredBone ( const USkeletalMesh* skelMesh,
int32 BoneIndex
)

  
Public function Const int32

FindParentBodyIndex ( const FReferenceSkeleton& RefSkeleton,
const int32 StartBoneIndex
)

  
Public function Const int32

FindParentBodyIndex ( const USkeletalMesh* skelMesh,
int32 StartBoneIndex
)

  
Public function Const void

GetBodyIndicesBelow ( TArray< int32 >& OutBodyIndices,
FName InBoneName,
const USkeletalMesh* InSkelMesh,
bool bIncludeParent
)

 Utility for getting indices of all bodies below (and including) the one with the supplied name.
Public function Const void

GetBodyIndicesBelow ( TArray< int32 >& OutBodyIndices,
const FName InBoneName,
const FReferenceSkeleton& RefSkeleton,
const bool bIncludeParent
)

  
Public function void

GetCollisionMesh ( int32 ViewIndex,
FMeshElementCollector& Collector,
const FReferenceSkeleton& RefSkeleton,
const TArray< FTransform >& SpaceBases,
const FTransform& LocalToWorld,
const FVector& Scale3D
)

  
Public function UFunction BlueprintCallable, Category FConstraintInstanceAccessor

GetConstraintByBoneNames ( FName Bone1Name,
FName Bone2Name
)

 Gets a constraint by its joint name
Public function UFunction BlueprintCallable, Category FConstraintInstanceAccessor

GetConstraintByName ( FName ConstraintName
)

 Gets a constraint by its joint name
Public function FConstraintInstanceAccessor  
Public function FConstraintInstance *  
Public function Const const TArray< FName > &  
Public function UFunction BlueprintCallable, Category void

GetConstraints ( bool bIncludesTerminated,
TArray< FConstraintInstanceAccessor >& OutConstraints
)

 Gets all constraints
Public function Const void

GetNearestBodyIndicesBelow ( TArray< int32 >& OutBodyIndices,
FName InBoneName,
const USkeletalMesh* InSkelMesh
)

  
Public function Const const TArray< FName > &  
Public function Const ECollisionEnabled::Type

GetPrimitiveCollision ( int32 BodyIndex,
EAggCollisionShape::Type PrimitiveType,
int32 PrimitiveIndex
)

 Get the per-primitive collision filtering mode for a body.
Public function Const bool

GetPrimitiveContributeToMass ( int32 BodyIndex,
EAggCollisionShape::Type PrimitiveType,
int32 PrimitiveIndex
)

 Get whether or not a primitive volume contributes to the mass of the object.
Public function void  
Public function void Invalidates physics meshes from all bodies. Data will be rebuilt completely.
Public function Const bool

IsCollisionEnabled ( int32 BodyIndexA,
int32 BodyIndexB
)

 Check whether the two bodies specified are enabled for collision.
Public function Const void Update skeletal meshes when physics asset changes
Public function void

SetPrimitiveCollision ( int32 BodyIndex,
EAggCollisionShape::Type PrimitiveType,
int32 PrimitiveIndex,
ECollisionEnabled::Type CollisionEnabled
)

 Get the per-primitive collision filtering mode for a body.
Public function void

SetPrimitiveContributeToMass ( int32 BodyIndex,
EAggCollisionShape::Type PrimitiveType,
int32 PrimitiveIndex,
bool bContributesToMass
)

 Set whether or not a primitive volume contributes to the mass of the object.
Public function void Update the BodySetup Array Index Map.
Public function void Update the BoundsBodies array and cache the indices of bodies marked with bConsiderForBounds to BoundsBodies array.

Overridden from UObject

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual FString

GetDesc ()

 Returns a one line description of an object for viewing in the thumbnail view of the generic browser
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyThatWillChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const USkeletalMesh * Get the preview mesh for this asset
Public function Virtual void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IPreviewMeshProviderInterface interface

Typedefs

Name Description
FRefreshPhysicsAssetChangeDelegate Delegate fired when physics asset changes

Constants

Name Description
OnRefreshPhysicsAssetChange  

Deprecated Variables

  Type Name Description
Public variable UProperty TObjectPtr< class USkeletalMesh > DefaultSkelMesh_DEPRECATED Default skeletal mesh to use when previewing this PhysicsAsset etc.

See Also

https://docs.unrealengine.com/InteractiveExperiences/Physics/PhysicsAssetEditor

USkeletalMesh

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page