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 > ChaosNiagara > UNiagaraDataInterfacePhysicsField

Light Theme

Dark Theme

UNiagaraDataInterfacePhysicsField

Data Interface for the strand base

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfacePhysicsField

References

Module	ChaosNiagara
Header	/Engine/Plugins/Experimental/ChaosNiagara/Source/ChaosNiagara/Classes/NiagaraDataInterfacePhysicsField.h
Include	#include "NiagaraDataInterfacePhysicsField.h"

Syntax

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

Remarks

Data Interface for the strand base

Constructors

	Name	Description
	UNiagaraDataInterfacePhysicsField()

Functions

	Name	Description
void	GetPhysicsFieldBounds ( FVectorVMContext& Context )	Get the field bounds
void	GetPhysicsFieldResolution ( FVectorVMContext& Context )	Get the field resolution
void	SamplePhysicsIntegerField ( FVectorVMContext& Context )	Sample the integer field
void	SamplePhysicsScalarField ( FVectorVMContext& Context )	Sample the scalar field
void	SamplePhysicsVectorField ( FVectorVMContext& Context )	Sample the vector field

Overridden from UNiagaraDataInterface

	Name	Description
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 )	GPU simulation functionality
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	HasPostSimulateTick()
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	PerInstanceTickPostSimulate ( void* PerInstanceData, FNiagaraSystemInstance* System..., float DeltaSeconds )
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
ClipmapBufferName	Shader attributes names
ClipmapCenterName
ClipmapCountName
ClipmapDistanceName
ClipmapExponentName
ClipmapResolutionName
IntegerTargetsName
ScalarTargetsName
TargetCountName
VectorTargetsName

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

Take our survey

Dismiss