UNiagaraDataInterfaceVelocityGrid

Data Interface for the strand base

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceRWBase

UNiagaraDataInterfaceVelocityGrid

UNiagaraDataInterfacePressureGrid

References

Module	HairStrandsCore
Header	/Engine/Plugins/Runtime/HairStrands/Source/HairStrandsCore/Public/Niagara/NiagaraDataInterfaceVelocityGrid.h
Include	#include "Niagara/NiagaraDataInterfaceVelocityGrid.h"

Syntax

UCLASS(EditInlineNew, Category="Grid", Meta=(DisplayName="Velocity Grid"))
class UNiagaraDataInterfaceVelocityGrid : public UNiagaraDataInterfaceRWBase

Remarks

Data Interface for the strand base

Variables

		Name	Description
	FIntVector	GridSize	Grid size along the X axis.
	int32	NumAttributes	Num Attributes

Constructors

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

Functions

	Name	Description
void	BuildVelocityField ( FVectorVMExternalFunctionContext& ... )	Build the velocity field
void	ComputeGridSize ( FVectorVMExternalFunctionContext& ... )	Compute the grid Size (Origin and length)
void	SampleVelocityField ( FVectorVMExternalFunctionContext& ... )	Sample the grid
void	SetGridDimension ( FVectorVMExternalFunctionContext& ... )	Set the grid dimension
void	UpdateGridTransform ( FVectorVMExternalFunctionContext& ... )	Update the grid transform

Overridden from UNiagaraDataInterface

	Name	Description
bool	AppendCompileHash ( FNiagaraCompileHashVisitor* In... )	GPU simulation functionality
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )	Copy one niagara DI to this
void	DestroyPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Destroys the per instance data for this interface.
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
void	GetCommonHLSL ( FString& OutHLSL )	Allows data interfaces to provide common functionality that will be shared across interfaces on that type.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	UNiagaraDataInterface Interface
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.
bool	InitPerInstanceData ( void* PerInstanceData, FNiagaraSystemInstance* System... )	Initializes the per instance data for this interface.
int32	PerInstanceDataSize()	Returns the size of the per instance data for this interface.
bool	PerInstanceTick ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )	Ticks the per instance data for this interface, if it has any.
void	ProvidePerInstanceDataForRenderThread ( void* DataForRenderThread, void* PerInstanceData, const FNiagaraSystemInstanceID& Sy... )	Subclasses that wish to work with GPU systems/emitters must implement this.

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	PostInitProperties()	UObject Interface

Constants

Name	Description
GridCurrentBufferName	Name of the grid current buffer
GridDestinationBufferName	Name of the grid X velocity buffer
GridSizeName	Name of the grid size
WorldInverseName	Name of the World transform inverse
WorldTransformName	Name of the world transform