1. Epic GamesDeveloper
  3. TNiagaraParameterMapHistoryBuilder

TNiagaraParameterMapHistoryBuilder

API > API/Plugins > API/Plugins/NiagaraEditor

Inheritance Hierarchy

References

   
Module NiagaraEditor
Header /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraParameterMapHistory.h
Include #include "NiagaraParameterMapHistory.h"

Syntax

template<typename GraphBridge>  
class TNiagaraParameterMapHistoryBuilder : public GraphBridge::FBuilderExtraData

Variables

  Type Name Description
Public variable FGraphTraversalHandle ActivePath  
Protected variable bool bFilterByScriptAllowList Whether or not the script allow list is active.
Protected variable bool bIgnoreDisabled Whether or not to ignore disabled nodes.
Protected variable bool bIgnoreStaticRapidIterationParameters Whether or not we want to look up the rapid iteration form of a variable or just the regular form.
Protected variable bool bIncludeParameterCollectionInfo Whether we want to include ParameterCollection information
Public variable bool bShouldBuildSubHistories  
Protected variable TArray< const FNode * > CallingContext Contains the hierarchy of nodes leading to the current graph being processed.
Protected variable TArray< const FGraph * > CallingGraphContext Contains the hierarchy of graphs leading to and including the current graph being processed.
Public variable TPimplPtr< FConstantResolver, EPimplPtrMode::DeepCopy > ConstantResolver  
Protected variable TArray< FString > Constants  
Protected variable TArray< TArray< const FNode * > > ContextuallyVisitedNodes List of previously visited nodes per context.
Public variable int32 CurrentGraphDepth  
Protected variable TArray< FName > EmitterNameContextStack Contains the hierarchy of emitter node names leading to the current graph being processed.
Protected variable TArray< FNiagaraVariable > EncounterableExternalVariables  
Protected variable TArray< FString > EncounteredEmitterNames  
Protected variable TArray< TArray< FString > > EncounteredFunctionNames  
Public variable TOptional< FGuid > ExclusiveEmitterHandle An optional emitter handle guid you can register.
Protected variable ENiagaraScriptUsage FilterScriptType What the script type is that we should be filtering to if the allow list is enabled.
Protected variable TArray< FName > FunctionNameContextStack Contains the hierarchy of function call node names leading to the current graph being processed.
Public variable TArray< FHistory > Histories Collection of the build histories from the graph traversal.
Public variable int32 MaxGraphDepthTraversal  
Public variable FOnNodeVisited OnNodeVisitedDelegate  
Protected variable TArray< TMap< const FPin *, int32 > > PinToConstantIndices  
Protected variable TArray< TMap< const FPin *, int32 > > PinToParameterMapIndices Tracker for each context level of the parameter map index associated with a given pin.
Protected variable TArray< ENiagaraScriptUsage > RelevantScriptUsageContext Keeps track of the script usage at the current context level.
Protected variable FNiagaraAliasContext ResolveAliasContext Resolved alias map for the current context level. Rebuilt by BuildCurrentAliases.
Protected variable TArray< FName > ScriptUsageContextNameStack  
Public variable TArray< bool > StaticVariableExportable  
Public variable TArray< FNiagaraVariable > StaticVariables  
Protected variable FNiagaraStaticVariableSearchContext StaticVariableSearchContext  
Protected variable TArray< TMap< FNiagaraVariableBase, int32 > > VariableToConstantIndices  

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function int32  
Protected function bool

AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

  
Protected function bool

AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

  
Protected function bool

AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

  
Public function Virtual int32

AddVariableToHistory ( FHistory& History,
const FNiagaraVariable& InVar,
const FNiagaraVariable& InAliasedVar,
const FPin* InPin
)

 Virtual wrapper to call correct AddVariable method on the target ParameterMapHistory.
Public function uint32

BeginNodeVisitation ( int32 WhichParameterMap,
const FNode* Node
)

  
Public function void

BeginTranslation ( const UNiagaraEmitter* Emitter
)

  
Public function void

BeginTranslation ( const FString& EmitterUniqueName
)

  
Public function void

BeginTranslation ( const UNiagaraScript* Script
)

  
Public function void

BeginUsage ( ENiagaraScriptUsage InUsage,
FName InStageName
)

  
Protected function void Generate the internal alias map from the current traversal state.
Public function void

BuildParameterMaps ( const FOutputNode* OutputNode,
bool bRecursive
)

 Called in order to set up the correct initial context for an Output node and invokes the UNiagaraNodeOutput's BuildParameterMapHistory method.
Public function Const bool  
Public function int32 Add a new parameter map to the array.
Public function void

EnableScriptAllowList ( bool bInEnable,
ENiagaraScriptUsage InScriptType
)

 In some cases, we don't want all the variables encountered in a traversal.
Public function void

EndNodeVisitation ( int32 WhichParameterMap,
uint32 IndexFromBeginNode
)

  
Public function void

EndTranslation ( const UNiagaraScript* Script
)

  
Public function void

EndTranslation ( const UNiagaraEmitter* Emitter
)

  
Public function void

EndTranslation ( const FString& EmitterUniqueName
)

  
Public function void  
Public function void

EnterEmitter ( const FString& InEmitterName,
const FGraph* InGraph,
const FNode* Node
)

 Record that we have entered an emitter scope.
