FParticleMeshEmitterInstance

Windows
MacOS
Linux

Inheritance Hierarchy

FParticleEmitterInstance

FParticleMeshEmitterInstance

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h

Include

#include "ParticleEmitterInstances.h"

Syntax

struct FParticleMeshEmitterInstance : public FParticleEmitterInstance

Variables

Name Description

Public variable

TArray< UMateri...

 

CurrentMaterials

The materials to render this instance with.

Public variable

int32

 

MeshMotionBlurOffset

Public variable

bool

 

MeshRotationActive

Public variable

int32

 

MeshRotationOffset

Public variable

UParticleModule...

 

MeshTypeData

Constructors

Name Description

Public function

FParticleMeshEmitterInstance()

Constructor

Structure for mesh emitter instancesConstructor

Functions

Name Description

Public function Const

void

 

GetMeshMaterials

(
    TArray< UMaterialInterface*, T...,
    const UParticleLODLevel* LODLe...,
    ERHIFeatureLevel::Type InFeatureLev...,
    bool bLogWarnings
)

Gets the materials applied to each section of a mesh.

Overridden from FParticleEmitterInstance

Name Description

Protected function Virtual

bool

 

FillReplayData

(
    FDynamicEmitterReplayDataBase& Out...
)

Captures dynamic replay data for this particle system.

Public function Virtual Const

void

 

GatherMaterialRelevance

(
    FMaterialRelevance* OutMateria...,
    const UParticleLODLevel* LODLe...,
    ERHIFeatureLevel::Type InFeatureLev...
)

Gathers material relevance flags for this emitter instance.

Public function Virtual

void

 

GetAllocatedSize

(
    int32& OutNum,
    int32& OutMax
)

Retrieve the allocated size of this instance.

Public function Virtual

FDynamicEmit...

 

GetDynamicData

(
    bool bSelected,
    ERHIFeatureLevel::Type InFeatureLev...
)

Retrieves the dynamic data for the emitter

Public function Virtual Const

int32

 

GetMeshRotationOffset()

Returns the offset to the mesh rotation payload, if any.

Public function Virtual

FDynamicEmit...

 

GetReplayData()

Retrieves replay data for the emitter

Public function Virtual

void

 

GetResourceSizeEx

(
    FResourceSizeEx& CumulativeResourc...
)

Returns the size of the object/ resource for display to artists/ LDs in the Editor.

Public function Virtual

void

 

Init()

Initialize the instance

Public function Virtual

void

 

InitParameters

(
    UParticleEmitter* InTemplate,
    UParticleSystemComponent* InCo...
)

Public function Virtual

bool

 

IsDynamicDataRequired

(
    UParticleLODLevel* CurrentLODL...
)

Checks some common values for GetDynamicData validity

Public function Virtual Const

bool

 

IsMeshRotationActive()

Returns true if mesh rotation is active.

Public function Virtual

void

 

PostSpawn

(
    FBaseParticle* Particle,
    float InterpolationPercentage,
    float SpawnTime
)

Handle any post-spawning actions required by the instance

Public function Virtual

uint32

 

RequiredBytes()

Retrieved the per-particle bytes that this emitter type requires.

Public function Virtual

bool

 

Resize

(
    int32 NewMaxActiveParticles,
    bool bSetMaxActiveCount
)

Resize the particle data array

Public function Virtual

void

 

SetMeshMaterials

(
    const TArray< UMaterialInterface&#...
)

Sets the materials with which mesh particles should be rendered.

Public function Virtual

void

 

Tick

(
    float DeltaTime,
    bool bSuppressSpawning
)

Tick the instance.

Public function Virtual

void

 

Tick_MaterialOverrides

(
    int32 EmitterIndex
)

Ticks the emitter's material overrides.

Public function Virtual

void

 

UpdateBoundingBox

(
    float DeltaTime
)

Update the bounding box for the emitter

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback