Navigation
API > API/Plugins > API/Plugins/UAF
Value Bundle
This struct holds values produced by UAF. They come in two flavors: bound and unbound. Bound values are fast and defined up front in the skeleton set binding asset. Unbound values are slower but produced on demand during evaluation.
| Name | FValueBundle |
| Type | class |
| Header File | /Engine/Plugins/Experimental/UAF/UAF/Source/UAF/Public/UAF/ValueRuntime/ValueBundle.h |
| Include Path | #include "UAF/ValueRuntime/ValueBundle.h" |
Syntax
class FValueBundle
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FValueBundle
(
const FValueBundle& Other |
UAF/ValueRuntime/ValueBundle.h | ||
FValueBundle
(
FValueBundle&& Other |
UAF/ValueRuntime/ValueBundle.h | ||
FValueBundle
(
const FAttributeNamedSetPtr& NamedSet, |
UAF/ValueRuntime/ValueBundle.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FValueBundle() |
UAF/ValueRuntime/ValueBundle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BoundMaps | FBoundMapCollection | A collection of bound value maps. | UAF/ValueRuntime/ValueBundle.h | |
| NamedSet | FAttributeNamedSetPtr | The named set we are based on, every set mapping uses a typed set within it. | UAF/ValueRuntime/ValueBundle.h | |
| ReallocFun | FReallocFun | The indirect allocator function pointer. | UAF/ValueRuntime/ValueBundle.h | |
| UnboundMaps | FUnboundMapCollection | A collection of unbound value maps. | UAF/ValueRuntime/ValueBundle.h | |
| ValueSpace | FValueSpace | The space in which our values live. | UAF/ValueRuntime/ValueBundle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Empty() |
Clears the collection of any content. | UAF/ValueRuntime/ValueBundle.h | |
FReallocFun GetAllocator() |
Returns the allocator function this collection was initialized with. | UAF/ValueRuntime/ValueBundle.h | |
| Returns a collection of bound value maps. | UAF/ValueRuntime/ValueBundle.h | ||
const FBoundMapCollection & GetBoundValueMaps () |
UAF/ValueRuntime/ValueBundle.h | ||
const FAttributeNamedSetPtr & GetNamedSet() |
Returns the named set this collection maps to. | UAF/ValueRuntime/ValueBundle.h | |
const FUnboundMapCollection & GetUnboundValueMaps () |
UAF/ValueRuntime/ValueBundle.h | ||
| Returns a collection of unbound value maps. | UAF/ValueRuntime/ValueBundle.h | ||
FValueSpace GetValueSpace() |
Returns the space our values live in. | UAF/ValueRuntime/ValueBundle.h | |
void InitWithValueSpace
(
FValueSpace ValueSpace |
Sets the space our values line in and default initializes this collection For local/component space, we initialize with the reference pose For additive space, we initialize with the additive identity Other spaces initialize to their identity Note that only bound values are default initialized | UAF/ValueRuntime/ValueBundle.h | |
bool IsAdditive() |
Returns whether or not the space our values live in is additive. | UAF/ValueRuntime/ValueBundle.h | |
bool IsEmpty() |
Returns whether or not we are empty. | UAF/ValueRuntime/ValueBundle.h | |
void Reset
(
const FAttributeNamedSetPtr& NamedSet |
Resets the collection with the specified named set. | UAF/ValueRuntime/ValueBundle.h | |
void SetValueSpace
(
FValueSpace ValueSpace |
Sets the space our values live in Note that care must be taken when changing the value space as all values within the collection must be migrated accordingly | UAF/ValueRuntime/ValueBundle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FValueBundle & operator=
(
FValueBundle&& Other |
UAF/ValueRuntime/ValueBundle.h | ||
FValueBundle & operator=
(
const FValueBundle& Other |
UAF/ValueRuntime/ValueBundle.h |