1. Epic GamesDeveloper
  3. UBodySetup

UBodySetup

BodySetup contains all collision information that is associated with a single asset.

Unreal Engine C++ API Reference > Runtime > Engine > PhysicsEngine

Inheritance Hierarchy

References

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

Syntax

class UBodySetup : public UBodySetupCore

Remarks

BodySetup contains all collision information that is associated with a single asset. A single BodySetup instance is shared among many BodyInstances so that geometry data is not duplicated. Assets typically implement a GetBodySetup function that is used during physics state creation.

Variables

  Type Name Description
Public variable FKAggregateGeom AggGeom Simplified collision representation of this
Public variable uint8: 1 bConsiderForBounds Should this BodySetup be considered for the bounding box of the PhysicsAsset (and hence SkeletalMeshComponent).
Public variable uint8: 1 bCreatedPhysicsMeshes Flag used to know if we have created the physics convex and tri meshes from the cooked data yet
Public variable uint8: 1 bDoubleSidedGeometry If true, the physics triangle mesh will use double sided faces when doing scene queries.
Public variable uint8: 1 bFailedToCreatePhysicsMeshes Flag used to know if we have failed to create physics meshes.
Public variable uint8: 1 bGenerateMirroredCollision Should we generate data necessary to support collision on mirrored versions of this mesh.
Public variable uint8: 1 bGenerateNonMirroredCollision Should we generate data necessary to support collision on normal (non-mirrored) versions of this body.
Public variable uint8: 1 bHasCookedCollisionData Indicates whether this setup has any cooked collision data.
Public variable uint8: 1 bMeshCollideAll If true, the physics of this mesh (only affects static meshes) will always contain ALL elements from the mesh - not just the ones enabled for collision.
Public variable uint8: 1 bNeverNeedsCookedCollisionData Indicates that we will never use convex or trimesh shapes.
Public variable FGuid BodySetupGuid GUID used to uniquely identify this setup so it can be found in the DDC
Public variable uint8: 1 bSharedCookedData Whether the cooked data is shared by multiple body setups.
Public variable uint8: 1 bSupportUVsAndFaceRemap If true, the physics triangle mesh will store UVs and the face remap table.
Public variable FVector BuildScale3D Build scale for this body setup (static mesh settings define this value)
Public variable TUniquePtr< FChaosDerivedDataReader< float, 3 > > ChaosDerivedDataReader Will contain deserialized data from the serialization function that can be used at PostLoad time.
Public variable TArray< TSharedPtr< Chaos::FTriangleMeshImplicitObject, ESPMode::ThreadSafe > > ChaosTriMeshes FBodySetupTriMeshes* TriMeshWrapper;.
Public variable FFormatContainer CookedFormatData Cooked physics data for each format
Public variable FFormatContainer * CookedFormatDataOverride Cooked physics data override.
Public variable FAsyncCookHelper * CurrentCookHelper  
Public variable FBodyInstance DefaultInstance Default properties of the body instance, copied into objects on instantiation, was URB_BodyInstance
Public variable TArray< int32 > FaceRemap Additional face remap table, if available.
Public variable TObjectPtr< class UPhysicalMaterial > PhysMaterial Physical material to use for simple collision on this body.
Public variable FBodySetupUVInfo UVInfo Additional UV info, if available. Used for determining UV for a line trace impact.
Public variable FWalkableSlopeOverride WalkableSlopeOverride Custom walkable slope setting for this body.

Constructors

  Type Name Description
Public function  

UBodySetup ( const FObjectInitializer& ObjectInitializer
)

  
Public function   Needs implementation in BodySetup.cpp to compile UniquePtr for forward declared class

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Aborts an async cook that hasn't begun.
Public function bool

AddCollisionElemFrom ( const FKAggregateGeom& FromAggGeom,
const EAggCollisionShape::Type ShapeType,
const int32 ElemIndex
)

  
Public function void

AddCollisionFrom ( const FKAggregateGeom& FromAggGeom
)

 Add collision shapes from another body setup to this one
Public function void

AddCollisionFrom ( UBodySetup* FromSetup
)

 Add collision shapes from another body setup to this one
Public function void

