Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > PhysicsEngine > UPhysicsAsset

Light Theme

Dark Theme

UPhysicsAsset

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

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UPhysicsAsset

References

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

Syntax

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

	Name	Description
uint8: 1	bNotForDedicatedServer	If true, we skip instancing bodies for this PhysicsAsset on dedicated servers
TMap< FName, in...	BodySetupIndexMap	This caches the BodySetup Index by BodyName to speed up FindBodyIndex
TArray< int32 >	BoundsBodies	Index of bodies that are marked bConsiderForBounds
TMap< FRigidBod...	CollisionDisableTable	Table indicating which pairs of bodies have collision disabled between them.
TArray< FName >	ConstraintProfiles
TArray< TObject...	ConstraintSetup	Array of RB_ConstraintSetup objects.
FName	CurrentConstraintProfileName
FName	CurrentPhysicalAnimationProfileName
TArray< FName >	PhysicalAnimationProfiles
TSoftObjectPtr<...	PreviewSkeletalMesh
TArray< TObject...	SkeletalBodySetups	Array of SkeletalBodySetup objects.
FSolverIteratio...	SolverIterations	Old solver settings shown for reference.
FPhysicsAssetSo...	SolverSettings	Solver settings when the asset is used with a RigidBody Anim Node (RBAN).
EPhysicsAssetSo...	SolverType	Solver type used in physics asset editor.
TObjectPtr< cla...	ThumbnailInfo	Information for thumbnail rendering

Constructors

	Name	Description
	UPhysicsAsset ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BodyFindConstraints ( int32 BodyIndex, TArray< int32 >& Constraints )	Find all the constraints that are connected to a particular body.
FBox	CalcAABB ( const USkinnedMeshComponent* M..., const FTransform& LocalToWorld )
bool	CanCalculateValidAABB ( const USkinnedMeshComponent* M..., const FTransform& LocalToWorld )	Check if the Bounds can be calculate for the specified MeshComponent.
void	ClearAllPhysicsMeshes()	Clears physics meshes from all bodies
void	DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutC..., const UClass* SpecificSubclass )
void	DisableCollision ( int32 BodyIndexA, int32 BodyIndexB )	Disable collsion between the bodies specified by index.
void	DrawConstraints ( int32 ViewIndex, FMeshElementCollector& Collector, const FReferenceSkeleton& RefSkele..., const TArray< FTransform >& SpaceB..., const FTransform& LocalToWorld, float Scale )
void	EnableCollision ( int32 BodyIndexA, int32 BodyIndexB )	Enable collsion between the bodies specified by index.
int32	FindBodyIndex ( FName BodyName )
FName	FindConstraintBoneName ( int32 ConstraintIndex )
int32	FindConstraintIndex ( FName ConstraintName )
int32	FindConstraintIndex ( FName Bone1Name, FName Bone2Name )
int32	FindControllingBodyIndex ( USkeletalMesh* skelMesh, int32 BoneIndex )	Find the index of the physics bone that is controlling this graphics bone.
int32	FindMirroredBone ( USkeletalMesh* skelMesh, int32 BoneIndex )
int32	FindParentBodyIndex ( USkeletalMesh* skelMesh, int32 StartBoneIndex )
void	GetBodyIndicesBelow ( TArray< int32 >& OutBodyIndices, FName InBoneName, USkeletalMesh* InSkelMesh, bool bIncludeParent )	Utility for getting indices of all bodies below (and including) the one with the supplied name.
void	GetCollisionMesh ( int32 ViewIndex, FMeshElementCollector& Collector, const FReferenceSkeleton& RefSkele..., const TArray< FTransform >& SpaceB..., const FTransform& LocalToWorld, const FVector& Scale3D )
FConstraintI...	GetConstraintByBoneNames ( FName Bone1Name, FName Bone2Name )	Gets a constraint by its joint name
FConstraintI...	GetConstraintByName ( FName ConstraintName )	Gets a constraint by its joint name
FConstraintI...	GetConstraintInstanceAccessorByIndex ( int32 Index )
FConstraintI...	GetConstraintInstanceByIndex ( uint32 Index )
const TArray...	GetConstraintProfileNames()
void	GetConstraints ( bool bIncludesTerminated, TArray< FConstraintInstanceAccessor... )	Gets all constraints
void	GetNearestBodyIndicesBelow ( TArray< int32 >& OutBodyIndices, FName InBoneName, USkeletalMesh* InSkelMesh )
const TArray...	GetPhysicalAnimationProfileNames()
ECollisionEn...	GetPrimitiveCollision ( int32 BodyIndex, EAggCollisionShape::Type PrimitiveT..., int32 PrimitiveIndex )	Get the per-primitive collision filtering mode for a body.
bool	GetPrimitiveContributeToMass ( int32 BodyIndex, EAggCollisionShape::Type PrimitiveT..., int32 PrimitiveIndex )	Get whether or not a primitive volume contributes to the mass of the object.
void	GetUsedMaterials ( TArray< UMaterialInterface* > ... )
void	InvalidateAllPhysicsMeshes()	Invalidates physics meshes from all bodies. Data will be rebuilt completely.
bool	IsCollisionEnabled ( int32 BodyIndexA, int32 BodyIndexB )	Check whether the two bodies specified are enabled for collision.
void	RefreshPhysicsAssetChange()	Update skeletal meshes when physics asset changes
void	SetPrimitiveCollision ( int32 BodyIndex, EAggCollisionShape::Type PrimitiveT..., int32 PrimitiveIndex, ECollisionEnabled::Type CollisionEn... )	Get the per-primitive collision filtering mode for a body.
void	SetPrimitiveContributeToMass ( int32 BodyIndex, EAggCollisionShape::Type PrimitiveT..., int32 PrimitiveIndex, bool bContributesToMass )	Set whether or not a primitive volume contributes to the mass of the object.
void	UpdateBodySetupIndexMap()	Update the BodySetup Array Index Map.
void	UpdateBoundsBodiesArray()	Update the BoundsBodies array and cache the indices of bodies marked with bConsiderForBounds to BoundsBodies array.

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	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
FString	GetDesc()	Returns a one line description of an object for viewing in the thumbnail view of the generic browser
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	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).
EDataValidat...	IsDataValid ( TArray< FText >& ValidationErrors )	Generic function to validate objects during changelist validations, etc.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

		Name	Description
	USkeletalMes...	GetPreviewMesh()	Get the preview mesh for this asset
	void	SetPreviewMesh ( USkeletalMesh* PreviewMesh, bool bMarkAsDirty )	IPreviewMeshProviderInterface interface

Typedefs

Name	Description
FRefreshPhysicsAssetChangeDelegate	Delegate fired when physics asset changes

Constants

Name	Description
OnRefreshPhysicsAssetChange

Deprecated Variables

		Name	Description
	TObjectPtr< cla...	DefaultSkelMesh_DEPRECATED	Default skeletal mesh to use when previewing this PhysicsAsset etc.