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

Light Theme

Dark Theme

UNiagaraDataInterfaceStaticMesh

Data Interface allowing sampling of static meshes.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UNiagaraMergeable

UNiagaraDataInterfaceBase

UNiagaraDataInterface

UNiagaraDataInterfaceStaticMesh

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(EditInlineNew, Category="Meshes", Meta=(DisplayName="Static Mesh"))
class UNiagaraDataInterfaceStaticMesh : public UNiagaraDataInterface

Remarks

Data Interface allowing sampling of static meshes.

Variables

	Name	Description
uint32	ChangeId	Changed within the editor on PostEditChangeProperty.
UStaticMesh ...	DefaultMesh	Mesh used to sample from when not overridden by a source actor from the scene.
UStaticMesh ...	PreviewMesh	Mesh used to sample from when not overridden by a source actor from the scene.
FNDIStaticMeshS...	SectionFilter	Array of filters the can be used to limit sampling to certain sections of the mesh.
AActor *	Source	The source actor from which to sample.
UStaticMeshComp...	SourceComponent	The source component from which to sample.

Constructors

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

Functions

		Name	Description
	void	GetLocalToWorld ( FVectorVMContext& Context )
	void	GetLocalToWorldInverseTransposed ( FVectorVMContext& Context )
	void	GetTriCoordColor ( FVectorVMContext& Context )
	void	GetTriCoordNormal ( FVectorVMContext& Context )
	void	GetTriCoordPosition ( FVectorVMContext& Context )
	void	GetTriCoordPositionAndVelocity ( FVectorVMContext& Context )
	void	GetTriCoordTangents ( FVectorVMContext& Context )
	void	GetTriCoordUV ( FVectorVMContext& Context )
	void	GetVertexPosition ( FVectorVMContext& Context )
	void	GetWorldVelocity ( FVectorVMContext& Context )
	void	IsValid ( FVectorVMContext& Context )
	int32	RandomSection ( FRandomStream& RandStream, const FStaticMeshLODResources& Res, FNDIStaticMesh_InstanceData* I... )
	int32	RandomSection ( FRandomStream& RandStream, const FStaticMeshLODResources& Res, FNDIStaticMesh_InstanceData* I... )
	int32	RandomSection ( FRandomStream& RandStream, const FStaticMeshLODResources& Res, FNDIStaticMesh_InstanceData* I... )
	int32	RandomSection ( FRandomStream& RandStream, const FStaticMeshLODResources& Res, FNDIStaticMesh_InstanceData* I... )
	void	RandomSection ( FVectorVMContext& Context )
	void	RandomSection ( FVectorVMContext& Context )
	void	RandomTriCoord ( FVectorVMContext& Context )
	void	RandomTriCoord ( FVectorVMContext& Context )
	void	RandomTriCoordOnSection ( FVectorVMContext& Context )
	void	RandomTriCoordOnSection ( FVectorVMContext& Context )
	void	RandomTriCoordVertexColorFiltered ( FVectorVMContext& Context )
	void	SetDefaultMeshFromBlueprints ( UStaticMesh* MeshToUse )
	void	SetSourceComponentFromBlueprints ( UStaticMeshComponent* Componen... )
	bool	UsesSectionFilter()

Overridden from UNiagaraDataInterface

	Name	Description
bool	CanExecuteOnTarget ( ENiagaraSimTarget Target )
bool	CopyToInternal ( UNiagaraDataInterface* Destina... )	TODO: Vertex color filtering requires a bit more work.
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.
TArray< FNia...	GetErrors()	Refreshes and returns the errors detected with the corresponding data, if any.
bool	GetFunctionHLSL ( const FNiagaraDataInterfaceGPUParam..., const FNiagaraDataInterfaceGenerate..., int FunctionInstanceIndex, FString& OutHLSL )
void	GetFunctions ( TArray< FNiagaraFunctionSignature >... )	Gets all the available functions for this data 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	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.

Enums

	Name	Description
	ESampleMode

Constants

Name	Description
AreaWeightedSamplingName
InstanceInvDeltaTimeName
InstancePrevTransformName
InstanceTransformInverseTransposedName
InstanceTransformName
InstanceWorldVelocityName
MeshColorBufferName
MeshIndexBufferName
MeshSectionBufferName
MeshTangentBufferName
MeshTexCoordBufferName
MeshTriangleBufferName
MeshVertexBufferName
NumTexCoordName
SectionCountName
UseColorBufferName

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

Take our survey

Dismiss