#include <ComposableCameraPatchHandle.h>
Inherits:
UObject
Caller-facing opaque handle to an active Patch.
Held weakly: when the underlying instance is removed (expired, context popped, Director destroyed), the handle's getters return defaulted values and IsActive returns false. Callers do not need to null-check the handle on every getter.
Construction is internal to UComposableCameraPatchManager — callers receive the handle from AddPatch and pass it to ExpirePatch / the BP getters.
GC lifetime caveat: the handle UObject itself has only a weak back-reference from the instance, so callers MUST keep the handle alive through their own strong reference. Blueprint usage is automatic — BP variables hold strong refs. C++ usage requires storing the handle in a UPROPERTY (or other GC-tracked location) on the owning class; a raw local pointer that goes out of scope will be collected, after which Manual-channel ExpirePatch becomes impossible (Duration / Condition channels still expire normally).
Public Methods¶
| Return | Name | Description |
|---|---|---|
void |
BindInstance |
Internal binding — set by PatchManager::AddPatch immediately after handle construction. |
UComposableCameraPatchInstance * |
GetInstance const |
|
bool |
IsActive const |
|
EComposableCameraPatchPhase |
GetPhase const |
|
float |
GetAlpha const |
|
float |
GetElapsedTime const |
BindInstance¶
void BindInstance(UComposableCameraPatchInstance * InInstance)
Internal binding — set by PatchManager::AddPatch immediately after handle construction.
GetInstance¶
const
UComposableCameraPatchInstance * GetInstance() const
IsActive¶
const
bool IsActive() const
GetPhase¶
const
EComposableCameraPatchPhase GetPhase() const
GetAlpha¶
const
float GetAlpha() const
GetElapsedTime¶
const
float GetElapsedTime() const
Private Attributes¶
| Return | Name | Description |
|---|---|---|
TWeakObjectPtr< UComposableCameraPatchInstance > |
Instance |
Instance¶
TWeakObjectPtr< UComposableCameraPatchInstance > Instance