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 calues (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

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static FParamStack &

Get ()

 Get the param stack for this thread.
Public function ValueType & Get a mutable reference to the value of a parameter given a FName.
Public function ValueType & Get a mutable reference to the value of a parameter given a FParamId.
Public function EGetParamResult

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

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

GetParam ( FParamId InParamId,
FParamStack::EGetParamResult* OutResult
)

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

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

 Get a parameter's data given an FParamId.
Public function Const const ValueType * Get a pointer to a parameter's value given a FParamId.
Public function Const const ValueType * Get a pointer to a parameter's value given a FName.
Public function Const ValueType Get the value of a parameter given a FParamId.
Public function Const ValueType Get the value of a parameter given a FName.
Public function Static TUniquePtr< FParamStackLayer >

MakeLayer ( const FInstancedPropertyBag& InInstancedPropertyBag
)

 Create a cached parameter layer from an instanced property bag.
Public function Static TUniquePtr< FParamStackLayer >

MakeLayer ( TConstArrayView< TPair< FParamId, FParam >> InParams
)

 Create a cached parameter layer from set of params.
Public function Static TUniquePtr< FParamStackLayer >

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

 Make a parameter layer from a value
Public function Static TUniquePtr< FParamStackLayer >

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

 Make a parameter layer from a value
Public function Static TUniquePtr< FParamStackLayer >

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 void Push a layer.
Public function void

PushLayer ( TConstArrayView< TPair< FParamId, FParam >> InParams
)

 Push an internally-owned layer. Copies parameter data to internal storage.
Public function void

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

 Push a value as a parameter layer
Public function void

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

 Push a value as a parameter layer
Public function void

PushValues ( Args&&... InValues
)

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

Enums

  Type Name Description
Public enum EGetParamResult Results for FParamStack::GetParam.  
Private enum EParamFlags    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page