1. Epic GamesDeveloper
  3. FParamStack

FParamStack

Stack of parameter layers.

API > API/Plugins > API/Plugins/AnimNext > API/Plugins/AnimNext/Param

References

   
Module AnimNext
Header /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/Param/ParamStack.h
Include #include "Param/ParamStack.h"

Syntax

struct FParamStack

Remarks

Stack of parameter layers. Acts as an associative container - allows retrieval of parameter values (by ID) that have been pushed onto the stack in 'layers'. Parameter values (and notably types) on higher stack layers override those on lower layers. Older values and types are restored when a layer is popped. Parameter values, once pushed, can be overridden by subsequent layers, but they cannot be removed until the layer that initially introduces the parameter is popped.

Constructors

No constructors are accessible with public or protected access.

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static FParamStack &

Get ()

 Get the param stack for this thread.
Public function ValueType &

GetMutableParam ( FParamId InParamId,
FParamResult* OutResult
)

 Get a mutable reference to the value of a parameter given a FParamId.
Public function ValueType &

GetMutableParam ( FName InKey,
FParamResult* OutResult
)

 Get a mutable reference to the value of a parameter given a FName.
Public function FParamResult

GetMutableParamData ( FParamId InId,
FParamTypeHandle InTypeHandle,
TArrayView< uint8 >& OutParamData,
FParamTypeHandle& OutParamTypeHandle,
FParamCompatibility InRequiredCompatibility
)

  
Public function FParamResult

GetMutableParamData ( FParamId InId,
FParamTypeHandle InTypeHandle,
TArrayView< uint8 >& OutParamData,
FParamCompatibility InRequiredCompatibility
)

 Get a parameter's mutable data given an FParamId.
Public function ValueType *

GetMutableParamPtr ( FName InKey,
FParamResult* OutResult
)

 Get a pointer to a parameter's mutable value given a FName.
Public function ValueType *

GetMutableParamPtr ( FParamId InParamId,
FParamResult* OutResult
)

 Get a pointer to a parameter's mutable value given a FParamId.
Public function Const const ValueType &

GetParam ( FName InKey,
FParamResult* OutResult
)

 Get a const reference to the value of a parameter given a FName.
Public function Const const ValueType &

GetParam ( FParamId InParamId,
FParamResult* OutResult
)

 Get a const reference to the value of a parameter given a FParamId.
Public function Const FParamResult

GetParamData ( FParamId InId,
FParamTypeHandle InTypeHandle,
TConstArrayView< uint8 >& OutParamData,
FParamCompatibility InRequiredCompatibility
)

 Get a parameter's data given an FParamId.
Public function Const FParamResult

GetParamData ( FParamId InId,
FParamTypeHandle InTypeHandle,
TConstArrayView< uint8 >& OutParamData,
FParamTypeHandle& OutParamTypeHandle,
FParamCompatibility InRequiredCompatibility
)

  
Public function Const const ValueType *

GetParamPtr ( FName InKey,
FParamResult* OutResult
)

 Get a pointer to a parameter's value given a FName.
Public function Const const ValueType *

GetParamPtr ( FParamId InParamId,
FParamResult* OutResult
)

 Get a pointer to a parameter's value given a FParamId.
Public function Const ValueType

GetParamValue ( FParamId InParamId,
FParamResult* OutResult
)

 Get the value of a parameter given a FParamId.
Public function Const ValueType

GetParamValue ( FName InKey,
FParamResult* OutResult
)

 Get the value of a parameter given a FName.
Public function Static FParamStackLayerHandle

MakeReferenceLayer ( FInstancedPropertyBag& InInstancedPropertyBag
)

 Create a cached parameter layer from an instanced property bag. This layer will reference the supplied property bag and does not transfer ownership.
Public function Static FParamStackLayerHandle

MakeRemappedLayer ( const FParamStackLayerHandle& InLayer,
const TMap< FName, FName >& InMapping
)

 Create a cached parameter layer by remapping the entries from another layer Original layer continues to own the memory
Public function Static FParamStackLayerHandle

MakeValueLayer ( FName InName,
ValueType&&... InValue
)

 Make a parameter layer from a value
Public function Static FParamStackLayerHandle

MakeValueLayer ( FParamId InParamId,
ValueType&&... InValue
)

 Make a parameter layer from a value
Public function Static FParamStackLayerHandle

MakeValueLayer ( const FInstancedPropertyBag& InInstancedPropertyBag
)

 Create a cached parameter layer from an instanced property bag. This layer will own a copy of the property bag used to represent the layer.
Public function Static FParamStackLayerHandle

MakeValuesLayer ( Args&&... InValues
)

 Make a parameter layer from an interleaved parameter list of keys and values
Public function void Pop a parameter layer.
Public function FPushedLayerHandle

PushLayer ( const FParamStackLayerHandle& InLayerHandle
)

 Push a layer.
Public function FPushedLayerHandle

PushValue ( FParamId InParamId,
ValueType&&... InValue
)

 Push a value as a parameter layer
Public function FPushedLayerHandle

PushValue ( FName InName,
ValueType&&... InValue
)

 Push a value as a parameter layer
Public function FPushedLayerHandle

PushValues ( Args&&... InValues
)

 Push an interleaved parameter list of keys and values as a parameter layer

Classes

  Type Name Description
Public struct FPushedLayerHandle Opaque handle to a layer on the stack.  
Public struct TLayerBuilder Builder struct to help build combined layers of parameters.  

Enums

  Type Name Description
Private enum ECoalesce Behavior flag for coalescing parent stacks on thread attachment.  
Private enum EDecoalesce Behavior flag for de-coalescing parent stacks on thread detachment.  

Typedefs

Name Description
FLayerBuilder  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page