FParticleAnimTrailEmitterInstance

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

struct FParticleAnimTrailEmitterInstance : public FParticleTrailsEmitterInstance_Base

Variables

Name Description

Public variable

uint32: 1

 

bRenderGeometry

Editor only variables controlling the debug rendering for trails.

Public variable

uint32: 1

 

bRenderSpawnPoints

Public variable

uint32: 1

 

bRenderTangents

Public variable

uint32: 1

 

bRenderTessellation

Public variable

bool

 

bTagTrailAsDead

When set, the current trail will be marked as dead in the next tick.

Public variable

bool

 

bTrailEnabled

Whether new particles should be spawned.

Public variable

FName

 

FirstSocketName

The name of the socket that supplies the first edge for this emitter.

Public variable

int32

 

HeadOnlyParticles

The number of particles in the trail which are either marked

Public variable

const void *...

 

Owner

The owner of this trail.

Public variable

FName

 

SecondSocketName

The name of the socket that supplies the second edge for this emitter.

Public variable

UParticleModule...

 

SpawnPerUnitModule

SpawnPerUnit module (hijacking it for trails here)

Public variable

UParticleModule...

 

TrailTypeData

The TypeData module for this trail emitter

Public variable

float

 

Width

The width of the trail.

Public variable

ETrailWidthMode

 

WidthMode

How the width is applied to the trail.

Constructors

Name Description

Public function

FParticleAnimTrailEmitterInstance()

Constructor

Destructors

Name Description

Public function Virtual

~FParticleAnimTrailEmitterInstance()

Destructor

Functions

Name Description

Public function

void

 

DetermineVertexAndTriangleCount()

Determine the number of vertices and triangles in each trail

Public function Virtual

bool

 

GetSpawnPerUnitAmount

(
    float DeltaTime,
    int32 InTrailIdx,
    int32& OutCount,
    float& OutRate
)

Public function Const

bool

 

IsTrailActive()

Public function Virtual

void

 

RecalculateTangentAndInterpolationParam

(
    FBaseParticle* PrevParticle,
    FAnimTrailTypeDataPayload* Pre...,
    FBaseParticle* CurrParticle,
    FAnimTrailTypeDataPayload* Cur...,
    FBaseParticle* NextParticle,
    FAnimTrailTypeDataPayload* Nex...
)

Helper function for recalculating tangents and the spline interpolation parameter...

Public function

void

 

ResolveSource()

Public function

void

 

SetTrailDebugData

(
    bool bInRenderGeometry,
    bool bInRenderSpawnPoints,
    bool bInRenderTessellation,
    bool bInRenderTangents
)

Sets various debug variables for trails.

Protected function

void

 

SpawnParticle

(
    int32& StartParticleIndex,
    const FAnimTrailParticleSpawnParams...
)

Helper to spawn a trail particle during SpawnParticles().

Overridden from FParticleTrailsEmitterInstance_Base

Name Description

Protected function Virtual

void

 

PrintAllActiveParticles()

Prints out info for all active particles.

Protected function Virtual

void

 

PrintParticleData

(
    FBaseParticle* Particle,
    FTrailsBaseTypeDataPayload* Tr...,
    int32 CurrentIndex,
    int32 TrailIndex
)

Prints out info for a single particle.

Protected function Virtual

void

 

PrintTrails()

Traverses all trails and prints out debugging info.

Public function Virtual

void

 

SetupTrailModules()

Public function Virtual

void

 

Tick_RecalculateTangents

(
    float DeltaTime,
    UParticleLODLevel* CurrentLODL...
)

Tick sub-function that handles recalculation of tangents

Public function Virtual

void

 

UpdateSourceData

(
    float DeltaTime,
    bool bFirstTime
)

Overridden from FParticleEmitterInstance

Name Description

Public function Virtual

void

 

BeginTrail()

Begins the trail.

Public function Virtual

void

 

EndTrail()

Ends the trail.

Protected function Virtual

bool

 

FillReplayData

(
    FDynamicEmitterReplayDataBase& Out...
)

Captures dynamic replay data for this particle system.

Public function Virtual

void

 

ForceUpdateBoundingBox()

Force the bounding box to be updated.

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

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

bool

 

HasCompleted()

Has the instance completed it's run?

Public function Virtual

void

 

InitParameters

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

Public function Virtual Const

bool

 

IsTrailEmitter()

Public function Virtual

void

 

SetTrailSourceData

(
    FName InFirstSocketName,
    FName InSecondSocketName,
    ETrailWidthMode InWidthMode,
    float InWidth
)

Sets the date that defines this trail.

Public function Virtual

float

 

Spawn

(
    float DeltaTime
)

Spawn particles for this emitter instance

Public function Virtual

void

 

UpdateBoundingBox

(
    float DeltaTime
)

Update the bounding box for the emitter

References

Module

Engine

Header

Runtime/Engine/Public/ParticleEmitterInstances.h

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