Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Niagara > UNiagaraDataInterfaceCurveBase

Light Theme

Dark Theme

UNiagaraDataInterfaceCurveBase

Base class for curve data interfaces which facilitates handling the curve data in a standardized way.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceCurveBase

	UNiagaraDataInterfaceColorCurve
	UNiagaraDataInterfaceCurve
	UNiagaraDataInterfaceVector2DCurve
	UNiagaraDataInterfaceVector4Curve
	UNiagaraDataInterfaceVectorCurve

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Curves", Meta=(DisplayName="Float Curve"))
class UNiagaraDataInterfaceCurveBase : public UNiagaraDataInterface

Remarks

Base class for curve data interfaces which facilitates handling the curve data in a standardized way.

Variables

	Name	Description
uint32: 1	bExposeCurve	Generates a texture for the curve which can be exposed to material bindings.
uint32: 1	bOptimizeLUT	Do we optimize the LUT, this saves memory but may introduce errors.
uint32: 1	bOverrideOptimizeThreshold
uint32: 1	bUseLUT
FName	ExposedName	Sets a custom name for the binding to make it easier to identify.
UTexture2D *...	ExposedTexture	The texture generated and exposed to materials, will be nullptr if we do not expose to the renderers.
uint32: 1	HasEditorData
float	LUTInvTimeRange
float	LUTMaxTime
float	LUTMinTime
float	LUTNumSamplesMinusOne
float	OptimizeThreshold	Threshold used to optimize the LUT.
TArray< float >	ShaderLUT

Constructors

	Name	Description
	UNiagaraDataInterfaceCurveBase()
	UNiagaraDataInterfaceCurveBase ( FObjectInitializer const& ObjectIn... )

Functions

	Name	Description
TArray< floa...	BuildLUT ( int32 NumEntries )
bool	CompareLUTS ( const TArray< float >& OtherLUT )
void	GetCurveData ( TArray< FCurveData >& OutCurveData )	Gets information for all of the curves owned by this curve data interface.
int32	GetCurveNumElems()
float	GetInvTimeRange()
float	GetMaxTime()
float	GetMinTime()
float	NormalizeTime ( float T )	Remap a sample time for this curve to 0 to 1 between first and last keys for LUT access.
void	OptimizeLUT()
void	SetDefaultLUT()
float	UnnormalizeTime ( float T )	Remap a 0 to 1 value between the first and last keys to a real sample time for this curve.
void	UpdateExposedTexture()
void	UpdateLUT ( bool bFromSerialize )
void	UpdateTimeRanges()

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CanExposeVariables()
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
TArray< FNia...	GetErrors()	Refreshes and returns the errors detected with the corresponding data, if any.
void	GetExposedVariables ( TArray< FNiagaraVariableBase >& Ou... )
bool	GetExposedVariableValue ( const FNiagaraVariableBase& InVari..., void* InPerInstanceData, FNiagaraSystemInstance* InSyst..., void* OutData )
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )
void	PushToRenderThreadImpl()

Overridden from UNiagaraDataInterfaceBase

	Name	Description
void	BindParameters ( FNiagaraDataInterfaceParametersCS&..., const FNiagaraDataInterfaceGPUParam..., const FShaderParameterMap& Paramet... )	Methods that operate on an instance of type FNiagaraDataInterfaceParametersCS*, created by the above CreateComputeParameters() method
FNiagaraData...	CreateComputeParameters()	Constructs the correct CS parameter type for this DI (if any).
const FTypeL...	GetComputeParametersTypeDesc()
void	SetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )
void	UnsetParameters ( const FNiagaraDataInterfaceParamete..., FRHICommandList& RHICmdList, const FNiagaraDataInterfaceSetArgs ... )

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Classes

	Name	Description
	FCurveData	Structure to facilitate getting standardized curve information from a curve data interface.

Constants

Name	Description
CurveLUTDefaultWidth
DefaultOptimizeThreshold

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss