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 > UNiagaraDataInterfaceVectorField

Light Theme

Dark Theme

UNiagaraDataInterfaceVectorField

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceVectorField

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Vector Field", Meta=(DisplayName="Vector Field"))
class UNiagaraDataInterfaceVectorField : public UNiagaraDataInterface

Variables

	Name	Description
bool	bTileX
bool	bTileY
bool	bTileZ
UVectorField &#...	Field	Vector field to sample from.

Constructors

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

Functions

	Name	Description
FVector	GetDimensions()
void	GetFieldBounds ( FVectorVMContext& Context )
void	GetFieldDimensions ( FVectorVMContext& Context )	VM functions.
void	GetFieldTilingAxes ( FVectorVMContext& Context )
FVector	GetMaxBounds()
FVector	GetMinBounds()
FVector	GetTilingAxes()
void	PushToRenderThread()
void	SampleVectorField ( FVectorVMContext& Context )

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )
bool	Equals ( const UNiagaraDataInterface* O... )	Determines if this DataInterface is the same as another.
TArray< FNia...	GetErrors()	Editor functionality.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	VM functionality.
void	GetParameterDefinitionHLSL ( const FNiagaraDataInterfaceGPUParam..., FString& OutHLSL )	GPU sim functionality.
void	GetVMExternalFunction ( const FVMExternalFunctionBindingInf..., void* InstanceData, FVMExternalFunction& OutFunc )	Returns the delegate for the passed function signature.

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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

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

Take our survey

Dismiss