1. Epic GamesDeveloper
  3. TNiagaraParameterMapHistoryBuilder

TNiagaraParameterMapHistoryBuilder

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name TNiagaraParameterMapHistoryBuilder
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/NiagaraParameterMapHistory.h
Include Path #include "NiagaraParameterMapHistory.h"

Syntax

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

Inheritance Hierarchy

  • GraphBridge::FBuilderExtraData → TNiagaraParameterMapHistoryBuilder

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

TNiagaraParameterMapHistoryBuilder()

 Constructor NiagaraParameterMapHistory.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~TNiagaraParameterMapHistoryBuilder()

   NiagaraParameterMapHistory.h  

Typedefs

Name Type Remarks Include Path
FConstantResolver typename GraphBridge::FConstantResolver   NiagaraParameterMapHistory.h
FEmitterNode typename GraphBridge::FEmitterNode   NiagaraParameterMapHistory.h
FGraph typename GraphBridge::FGraph   NiagaraParameterMapHistory.h
FHistory TNiagaraParameterMapHistory< GraphBridge >   NiagaraParameterMapHistory.h
FInputPin typename GraphBridge::FInputPin   NiagaraParameterMapHistory.h
FNode typename GraphBridge::FNode   NiagaraParameterMapHistory.h
FOnNodeVisited TMulticastDelegate_OneParam< void, const FNode *Node >   NiagaraParameterMapHistory.h
FOutputNode typename GraphBridge::FOutputNode   NiagaraParameterMapHistory.h
FOutputPin typename GraphBridge::FOutputPin   NiagaraParameterMapHistory.h
FParameterCollection typename GraphBridge::FParameterCollection   NiagaraParameterMapHistory.h
FPin typename GraphBridge::FPin   NiagaraParameterMapHistory.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActivePath FGraphTraversalHandle   NiagaraParameterMapHistory.h  
bShouldBuildSubHistories bool   NiagaraParameterMapHistory.h  
ConstantResolver TPimplPtr< FConstantResolver, EPimplPtrMode::DeepCopy >   NiagaraParameterMapHistory.h  
CurrentGraphDepth int32   NiagaraParameterMapHistory.h  
ExclusiveEmitterHandle TOptional< FGuid > An optional emitter handle guid you can register. NiagaraParameterMapHistory.h  
Histories TArray< FHistory > Collection of the build histories from the graph traversal. NiagaraParameterMapHistory.h  
MaxGraphDepthTraversal int32   NiagaraParameterMapHistory.h  
OnNodeVisitedDelegate FOnNodeVisited   NiagaraParameterMapHistory.h  
StaticVariableExportable TArray< bool >   NiagaraParameterMapHistory.h  
StaticVariables TArray< FNiagaraVariable >   NiagaraParameterMapHistory.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddOrGetConstantFromValue ( const FString& Value
)

   NiagaraParameterMapHistory.h  

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. NiagaraParameterMapHistory.h  

uint32 BeginNodeVisitation ( int32 WhichParameterMap,
const FNode* Node
)

   NiagaraParameterMapHistory.h  

void BeginTranslation ( const UNiagaraEmitter* Emitter
)

   NiagaraParameterMapHistory.h  

void BeginTranslation ( const FString& EmitterUniqueName
)

   NiagaraParameterMapHistory.h  

void BeginTranslation ( const UNiagaraScript* Script
)

   NiagaraParameterMapHistory.h  

void BeginUsage ( ENiagaraScriptUsage InUsage,
FName InStageName
)

   NiagaraParameterMapHistory.h  

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. NiagaraParameterMapHistory.h  

bool ContextContains ( ENiagaraScriptUsage InUsage
) const

   NiagaraParameterMapHistory.h  

int32 CreateParameterMap()

 Add a new parameter map to the array. NiagaraParameterMapHistory.h  

void EnableScriptAllowList ( bool bInEnable,
ENiagaraScriptUsage InScriptType
)

 In some cases, we don't want all the variables encountered in a traversal. NiagaraParameterMapHistory.h  