Public function void

EnterFunction ( const FString& InNodeName,
const FGraph* InGraph,
const FNode* Node
)

 Record that we have entered a new function scope.
Public function void

ExitEmitter ( const FString& InEmitterName,
const FNode* Node
)

 Record that we have exited an emitter scope.
Public function void

ExitFunction ( const FNode* Node
)

 Record that we have exited a function scope.
Public function Const int32 Helper method to identify any matching input nodes from the calling context node to the input variable.
Public function Const int32  
Public function Const int32  
Public function Const ENiagaraScriptUsage  
Public function Const const FNode * Get the node calling this sub-graph.
Public function FString

GetConstant ( int32 InIndex
)

  
Public function Const int32

GetConstantFromInputPin ( const FInputPin* InputPin
)

  
Public function Const int32

GetConstantFromOutputPin ( const FOutputPin* OutputPin
)

  
Public function int32  
Public function void

GetContextuallyVisitedNodes ( TArray< const FNode* >& OutVistedNodes
)

  
Public function Const ENiagaraScriptUsage  
Public function Const const FString * Get the string that the "Emitter" namespace maps to currently (if it exists)
Public function Const const TArray< FNiagaraVariable > &  
Public function Const bool  
Public function Const bool  
Public function Const const FString * Get the string that the "Module" namespace maps to currently (if it exists)
Public function Const bool Has RegisterNodeVisitation been called on the input node yet?
Public function Const bool

GetPinPreviouslyVisited ( const FPin* InPin
)

 Has RegisterNodeVisitation been called yet on the owning node of this pin?
Public function int32

HandleExternalVariableRead ( int32 ParamMapIdx,
const FName& InVarName
)

  
Public function void

HandleParameterCollectionRead ( const FNiagaraVariableBase& InVar,
int32 ParamMapIndex
)

  
Public function int32

HandleVariableRead ( int32 ParameterMapIndex,
const FPin* InPin,
bool RegisterReadsAsVariables,
const FInputPin* InDefaultPin,
bool bFilterForCompilation,
bool& OutUsedDefault
)

 Record that a pin reads from the parameter map.
Public function int32

HandleVariableWrite ( int32 ParameterMapIndex,
const FNiagaraVariable& Var
)

 Record that a variable write to the parameter map.
Public function int32

HandleVariableWrite ( int32 ParameterMapIndex,
const FInputPin* InPin
)

 Record that a pin writes to the parameter map.
Public function Const bool  
Public function void  
Public function Const bool Are we currently in a top-level function call context (ie a node in the main graph or an argument into a function for the main graph.)
Public function Const bool  
Public function Const bool  
Protected function bool Helper method used to take in input script type and determine if the passed in namespaced variable is worth tracking.
Protected function Const bool Internal helper function to decide whether or not we should use this static variable when merging with other graph traversal static variables, like Emitter graphs merging with System graphs.
Public function int32

RegisterConstantFromInputPin ( const FInputPin* InputPin,
const FString& PinDefaultValue
)

  
Public function int32

RegisterConstantPin ( int32 WhichConstant,
const FPin* Pin
)

  
Public function int32

RegisterConstantVariableWrite ( int32 WhichParamMapIdx,
int32 WhichConstant,
int32 WhichVarIdx,
bool bIsSettingDefault,
bool bLinkNotValue
)

  
Public function void

RegisterDataSetWrite ( int32 WhichParameterMap,
const FNiagaraDataSetID& DataSet
)

 Records a write to a DataSet in the appropriate parameter map history
Public function void

RegisterEncounterableVariables ( TConstArrayView< FNiagaraVariable > Variables
)

 Register any user or other external variables that could possibly be encountered but may not be declared explicitly.
Public function void

RegisterExternalStaticVariables ( TConstArrayView< FNiagaraVariable > Variables
)

  
Public function void

RegisterNodeVisitation ( const FNode* Node
)

 Called first during a node's visitation during traversal to identify that a node has been visited.
Public function int32

RegisterParameterMapPin ( int32 WhichParameterMap,
const FPin* Pin
)

 Important.
Public function Const FNiagaraVariable

ResolveAliases ( const FNiagaraVariable& InVar
)

 Use the current alias map to resolve any aliases in this input variable name.
Public function void

SetConstantByStaticVariable ( int32& OutValue,
const FInputPin* InDefaultPin
)

  
Public function void  
Public function void

SetIgnoreDisabled ( bool bInIgnore
)

  
Public function void  
Public function bool  
Protected function bool Helper function called when variables are added to enable the filtering specified in EnableScriptAllowList.
Public function int32

TraceParameterMapOutputPin ( const FOutputPin* OutputPin
)

 Trace back a pin to whom it was connected to to find the current parameter map to use.
Public function void

VisitInputPin ( const FInputPin* Pin,
bool bFilterForCompilation
)

 If we haven't already visited the owning node, do so.
Public function void

VisitInputPins ( const FNode*,
bool bFilterForCompilation
)

 If we haven't already visited the owning nodes, do so.

Typedefs

Name Description
FConstantResolver  
FEmitterNode  
FGraph  
FHistory  
FInputPin  
FNode  
FOnNodeVisited  
FOutputNode  
FOutputPin  
FParameterCollection  
FPin  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page