1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceSpline

UNiagaraDataInterfaceSpline

Data Interface allowing sampling of in-world spline components.

API > API/Plugins > API/Plugins/Niagara

Data Interface allowing sampling of in-world spline components. Note that this data interface is very experimental.

   
Name UNiagaraDataInterfaceSpline
Type class
Header File /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceSpline.h
Include Path #include "NiagaraDataInterfaceSpline.h"

Syntax

UCLASS (EditInlineNew, Category="Splines", CollapseCategories, Meta=(DisplayName="Spline"),  
       MinimalAPI)  
class UNiagaraDataInterfaceSpline : public UNiagaraDataInterface

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraDataInterfaceSpline ( const FObjectInitializer& ObjectInitializer
)

   NiagaraDataInterfaceSpline.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseLUT bool   NiagaraDataInterfaceSpline.h
  • EditAnywhere
  • Category="Spline"
NumLUTSteps int32   NiagaraDataInterfaceSpline.h
  • EditAnywhere
  • Category="Spline"
  • Meta=(EditCondition="bUseLuT")
SoftSourceActor TSoftObjectPtr< AActor > The source actor from which to sample. NiagaraDataInterfaceSpline.h
  • EditAnywhere
  • Category="Mesh"
  • Meta=(DisplayName="Source Actor")
SplineUserParameter FNiagaraUserParameterBinding Reference to a user parameter if we're reading one. NiagaraDataInterfaceSpline.h
  • EditAnywhere
  • Category="Spline"

Protected

Name Type Remarks Include Path Unreal Specifiers
SystemInstancesToProxyData_GT TMap< FNiagaraSystemInstanceID, FNDISpline_InstanceData * >   NiagaraDataInterfaceSpline.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void FindClosestUnitDistanceFromPositionWS ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void GetLocalToWorld ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void GetLocalToWorldInverseTransposed ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplineDirectionByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplinePositionByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplineRightVectorByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplineRotationByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplineTangentByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void SampleSplineUpVectorByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

void VMGetSplineLength ( FVectorVMExternalFunctionContext& Context
)

   NiagaraDataInterfaceSpline.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceSpline.h  

virtual void DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface. NiagaraDataInterfaceSpline.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

 Determines if this DataInterface is the same as another. NiagaraDataInterfaceSpline.h  

virtual void GetVMExternalFunction ( const FVMExternalFunctionBindingInfo& BindingInfo,
void* InstanceData,
FVMExternalFunction& OutFunc
)

 Returns the delegate for the passed function signature. NiagaraDataInterfaceSpline.h  

virtual bool HasPreSimulateTick()

   NiagaraDataInterfaceSpline.h  

virtual bool InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface. NiagaraDataInterfaceSpline.h  
The size of the data this class will provide to ProvidePerInstanceDataForRenderThread. NiagaraDataInterfaceSpline.h  

virtual int32 PerInstanceDataSize ()

 Returns the size of the per instance data for this interface. NiagaraDataInterfaceSpline.h  

virtual bool PerInstanceTick ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance,
float DeltaSeconds
)

 Ticks the per instance data for this interface, if it has any. NiagaraDataInterfaceSpline.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   NiagaraDataInterfaceSpline.h  

virtual void PostLoad()

   NiagaraDataInterfaceSpline.h  

Protected

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool AppendCompileHash ( FNiagaraCompileHashVisitor* InVisitor
) const

 Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile. NiagaraDataInterfaceSpline.h  

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceSpline.h  

virtual void GetCommonHLSL ( FString& OutHLSL
)

 Allows data interfaces to provide common functionality that will be shared across interfaces on that type. NiagaraDataInterfaceSpline.h  

virtual bool GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
const FNiagaraDataInterfaceGeneratedFunction& FunctionInfo,
int FunctionInstanceIndex,
FString& OutHLSL
)

   NiagaraDataInterfaceSpline.h  

virtual void GetFunctionsInternal ( TArray< FNiagaraFunctionSignature >& OutFunctions
) const

   NiagaraDataInterfaceSpline.h  

virtual void GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParamInfo& ParamInfo,
FString& OutHLSL
)

   NiagaraDataInterfaceSpline.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceSpline.h  

virtual bool UpgradeFunctionCall ( FNiagaraFunctionSignature& FunctionSignature
)

 Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade. NiagaraDataInterfaceSpline.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceSpline.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Source_DEPRECATED TObjectPtr< AActor >   NiagaraDataInterfaceSpline.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page