Module |
|
Header |
/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraParameterMapHistory.h |
Include |
#include "NiagaraParameterMapHistory.h" |
struct FNiagaraParameterMapHistory
Traverses a Niagara node graph to identify the variables that have been written and read from a parameter map. This class is meant to aid in UI and compilation of the graph. There are several main script types and each one interacts slightly differently with the history depending on context.
Name | Description | ||
---|---|---|---|
|
EmitterNamespacesEncountered |
List of emitter namespaces encountered as this parameter map was built. |
|
|
IterationNamespaceOverridesEncountered |
List of all the custom iteration source override namespaces encountered |
|
|
MapNodeVariableMetaData |
For each node in MapNodeVisitations, record the start index and end index of variables added within the body of the node, i.e. a Get node will record just the values it pulls out directly. |
|
|
TArray< const c... |
MapNodeVisitations |
List of nodes that manipulated the parameter map from input to output. |
|
MapPinHistory |
List of pins that manipulated the parameter map from input to output. |
|
|
OriginatingScriptUsage |
||
|
ParameterCollectionNamespaces |
Cached off contents of used parameter collections, in case they change during threaded compilation. |
|
|
ParameterCollections |
Used parameter collections identified during the traversal. |
|
|
ParameterCollectionVariables |
Cached off contents of used parameter collections, in case they change during threaded compilation. |
|
|
PerVariableReadHistory |
For each variable that was found, identify the pins that read them from the map in order from first to last read. |
|
|
PerVariableWarnings |
Are there any warnings that were encountered during the traversal of the graph for a given variable? |
|
|
PerVariableWriteHistory |
For each variable that was found, identify the pins that wrote to them in order from first to last write. |
|
|
VariableMetaData |
The metadata associated with each variable identified during the traversal. |
|
|
Variables |
The variables that have been identified during the traversal. |
|
|
VariablesWithOriginalAliasesIntact |
Name | Description | |
---|---|---|
|
FNiagaraParameterMapHistory() |
Name | Description | ||
---|---|---|---|
|
AddExternalVariable ( |
Add a variable outside the normal get/set node paradigm. |
|
|
AddVariable ( |
Helper to add a variable to the known list for a parameter map. |
|
|
FNiagaraVari... |
BasicAttributeToNamespacedAttribute ( |
Reverses ResolveAsBasicAttribute. |
|
BeginNodeVisitation ( |
||
|
FNiagaraVari... |
ConvertVariableToRapidIterationConstantName ( |
|
|
EndNodeVisitation ( |
||
|
FindVariable ( |
Find a variable by both name and type. |
|
|
FindVariableByName |
Find a variable by name with no concern for type. |
|
|
const UEdGra... |
GetDefaultValuePin ( |
Get the default value for this variable. |
|
const UNiaga... |
GetFinalOutputNode() |
Get the output node associated with this graph. |
|
const UEdGra... |
GetFinalPin() |
Get the output pin that we traced to build this history object. |
|
GetNamespace ( |
Get the first namespace entry for this variable. Optionally includes the trailing period. |
|
|
const UEdGra... |
GetOriginalPin() |
Get the pin that added the parameter map to the graph. |
|
FNiagaraVari... |
GetSourceForInitialValue ( |
Does this parameter contain the "Initial" namespace as one of its intermediate namespaces? If so, remove the "Initial" namespace and return the original value. |
|
FNiagaraVari... |
GetSourceForPreviousValue ( |
Does this parameter contain the "Previous" namespace as one of its intermediate namespaces? If so, remove the "Previous" namespace and return the original value. |
|
GetValidNamespacesForReading ( |
||
|
GetValidNamespacesForReading ( |
||
|
IsAliasedEmitterParameter ( |
Does this parameter start with the "Emitter" namespace? |
|
|
IsAliasedEmitterParameter ( |
Does this parameter start with the "Emitter" namespace? |
|
|
IsAliasedModuleParameter ( |
Does this parameter start with the "Module" namespace? |
|
|
IsAttribute ( |
Does this parameter start with the "Particles" namespace? |
|
|
IsEngineParameter ( |
Is this parameter in the special "Engine" namespace? |
|
|
IsExportableExternalConstant ( |
Are we required to export this variable as an external constant? |
|
|
IsExternalConstantNamespace ( |
Does this variable belong in a namespace that needs to come in as an external constant to this script? |
|
|
IsExternalConstantNamespace ( |
Does this variable belong in a namespace that needs to come in as an external constant to this script? |
|
|
IsInitialValue ( |
Does this parameter contain the "Initial" namespace as one of its intermediate namespaces? |
|
|
IsInNamespace ( |
Does the variable start with this namespace? |
|
|
UNiagaraPara... |
IsParameterCollectionParameter ( |
If this is variable is a parameter in one of our tracked collections, return it. |
|
IsPerInstanceEngineParameter ( |
||
|
IsPreviousValue ( |
Does this parameter contain the "Previous" namespace as one of its intermediate namespaces? |
|
|
IsPrimaryDataSetOutput ( |
Called to determine if a given variable should be output from a script. |
|
|
IsPrimaryDataSetOutput ( |
Called to determine if a given variable should be output from a script. |
|
|
IsRapidIterationParameter ( |
||
|
IsSystemParameter ( |
Is this parameter in the special "System" namespace? |
|
|
IsUserParameter ( |
||
|
IsValidNamespaceForReading ( |
||
|
IsVariableFromCustomIterationNamespaceOverride ( |
||
|
IsWrittenToScriptUsage ( |
||
|
MakeSafeNamespaceString ( |
Take an input string and make it hlsl safe. |
|
|
FNiagaraVari... |
MoveToExternalConstantNamespaceVariable ( |
Take a non-namespaced variable and move it to an appropriate external constant namespace for this script type. |
|
FNiagaraVari... |
MoveToExternalConstantNamespaceVariable ( |
Take a non-namespaced variable and move it to an appropriate external constant namespace for this script type. |
|
RegisterParameterMapPin ( |
Called in a depth-first traversal to identify a given Niagara Parameter Map pin that was touched during traversal. |
|
|
FNiagaraVari... |
ResolveAliases |
Use the input alias map to resolve any aliases in this input variable name. |
|
FNiagaraVari... |
ResolveAsBasicAttribute ( |
Remove the Particles namespace if it exists. |
|
ResolveEmitterAlias |
||
|
SearchArrayForPartialNameMatch ( |
||
|
ShouldIgnoreVariableDefault ( |
||
|
SplitRapidIterationParameterName ( |
||
|
FNiagaraVari... |
VariableToNamespacedVariable ( |
Prepends the namespace string to the variable name. |