void EndNodeVisitation ( int32 WhichParameterMap,
uint32 IndexFromBeginNode
)

   NiagaraParameterMapHistory.h  

void EndTranslation ( const UNiagaraScript* Script
)

   NiagaraParameterMapHistory.h  

void EndTranslation ( const UNiagaraEmitter* Emitter
)

   NiagaraParameterMapHistory.h  

void EndTranslation ( const FString& EmitterUniqueName
)

   NiagaraParameterMapHistory.h  

void EndUsage()

   NiagaraParameterMapHistory.h  

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

 Record that we have entered an emitter scope. NiagaraParameterMapHistory.h  

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

 Record that we have entered a new function scope. NiagaraParameterMapHistory.h  

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

 Record that we have exited an emitter scope. NiagaraParameterMapHistory.h  

void ExitFunction ( const FNode* Node
)

 Record that we have exited a function scope. NiagaraParameterMapHistory.h  

int32 FindMatchingParameterMapFromContextInputs ( const FNiagaraVariable& InVar
) const

 Helper method to identify any matching input nodes from the calling context node to the input variable. NiagaraParameterMapHistory.h  

int32 FindMatchingStaticFromContextInputs ( const FNiagaraVariable& InVar
) const

   NiagaraParameterMapHistory.h  

int32 FindStaticVariable ( const FNiagaraVariable& Var
) const

   NiagaraParameterMapHistory.h  

ENiagaraScriptUsage GetBaseUsageContext()

   NiagaraParameterMapHistory.h  

const FNode * GetCallingContext()

 Get the node calling this sub-graph. NiagaraParameterMapHistory.h  

FString GetConstant ( int32 InIndex
)

   NiagaraParameterMapHistory.h  

int32 GetConstantFromInputPin ( const FInputPin* InputPin
) const

   NiagaraParameterMapHistory.h  

int32 GetConstantFromOutputPin ( const FOutputPin* OutputPin
) const

   NiagaraParameterMapHistory.h  

int32 GetConstantFromVariableRead ( const FNiagaraVariableBase& InVar
)

   NiagaraParameterMapHistory.h  

void GetContextuallyVisitedNodes ( TArray< const FNode* >& OutVistedNodes
)

   NiagaraParameterMapHistory.h  

ENiagaraScriptUsage GetCurrentUsageContext()

   NiagaraParameterMapHistory.h  

const FString * GetEmitterAlias()

 Get the string that the "Emitter" namespace maps to currently (if it exists) NiagaraParameterMapHistory.h  

const TArray< FNiagaraVariable > & GetEncounterableVariables()

   NiagaraParameterMapHistory.h  

bool GetIgnoreDisabled()

   NiagaraParameterMapHistory.h  

bool GetIgnoreStaticRapidIterationParameters()

   NiagaraParameterMapHistory.h  

const FString * GetModuleAlias()

 Get the string that the "Module" namespace maps to currently (if it exists) NiagaraParameterMapHistory.h  

bool GetNodePreviouslyVisited ( const FNode* Node
) const

 Has RegisterNodeVisitation been called on the input node yet? NiagaraParameterMapHistory.h  

bool GetPinPreviouslyVisited ( const FPin* InPin
) const

 Has RegisterNodeVisitation been called yet on the owning node of this pin? NiagaraParameterMapHistory.h  

int32 HandleExternalVariableRead ( int32 ParamMapIdx,
const FName& InVarName
)

   NiagaraParameterMapHistory.h  

void HandleParameterCollectionRead ( const FNiagaraVariableBase& InVar,
int32 ParamMapIndex
)

   NiagaraParameterMapHistory.h  

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. NiagaraParameterMapHistory.h  

int32 HandleVariableWrite ( int32 ParameterMapIndex,
const FNiagaraVariable& Var
)

 Record that a variable write to the parameter map. NiagaraParameterMapHistory.h  

int32 HandleVariableWrite ( int32 ParameterMapIndex,
const FInputPin* InPin
)

 Record that a pin writes to the parameter map. NiagaraParameterMapHistory.h  

