1. Epic GamesDeveloper
  3. FNiagaraCompilationGraphBridge

FNiagaraCompilationGraphBridge

These two structures represent a way to abstract the implementation details of the graph structure that is being used for the different pieces of code related to compiling Niagara systems.

API > API/Plugins > API/Plugins/NiagaraEditor

References

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

Syntax

struct FNiagaraCompilationGraphBridge

Remarks

These two structures represent a way to abstract the implementation details of the graph structure that is being used for the different pieces of code related to compiling Niagara systems. The GraphBridge handles the standard editor objects for graphs & nodes (UNiagaraGraph and UNiagaraNode respectively) with the remaining types following from that. The DigestBridge represents the digested graphs and nodes that we use to be able to compile Niagara systems async where the graphs & nodes are FNiagaraCompilationGraphFNiagaraCompilationNode respectively.

The bridge class is used as a template argument for the following classes (and supplementary functions/classes): -FNiagaraParameterMapHistory -FNiagaraParameterMapHistoryBuilder -FNiagaraHlslTranslator

This allows us to have the logic for these classes unified between the different graph representations without having to write two versions of the code.

Functions

  Type Name Description
Public function Static void

AddCollectionPaths ( const FParamMapHistory& History,
TArray< FString >& Paths
)

  
Public function Static const FCustomHlslNode *

AsCustomHlslNode ( const FNode* Node
)

  
Public function Static const FFunctionCallNode *

AsFunctionCallNode ( const FNode* Node
)

 Various cast functions
Public function Static const FInputNode *

AsInputNode ( const FNode* Node
)

  
Public function Static const FOutputNode *

AsOutputNode ( const FNode* Node
)

  
Public function Static const FParamMapGetNode *

AsParamMapGetNode ( const FNode* Node
)

  
Public function Static const FParamMapSetNode *

AsParamMapSetNode ( const FNode* Node
)

  
Public function Static void

BuildTraversal ( const FGraph* Graph,
const FNode* OutputNode,
TArray< const FNode* >& TraversedNodes
)

  
Public function Static bool

CanCreateConnection ( const FOutputPin* OutputPin,
const FInputPin* InputPin,
FText& FailureMessage
)

  
Public function Static bool

CustomHlslReferencesTokens ( const FCustomHlslNode* CustomNode,
TConstArrayView< FStringView > TokenStrings
)

  
Public function Static void

FindOutputNodes ( const FGraph* Graph,
TArray< const FOutputNode* >& OutputNodes
)

  
Public function Static void

FindOutputNodes ( const FGraph* Graph,
ENiagaraScriptUsage ScriptUsage,
TArray< const FOutputNode* >& OutputNodes
)

  
Public function Static UNiagaraDataInterface *  
Public function Static FString  
Public function Static UObject *  
Public function Static const TArray< FConvertConnection > &

GetConvertConnections ( const FConvertNode* ConvertNode
)

  
Public function Static void

GetCustomHlslIncludePaths ( const FCustomHlslNode* CustomNode,
TArray< FNiagaraCustomHlslInclude >& Includes
)

  
Public function Static FString

GetCustomHlslString ( const FCustomHlslNode* CustomNode
)

  
Public function Static ENiagaraScriptUsage

GetCustomHlslUsage ( const FCustomHlslNode* CustomNode
)

  
Public function Static const FInputPin *

GetDefaultPin ( const FParamMapGetNode* GetNode,
const FOutputPin* OutputPin
)

  
Public function Static const FGraph *

GetEmitterGraph ( const FEmitterNode* EmitterNode
)

  
Public function Static FString

GetEmitterHandleIdString ( const FEmitterNode* EmitterNode
)

  
Public function Static FString

GetEmitterName ( const FEmitterNode* EmitterNode
)

  
Public function Static FString

GetEmitterPathName ( const FEmitterNode* EmitterNode
)

  
Public function Static FString

GetEmitterUniqueName ( const FEmitterNode* EmitterNode
)

  
Public function Static ENiagaraScriptUsage

GetEmitterUsage ( const FEmitterNode* EmitterNode
)

  
Public function Static FString

GetFunctionFullName ( const FFunctionCallNode* FunctionCall
)

  
Public function Static FString

GetFunctionName ( const FFunctionCallNode* FunctionCall
)

  
Public function Static const FGraph *

GetFunctionNodeGraph ( const FFunctionCallNode* FunctionCall
)

  
Public function Static FString

GetFunctionScriptName ( const FFunctionCallNode* FunctionCall
)

  
Public function Static ENiagaraScriptUsage

GetFunctionUsage ( const FFunctionCallNode* FunctionCall
)

  
Public function Static const FGraph *

GetGraph ( const FCompilationCopy* CompilationCopy
)

  
Public function Static TOptional< ENiagaraDefaultMode >

