UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FReadPhysicsObjectInterface< Id > Class Template Reference

#include <PhysicsObjectInterface.h>

+ Inheritance diagram for Chaos::FReadPhysicsObjectInterface< Id >:

Public Member Functions

CHAOS_API FPhysicsObjectHandle GetRootObject (const FConstPhysicsObjectHandle Object)
 
CHAOS_API bool HasChildren (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FChaosUserDefinedEntityGetUserDefinedEntity (const FConstPhysicsObjectHandle Object)
 
CHAOS_API int32 GetClusterHierarchyLevel (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FTransform GetTransform (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FVector GetX (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FVector GetCoM (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FVector GetWorldCoM (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FQuat GetR (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FVector GetV (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FVector GetVAtPoint (const FConstPhysicsObjectHandle Object, const FVector &Point)
 
CHAOS_API FVector GetW (const FConstPhysicsObjectHandle Object)
 
CHAOS_API FSpatialAccelerationIdx GetSpatialIndex (const FConstPhysicsObjectHandle Object)
 
CHAOS_API TThreadParticle< Id > * GetParticle (const FConstPhysicsObjectHandle Object)
 
CHAOS_API TThreadKinematicParticle< Id > * GetKinematicParticle (const FConstPhysicsObjectHandle Object)
 
CHAOS_API TThreadRigidParticle< Id > * GetRigidParticle (const FConstPhysicsObjectHandle Object)
 
CHAOS_API TArray< TThreadParticle< Id > * > GetAllParticles (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API TArray< TThreadRigidParticle< Id > * > GetAllRigidParticles (TArrayView< const FConstPhysicsObjectHandle > InObjects, bool bIncludeNulls=false)
 
CHAOS_API TArray< FPerShapeData * > GetAllShapes (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API TArray< TThreadShapeInstance< Id > * > GetAllThreadShapes (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API FImplicitObjectRef GetGeometry (const FConstPhysicsObjectHandle Handle)
 
CHAOS_API void VisitEveryShape (TArrayView< const FConstPhysicsObjectHandle > InObjects, TFunctionRef< bool(const FConstPhysicsObjectHandle, TThreadShapeInstance< Id > *)> Lambda)
 
CHAOS_API bool AreAllValid (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllKinematic (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllSleeping (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllRigidBody (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllDynamic (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllDynamicOrSleeping (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllDisabled (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API bool AreAllShapesQueryEnabled (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API float GetMass (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API FBox GetBounds (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API FBox GetWorldBounds (TArrayView< const FConstPhysicsObjectHandle > InObjects)
 
CHAOS_API FClosestPhysicsObjectResult GetClosestPhysicsBodyFromLocation (TArrayView< const FConstPhysicsObjectHandle > InObjects, const FVector &WorldLocation)
 
CHAOS_API FAccelerationStructureHandle CreateAccelerationStructureHandle (const FConstPhysicsObjectHandle Handle)
 

Protected Member Functions

 FReadPhysicsObjectInterface ()=default
 

Friends

class FPhysicsObjectInterface
 

Detailed Description

template<EThreadContext Id>
class Chaos::FReadPhysicsObjectInterface< Id >

FReadPhysicsObjectInterface will assume that these operations are safe to call (i.e. the relevant scenes have been read locked on the game thread).

Constructor & Destructor Documentation

◆ FReadPhysicsObjectInterface()

template<EThreadContext Id>
Chaos::FReadPhysicsObjectInterface< Id >::FReadPhysicsObjectInterface ( )
protecteddefault

Member Function Documentation

◆ AreAllDisabled()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllDisabled ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllDynamic()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllDynamic ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllDynamicOrSleeping()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllDynamicOrSleeping ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllKinematic()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllKinematic ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllRigidBody()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllRigidBody ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllShapesQueryEnabled()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllShapesQueryEnabled ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllSleeping()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllSleeping ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ AreAllValid()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::AreAllValid ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ CreateAccelerationStructureHandle()

template<EThreadContext Id>
FAccelerationStructureHandle Chaos::FReadPhysicsObjectInterface< Id >::CreateAccelerationStructureHandle ( const FConstPhysicsObjectHandle  Handle)

◆ GetAllParticles()

template<EThreadContext Id>
TArray< TThreadParticle< Id > * > Chaos::FReadPhysicsObjectInterface< Id >::GetAllParticles ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ GetAllRigidParticles()

template<EThreadContext Id>
TArray< TThreadRigidParticle< Id > * > Chaos::FReadPhysicsObjectInterface< Id >::GetAllRigidParticles ( TArrayView< const FConstPhysicsObjectHandle InObjects,
bool  bIncludeNulls = false 
)

◆ GetAllShapes()

◆ GetAllThreadShapes()

template<EThreadContext Id>
TArray< TThreadShapeInstance< Id > * > Chaos::FReadPhysicsObjectInterface< Id >::GetAllThreadShapes ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ GetBounds()

◆ GetClosestPhysicsBodyFromLocation()

template<EThreadContext Id>
FClosestPhysicsObjectResult Chaos::FReadPhysicsObjectInterface< Id >::GetClosestPhysicsBodyFromLocation ( TArrayView< const FConstPhysicsObjectHandle InObjects,
const FVector WorldLocation 
)

◆ GetClusterHierarchyLevel()

template<EThreadContext Id>
int32 Chaos::FReadPhysicsObjectInterface< Id >::GetClusterHierarchyLevel ( const FConstPhysicsObjectHandle  Object)

◆ GetCoM()

◆ GetGeometry()

◆ GetKinematicParticle()

template<EThreadContext Id>
TThreadKinematicParticle< Id > * Chaos::FReadPhysicsObjectInterface< Id >::GetKinematicParticle ( const FConstPhysicsObjectHandle  Object)

◆ GetMass()

◆ GetParticle()

◆ GetR()

◆ GetRigidParticle()

◆ GetRootObject()

◆ GetSpatialIndex()

◆ GetTransform()

◆ GetUserDefinedEntity()

◆ GetV()

◆ GetVAtPoint()

template<EThreadContext Id>
FVector Chaos::FReadPhysicsObjectInterface< Id >::GetVAtPoint ( const FConstPhysicsObjectHandle  Object,
const FVector Point 
)

◆ GetW()

◆ GetWorldBounds()

template<EThreadContext Id>
FBox Chaos::FReadPhysicsObjectInterface< Id >::GetWorldBounds ( TArrayView< const FConstPhysicsObjectHandle InObjects)

◆ GetWorldCoM()

◆ GetX()

◆ HasChildren()

template<EThreadContext Id>
bool Chaos::FReadPhysicsObjectInterface< Id >::HasChildren ( const FConstPhysicsObjectHandle  Object)

◆ VisitEveryShape()

Friends And Related Symbol Documentation

◆ FPhysicsObjectInterface

template<EThreadContext Id>
friend class FPhysicsObjectInterface
friend

The documentation for this class was generated from the following files: