Navigation
API > API/Runtime > API/Runtime/Chaos
Handle to a IPhysicsProxyBase, that cross references its creation timestamp to make sure the original proxy has not been deleted and we are truly dealing with the one used to make the handle initially (the pointer could have been reused)
| Name | FPhysicsProxyHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PhysicsProxyHandle.h |
| Include Path | #include "Chaos/PhysicsProxyHandle.h" |
Syntax
struct FPhysicsProxyHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Chaos/PhysicsProxyHandle.h | |||
FPhysicsProxyHandle
(
const FPhysicsProxyHandle& |
Chaos/PhysicsProxyHandle.h | ||
| Chaos/PhysicsProxyHandle.h | |||
FPhysicsProxyHandle
(
IPhysicsProxyBase* InProxy |
Chaos/PhysicsProxyHandle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FPhysicsProxyHandle() |
Chaos/PhysicsProxyHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Proxy | IPhysicsProxyBase * | Chaos/PhysicsProxyHandle.h | ||
| Timestamp | TSharedPtr< FProxyTimestampBase, ESPMode::ThreadSafe > | Chaos/PhysicsProxyHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
IPhysicsProxyBase * Get() |
Returns the underlying physics proxy pointer, or null if this handle is invalid (see IsValid()) | Chaos/PhysicsProxyHandle.h | |
| Returns the underlying IPhysicsProxyBase pointer, without performing any validity checks. | Chaos/PhysicsProxyHandle.h | ||
bool IsStale() |
Returns true if the handle was set to a proxy but that proxy was deleted since then | Chaos/PhysicsProxyHandle.h | |
bool IsValid() |
Returns true if this handle points to the same non deleted non null physics proxy as that used when setting or initializing the handle | Chaos/PhysicsProxyHandle.h | |
void Reset() |
Resets this handle, which will now be invalid | Chaos/PhysicsProxyHandle.h | |
void Set
(
IPhysicsProxyBase* InProxy |
Sets this handle to point to InProxy, or resets this handle if InProxy is null. | Chaos/PhysicsProxyHandle.h | |
void Set
(
FGeometryParticleHandle& ParticleHandle |
Sets this handle to point to the physics proxy corresponding to a particle handle | Chaos/PhysicsProxyHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FPhysicsProxyHandle& RHS |
Chaos/PhysicsProxyHandle.h | ||
FPhysicsProxyHandle & operator=
(
const FPhysicsProxyHandle& Other |
Chaos/PhysicsProxyHandle.h | ||
FPhysicsProxyHandle & operator=
(
FPhysicsProxyHandle&& Other |
Chaos/PhysicsProxyHandle.h | ||
bool operator==
(
const FPhysicsProxyHandle& RHS |
Chaos/PhysicsProxyHandle.h |