1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceSpline

UNiagaraDataInterfaceSpline

Data Interface allowing sampling of in-world spline components.

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraDataInterfaceSpline.h
Include #include "NiagaraDataInterfaceSpline.h"

Syntax

UCLASS&40;EditInlineNew, Category&61;"Splines", CollapseCategories, Meta&61;&40;DisplayName&61;"Spline"&41;,  
       MinimalAPI&41;  
class UNiagaraDataInterfaceSpline : public UNiagaraDataInterface

Remarks

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere bool bUseLUT  
Public variable UProperty Category, EditAnywhere, Meta int32 NumLUTSteps  
Public variable UProperty Category, EditAnywhere TObjectPtr< AActor > Source The source actor from which to sample.
Public variable UProperty Category, EditAnywhere FNiagaraUserParameterBinding SplineUserParameter Reference to a user parameter if we're reading one.

Constructors

  Type Name Description
Public function  

UNiagaraDataInterfaceSpline ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

FindClosestUnitDistanceFromPositionWS ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetLocalToWorld ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

GetLocalToWorldInverseTransposed ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplineDirectionByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplinePositionByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplineRightVectorByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplineRotationByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplineTangentByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

SampleSplineUpVectorByUnitDistance ( FVectorVMExternalFunctionContext& Context
)

  
Public function void

VMGetSplineLength ( FVectorVMExternalFunctionContext& Context
)

  

Overridden from UNiagaraDataInterface

  Type Name Description
Protected function Virtual Const bool Allows the generic class defaults version of this class to specify any dependencies/version/etc that might invalidate the compile.
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual void

DestroyPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Destroys the per instance data for this interface.
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Protected function Virtual void

GetCommonHLSL ( FString& OutHLSL
)

 Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
Protected function Virtual bool

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

  
Public function Virtual void Gets all the available functions for this data interface.
Protected function Virtual void  
Public function Virtual void

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

 Returns the delegate for the passed function signature.
Public function Virtual Const bool  
Public function Virtual bool

InitPerInstanceData ( void* PerInstanceData,
FNiagaraSystemInstance* SystemInstance
)

 Initializes the per instance data for this interface.
Public function Virtual Const int32 The size of the data this class will provide to ProvidePerInstanceDataForRenderThread.
Public function Virtual Const int32 Returns the size of the per instance data for this interface.
Public function Virtual bool

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

 Ticks the per instance data for this interface, if it has any.
Protected function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.
Protected function Virtual bool Allows data interfaces the opportunity to rename / change the function signature and perform an upgrade.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Protected function Virtual Const void Override this method to provide parameters to the GPU (SRV / UAV / Constants / etc) The most common usage will be to provide a single structure which is nested with other parameters.

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page