GetGraphDefaultMode ( const FGraph* Graph,
const FNiagaraVariable& Variable,
FNiagaraScriptVariableBinding& Binding
)

  
Public function Static TArray< const FInputNode * >

GetGraphInputNodes ( const FGraph* Graph,
const FNiagaraFindInputNodeOptions& Options
)

  
Public function Static TArray< FNiagaraVariable >  
Public function Static bool  
Public function Static const FInputPin *

GetInputPin ( const FNode* Node,
int32 PinIndex
)

  
Public function Static TArray< const FInputPin * >

GetInputPins ( const FNode* Node
)

 Retrieves all input pins (excluding any add pins that may be present)
Public function Static FNiagaraVariable

GetInputVariable ( const FInputNode* InputNode
)

  
Public function Static const FOutputPin *

GetLinkedOutputPin ( const FInputPin* InputPin
)

  
Public function Static FNode *

GetMutableOwningNode ( const FPin* Pin
)

  
Public function Static const FEmitterNode *

GetNodeAsEmitter ( const FNode* Node
)

  
Public function Static FString

GetNodeClassName ( const FNode* Node
)

  
Public function Static FString

GetNodeName ( const FNode* Node
)

  
Public function Static FString

GetNodeTitle ( const FNode* Node
)

  
Public function Static ENiagaraScriptUsage

GetOutputNodeScriptType ( const FOutputNode* OutputNode
)

  
Public function Static FGuid

GetOutputNodeScriptTypeId ( const FOutputNode* OutputNode
)

  
Public function Static TOptional< FName >  
Public function Static ENiagaraScriptUsage

GetOutputNodeUsage ( const FOutputNode* OutputNode
)

  
Public function Static FGuid

GetOutputNodeUsageId ( const FOutputNode* OutputNode
)

  
Public function Static TArray< const FOutputPin * >

GetOutputPins ( const FNode* Node
)

 Retrieves all output pins (excluding both orphaned pins and add pins)
Public function Static const TArray< FNiagaraVariable > &

GetOutputVariables ( const FOutputNode* OutputNode
)

  
Public function Static const FGraph *

GetOwningGraph ( const FNode* Node
)

  
Public function Static const FNode *

GetOwningNode ( const FPin* Pin
)

  
Public function Static const FInputPin *

GetPinAsInput ( const FPin* Pin
)

  
Public function Static FText

GetPinDisplayName ( const FPin* Pin
)

  
Public function Static FText

GetPinFriendlyName ( const FPin* Pin
)

  
Public function Static int32

GetPinIndexById ( TConstArrayView< const FPin* > Pins,
const FGuid& PinId
)

  
Public function Static TArray< const FPin * >

GetPins ( const FNode* Node
)

 Gets all pins assoicated with the node
Public function Static FNiagaraTypeDefinition

GetPinType ( const FPin* Pin,
ENiagaraStructConversion Conversion
)

  
Public function Static FNiagaraVariable

GetPinVariable ( const FPin* Pin,
bool bNeedsValue,
ENiagaraStructConversion Conversion
)

  
Public function Static const FOutputPin *

GetSelectOutputPin ( const FSelectNode* SelectNode,
const FNiagaraVariableBase& Variable
)

  
Public function Static TOptional< ENiagaraDefaultMode >  
Public function Static TArray< FNiagaraVariableBase >  
Public function Static bool

GraphHasParametersOfType ( const FGraph* Graph,
const FNiagaraTypeDefinition& TypeDef
)

  
Public function Static bool  
Public function Static bool

IsGraphEmpty ( const FGraph* Graph
)

  
Public function Static bool

IsParameterMapGet ( const FNode* Node
)

  
Public function Static bool

IsParameterMapPin ( const FPin* Pin
)

  
Public function Static bool

IsStaticPin ( const FPin* Pin
)

  
Public function Static bool

NodeIsEnabled ( const FNode* Node
)

  

Classes

  Type Name Description
Public struct FAvailableParameterCollections    
Public class FBuilderExtraData Used as a base class for the FNiagaraParameterMapHistoryBuilder to store additional data that is specific to the graph representation  
Public struct FParameterCollectionStore Additional data for extending the ParameterMapHistoryBuilder  

Typedefs

Name Description
FCompilationCopy  
FConstantResolver  
FConvertConnection  
FConvertNode  
FCustomHlslNode  
FEmitterNode  
FFunctionCallNode  
FGraph Base types
FGraphFunctionAliasContext  
FGraphTraversalHandle  
FIfNode  
FInputNode  
FInputPin  
FModuleScopedPin  
FNode  
FOpNode  
FOutputNode  
FOutputPin  
FParameterCollection  
FParamMapForNode  
FParamMapGetNode  
FParamMapHistory  
FParamMapHistoryBuilder  
FParamMapSetNode  
FPin  
FPrecompileData  
FSelectNode  
FStaticSwitchNode  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page