bool HasCurrentUsageContext()

   NiagaraParameterMapHistory.h  

void IncludeStaticVariablesOnly()

   NiagaraParameterMapHistory.h  

bool InTopLevelFunctionCall ( ENiagaraScriptUsage InFilterScriptType
) const

 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.) NiagaraParameterMapHistory.h  

bool IsInEncounteredEmitterNamespace ( const FNiagaraVariable& InVar
) const

   NiagaraParameterMapHistory.h  

bool IsInEncounteredFunctionNamespace ( const FNiagaraVariable& InVar
) const

   NiagaraParameterMapHistory.h  

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

   NiagaraParameterMapHistory.h  

int32 RegisterConstantPin ( int32 WhichConstant,
const FPin* Pin
)

   NiagaraParameterMapHistory.h  

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

   NiagaraParameterMapHistory.h  

void RegisterDataSetWrite ( int32 WhichParameterMap,
const FNiagaraDataSetID& DataSet
)

 Records a write to a DataSet in the appropriate parameter map history NiagaraParameterMapHistory.h  

void RegisterEncounterableVariables ( TConstArrayView< FNiagaraVariable > Variables
)

 Register any user or other external variables that could possibly be encountered but may not be declared explicitly. NiagaraParameterMapHistory.h  

void RegisterExternalStaticVariables ( TConstArrayView< FNiagaraVariable > Variables
)

   NiagaraParameterMapHistory.h  

void RegisterNodeVisitation ( const FNode* Node
)

 Called first during a node's visitation during traversal to identify that a node has been visited. NiagaraParameterMapHistory.h  

int32 RegisterParameterMapPin ( int32 WhichParameterMap,
const FPin* Pin
)

 Important. NiagaraParameterMapHistory.h  

FNiagaraVariable ResolveAliases ( const FNiagaraVariable& InVar
) const

 Use the current alias map to resolve any aliases in this input variable name. NiagaraParameterMapHistory.h  

void SetConstantByStaticVariable ( int32& OutValue,
const FInputPin* InDefaultPin
)

   NiagaraParameterMapHistory.h  

void SetConstantByStaticVariable ( int32& OutValue,
const FNiagaraVariable& Var
)

   NiagaraParameterMapHistory.h  

void SetIgnoreDisabled ( bool bInIgnore
)

   NiagaraParameterMapHistory.h  

void SetIgnoreStaticRapidIterationParameters ( bool bInIgnore
)

   NiagaraParameterMapHistory.h  

bool ShouldProcessDepthTraversal ( const FGraph* Graph
)

   NiagaraParameterMapHistory.h  

int32 TraceParameterMapOutputPin ( const FOutputPin* OutputPin
)

 Trace back a pin to whom it was connected to to find the current parameter map to use. NiagaraParameterMapHistory.h  

void VisitInputPin ( const FInputPin* Pin,
bool bFilterForCompilation
)

 If we haven't already visited the owning node, do so. NiagaraParameterMapHistory.h  

void VisitInputPins ( const FNode*,
bool bFilterForCompilation
)

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

Protected

Name Remarks Include Path Unreal Specifiers

bool AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

      

bool AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

      

bool AddParameterCollection ( FParameterCollection Collection,
int32 ParamMapIndex
)

   NiagaraParameterMapHistory.h  

void BuildCurrentAliases()

 Generate the internal alias map from the current traversal state. NiagaraParameterMapHistory.h  

bool IsNamespacedVariableRelevantToScriptType ( const FNiagaraVariable& InVar,
ENiagaraScriptUsage ScriptType
)

 Helper method used to take in input script type and determine if the passed in namespaced variable is worth tracking. NiagaraParameterMapHistory.h  

bool IsStaticVariableExportableToOuterScopeBasedOnCurrentContext ( const FNiagaraVariable& Var
) const

 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. NiagaraParameterMapHistory.h  

bool ShouldTrackVariable ( const FNiagaraVariable& InVar
)

 Helper function called when variables are added to enable the filtering specified in EnableScriptAllowList. NiagaraParameterMapHistory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page