1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceCurveBase

UNiagaraDataInterfaceCurveBase

API > API/Plugins > API/Plugins/Niagara

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

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

Syntax

UCLASS (EditInlineNew, Abstract, MinimalAPI)  
class UNiagaraDataInterfaceCurveBase : public UNiagaraDataInterface

Inheritance Hierarchy

Derived Classes

UNiagaraDataInterfaceCurveBase derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  NiagaraDataInterfaceCurveBase.h  

UNiagaraDataInterfaceCurveBase ( FObjectInitializer const& ObjectInitializer
)

   NiagaraDataInterfaceCurveBase.h  

Structs

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

Enums

Public

Name Remarks
UNiagaraDataInterfaceCurveBase  

Constants

Name Type Remarks Include Path
DefaultOptimizeThreshold float   NiagaraDataInterfaceCurveBase.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bExposeCurve uint32 Generates a texture for the curve which can be exposed to material bindings. NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
  • Meta=(DisplayName="Expose Curve to Material")
bOptimizeLUT uint32 Do we optimize the LUT, this saves memory but may introduce errors. NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
bOverrideOptimizeThreshold uint32   NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
bUseLUT uint32   NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
CurveAsset TObjectPtr< UCurveBase >   NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • Category="Curve"
ExposedName FName Sets a custom name for the binding to make it easier to identify. NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
  • Meta=(DisplayName="Exposed Curve Name")
ExposedTexture TObjectPtr< class UTexture2D > The texture generated and exposed to materials, will be nullptr if we do not expose to the renderers. NiagaraDataInterfaceCurveBase.h  
HasEditorData uint32   NiagaraDataInterfaceCurveBase.h
  • Transient
OptimizeThreshold float Threshold used to optimize the LUT. NiagaraDataInterfaceCurveBase.h
  • EditAnywhere
  • AdvancedDisplay
  • Category="Curve"
  • Meta=(EditCondition="bOverrideOptimizeThreshold")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TArray< float > BuildLUT ( int32 NumEntries
) const

   NiagaraDataInterfaceCurveBase.h  

virtual void GetCurveData ( TArray< FCurveData >& OutCurveData
)

 Gets information for all of the curves owned by this curve data interface. NiagaraDataInterfaceCurveBase.h  

virtual int32 GetCurveNumElems()

   NiagaraDataInterfaceCurveBase.h  

virtual FName GetCurveSampleFunctionName()

   NiagaraDataInterfaceCurveBase.h  

float GetInvTimeRange()

   NiagaraDataInterfaceCurveBase.h  

float GetMaxTime()

   NiagaraDataInterfaceCurveBase.h  

float GetMinTime()

   NiagaraDataInterfaceCurveBase.h  

void OptimizeLUT()

   NiagaraDataInterfaceCurveBase.h  

void SetDefaultLUT()

   NiagaraDataInterfaceCurveBase.h  

virtual void SyncCurvesToAsset()

   NiagaraDataInterfaceCurveBase.h  

void UpdateExposedTexture()

   NiagaraDataInterfaceCurveBase.h  

void UpdateLUT ( bool bFromSerialize
)

   NiagaraDataInterfaceCurveBase.h  

virtual void UpdateTimeRanges()

   NiagaraDataInterfaceCurveBase.h  

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

virtual void CacheStaticBuffers ( FNiagaraSystemStaticBuffers& StaticBuffers,
const FNiagaraVariable& ResolvedVariable,
bool bUsedByCPU,
bool bUsedByGPU
)

 Allows data interfaces to cache any static data that may be shared between instances NiagaraDataInterfaceCurveBase.h  

virtual bool CanExecuteOnTarget ( ENiagaraSimTarget Target
) const

   NiagaraDataInterfaceCurveBase.h  

virtual bool CanExposeVariables()

   NiagaraDataInterfaceCurveBase.h  

virtual bool Equals ( const UNiagaraDataInterface* Other
) const

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

virtual TArray< FNiagaraDataInterfaceError > GetErrors()

 Refreshes and returns the errors detected with the corresponding data, if any. NiagaraDataInterfaceCurveBase.h  

virtual void GetExposedVariables ( TArray< FNiagaraVariableBase >& OutVariables
) const

   NiagaraDataInterfaceCurveBase.h  

virtual bool GetExposedVariableValue ( const FNiagaraVariableBase& InVariable,
void* InPerInstanceData,
FNiagaraSystemInstance* InSystemInstance,
void* OutData
) const

   NiagaraDataInterfaceCurveBase.h  

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

   NiagaraDataInterfaceCurveBase.h  

virtual void PostCompile ( const UNiagaraSystem& OwningSystem
)

 Called after system compilation completes. Useful for caching any constant, compile dependent data. NiagaraDataInterfaceCurveBase.h  
Set the shader parameters will only be called if the data interface provided shader parameters. NiagaraDataInterfaceCurveBase.h  

Overridden from UNiagaraDataInterfaceBase

Name Remarks Include Path Unreal Specifiers

virtual void BuildShaderParameters ( FNiagaraShaderParametersBuilder& ShaderParametersBuilder
) const

   NiagaraDataInterfaceCurveBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   NiagaraDataInterfaceCurveBase.h  

virtual void PostLoad()

   NiagaraDataInterfaceCurveBase.h  

virtual void Serialize ( FArchive& Ar
)

   NiagaraDataInterfaceCurveBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool CompareLUTS ( const TArray< float >& OtherLUT
) const

   NiagaraDataInterfaceCurveBase.h  

float NormalizeTime ( float T
) const

 Remap a sample time for this curve to 0 to 1 between first and last keys for LUT access. NiagaraDataInterfaceCurveBase.h  

float UnnormalizeTime ( float T
) const

 Remap a 0 to 1 value between the first and last keys to a real sample time for this curve. NiagaraDataInterfaceCurveBase.h  

Overridden from UNiagaraDataInterface

Name Remarks Include Path Unreal Specifiers

virtual bool CopyToInternal ( UNiagaraDataInterface* Destination
) const

   NiagaraDataInterfaceCurveBase.h  

virtual void PushToRenderThreadImpl()

   NiagaraDataInterfaceCurveBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page