1. Epic GamesDeveloper
  3. UNiagaraDataInterfaceCurveBase

UNiagaraDataInterfaceCurveBase

Copyright Epic Games, Inc. All Rights Reserved.

Unreal Engine C++ API Reference > Plugins > Niagara

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;EditInlineNew, Abstract, MinimalAPI&41;  
class UNiagaraDataInterfaceCurveBase : public UNiagaraDataInterface

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function    
Public function  

UNiagaraDataInterfaceCurveBase ( FObjectInitializer const& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const TArray< float >

BuildLUT ( int32 NumEntries
)

  
Protected function Virtual Const bool

CompareLUTS ( const TArray< float >& OtherLUT
)

  
Public function Virtual void

GetCurveData ( TArray< FCurveData >& OutCurveData
)

 Gets information for all of the curves owned by this curve data interface.
Public function Virtual Const int32  
Public function Virtual Const FName  
Public function Const float  
Public function Const float  
Public function Const float  
Protected function Const float

NormalizeTime ( float T
)

 Remap a sample time for this curve to 0 to 1 between first and last keys for LUT access.
Public function void  
Public function void  
Public function Virtual void  
Protected function Const float

UnnormalizeTime ( float T
)

 Remap a 0 to 1 value between the first and last keys to a real sample time for this curve.
Public function void  
Public function void

UpdateLUT ( bool bFromSerialize
)

  
Public function Virtual void  

Overridden from UNiagaraDataInterface

  Type Name Description
Public 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 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
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual Const bool  
Public function Virtual Const bool

Equals ( const UNiagaraDataInterface* Other
)

 Determines if this DataInterface is the same as another.
Public function Virtual TArray< FNiagaraDataInterfaceError > Refreshes and returns the errors detected with the corresponding data, if any.
Public function Virtual Const void  
Public function Virtual Const bool

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

  
Public function Virtual void  
Public function Virtual void Called after system compilation completes. Useful for caching any constant, compile dependent data.
Protected function Virtual void  
Public function Virtual Const void Set the shader parameters will only be called if the data interface provided shader parameters.

Overridden from UNiagaraDataInterfaceBase

  Type Name Description
Public 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

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

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

Constants

Name Description
CurveLUTDefaultWidth  
DefaultOptimizeThreshold  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page