AddShapesToRigidActor_AssumesLocked ( FBodyInstance* OwningInstance,
FVector& Scale3D,
UPhysicalMaterial* SimpleMaterial,
TArray< UPhysicalMaterial* >& ComplexMaterials,
TArray< FPhysicalMaterialMaskParams >& ComplexMaterialMasks,
const FBodyCollisionData& BodyCollisionData,
const FTransform& RelativeTM,
TArray< FPhysicsShapeHandle >* NewShapes
)

 Add the shapes defined by this body setup to the supplied PxRigidBody.
Public function Virtual Const float

CalculateMass ( const UPrimitiveComponent* Component
)

 Calculates the mass.
Public function Const bool

CalcUVAtLocation ( const FVector& BodySpaceLocation,
int32 FaceIndex,
int32 UVChannel,
FVector2D& UV
)

 Given a location in body space, and face index, find the UV of the desired UV channel.
Public function void Release Physics meshes (ConvexMeshes, TriMesh & TriMeshNegX)
Public function void

CopyBodyPropertiesFrom ( const UBodySetup* FromSetup
)

  
Public function Virtual void Copy all UPROPERTY settings except the collision geometry.
Public function bool

CreateFromModel ( UModel* InModel,
bool bRemoveExisting
)

 Converts a UModel to a set of convex hulls for simplified collision.
Public function Virtual void Create Physics meshes (ConvexMeshes, TriMesh & TriMeshNegX) from cooked data Release Physics meshes (ConvexMeshes, TriMesh & TriMeshNegX).
Public function void

CreatePhysicsMeshesAsync ( FOnAsyncPhysicsCookFinished OnAsyncPhysicsCookFinished
)

 Create Physics meshes (ConvexMeshes, TriMesh & TriMeshNegX) from cooked data async (useful for runtime cooking as it can go wide off the game thread) Release Physics meshes (ConvexMeshes, TriMesh & TriMeshNegX).
Public function Const float

GetClosestPointAndNormal ( const FVector& WorldPosition,
const FTransform& BodyToWorldTM,
FVector& ClosestWorldPosition,
FVector& FeatureNormal,
bool bUseConvexShapes
)

 Finds the closest point in the body setup.
Public function Const void

GetCookInfo ( FCookBodySetupInfo& OutCookInfo,
EPhysXMeshCookFlags InCookFlags
)

 Generates the information needed for cooking geometry.
Public function Const void

GetGeometryDDCKey ( FString& OutString
)

 Generate a string to uniquely describe the state of the geometry in this setup to populate the DDC
Public function Const UPhysicalMaterial * Returns the physics material used for this body.
Public function Virtual Const FVector::FReal

GetScaledVolume ( const FVector& Scale
)

 Returns the volume of this element givent the scale
Public function Const float

GetShortestDistanceToPoint ( const FVector& WorldPosition,
const FTransform& BodyToWorldTM,
bool bUseConvexShapes
)

 Finds the shortest distance between the body setup and a world position.
Public function Virtual void Invalidate physics data
Public function void Clear all simple collision
Public function void

RescaleSimpleCollision ( FVector BuildScale
)

 Rescales simple collision geometry. Note you must recreate physics meshes after this
Public function void

UpdateTriMeshVertices ( const TArray< FVector >& NewPositions
)

 Updates the tri mesh collision with new positions, and refits the BVH to match.

Overridden from UObject

  Type Name Description
Public function Virtual void Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
Public function Virtual void Called before destroying the object.
Public function Virtual void Clears cached cooked platform data for specific platform
Public function Virtual void Called to finish destroying the object.
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 bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
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 Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FAsyncCookHelper References the current async cook helper. Used to be able to abort a cook task

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bAlwaysFullAnimWeight_DEPRECATED If true (and bEnableFullAnimWeightBodies in SkelMeshComp is true), the physics of this bone will always be blended into the skeletal mesh, regardless of what PhysicsWeight of the SkelMeshComp is.
Public variable float BuildScale_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Virtual Const float

GetVolume ( const FVector& Scale
)

 Use GetScaledVolume which uses the same scaling technique as the generated collision geometry

See Also

GetBodySetup

FBodyInstance

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page