UNiagaraDataInterfaceStaticMesh Class Reference

Data Interface allowing sampling of static meshes. More...

Static Public Member Functions
Niagara
static void	SetNiagaraStaticMeshDIInstanceIndex (UNiagaraComponent NiagaraSystem, const FName UserParameterName, int NewInstanceIndex)
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from UNiagaraDataInterface
static UClass	StaticClass ()

Public Attributes
LOD
bool	bAllowSamplingFromStreamingLODs
	When true, we allow this DI to sample from streaming LODs. Selectively overriding the CVar fx.Niagara.NDIStaticMesh.UseInlineLODsOnly.
FNiagaraUserParameterBinding	LODIndexUserParameter
	Reference to a user parameter if we're reading one.
int	LODIndex
	Static Mesh LOD to sample. When the desired LOD is not available, the next available LOD is used. When LOD Index is negative, Desired LOD = Num LODs - LOD Index.
Mesh
TSoftObjectPtr< AActor >	SoftSourceActor
	The source actor from which to sample. Takes precedence over the direct mesh. Note that this can only be set when used as a user variable on a component in the world.
bool	bCaptureTransformsPerFrame
	If true we capture the transforms from the mesh component each frame.
ENDIStaticMesh_SourceMode	SourceMode
	Controls how to retrieve the Static Mesh Component to attach to.
UStaticMesh	DefaultMesh
	Mesh used to sample from when not overridden by a source actor from the scene. This mesh is NOT removed from cooked builds.
TSoftObjectPtr< UStaticMesh >	PreviewMesh
	Mesh used to sample from when not overridden by a source actor from the scene. Only available in editor for previewing. This is removed in cooked builds.
FNDIStaticMeshSectionFilter	SectionFilter
	Array of filters the can be used to limit sampling to certain sections of the mesh.
bool	bUsePhysicsBodyVelocity
	If true then the mesh velocity is taken from the mesh component's physics data. Otherwise it will be calculated by diffing the component transforms between ticks, which is more reliable but won't work on the first frame.
FNiagaraUserParameterBinding	MeshParameterBinding
	Mesh parameter binding can be either an Actor (in which case we find the component), static mesh component or a static mesh.
int	InstanceIndex
	When attached to an Instanced Static Mesh, which instance should be read from.
TArray< FName >	FilteredSockets
	List of filtered sockets to use.

Detailed Description

Data Interface allowing sampling of static meshes.

Member Function Documentation

SetNiagaraStaticMeshDIInstanceIndex()

void SetNiagaraStaticMeshDIInstanceIndex ( UNiagaraComponent NiagaraSystem, const FName UserParameterName, int NewInstanceIndex )

static

StaticClass()

UClass StaticClass ( )

static

Member Data Documentation

bAllowSamplingFromStreamingLODs

bool bAllowSamplingFromStreamingLODs

When true, we allow this DI to sample from streaming LODs. Selectively overriding the CVar fx.Niagara.NDIStaticMesh.UseInlineLODsOnly.

bCaptureTransformsPerFrame

bool bCaptureTransformsPerFrame

If true we capture the transforms from the mesh component each frame.

bUsePhysicsBodyVelocity

bool bUsePhysicsBodyVelocity

If true then the mesh velocity is taken from the mesh component's physics data. Otherwise it will be calculated by diffing the component transforms between ticks, which is more reliable but won't work on the first frame.

DefaultMesh

UStaticMesh DefaultMesh

Mesh used to sample from when not overridden by a source actor from the scene. This mesh is NOT removed from cooked builds.

FilteredSockets

TArray<FName> FilteredSockets

List of filtered sockets to use.

InstanceIndex

int InstanceIndex

When attached to an Instanced Static Mesh, which instance should be read from.

LODIndex

int LODIndex

Static Mesh LOD to sample. When the desired LOD is not available, the next available LOD is used. When LOD Index is negative, Desired LOD = Num LODs - LOD Index.

LODIndexUserParameter

FNiagaraUserParameterBinding LODIndexUserParameter

Reference to a user parameter if we're reading one.

MeshParameterBinding

FNiagaraUserParameterBinding MeshParameterBinding

Mesh parameter binding can be either an Actor (in which case we find the component), static mesh component or a static mesh.

PreviewMesh

TSoftObjectPtr<UStaticMesh> PreviewMesh

Mesh used to sample from when not overridden by a source actor from the scene. Only available in editor for previewing. This is removed in cooked builds.

SectionFilter

FNDIStaticMeshSectionFilter SectionFilter

Array of filters the can be used to limit sampling to certain sections of the mesh.

SoftSourceActor

TSoftObjectPtr<AActor> SoftSourceActor

The source actor from which to sample. Takes precedence over the direct mesh. Note that this can only be set when used as a user variable on a component in the world.

SourceMode

ENDIStaticMesh_SourceMode SourceMode

Controls how to retrieve the Static Mesh Component to attach to.