FParticleRibbonEmitterInstance

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Engine

Header

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

Include

#include "ParticleEmitterInstances.h"

Syntax

struct FParticleRibbonEmitterInstance : public FParticleTrailsEmitterInstance_Base

Variables

Name Description

Public variable

TArray< float >

 

CurrentLifetimes

The lifetime to use for each ribbon

Public variable

TArray< float >

 

CurrentSizes

The size to use for each ribbon

Public variable

TArray< FVector...

 

CurrentSourcePosition

The current source position for each trail in this emitter

Public variable

TArray< FQuat >

 

CurrentSourceRotation

The current source rotation for each trail in this emitter

Public variable

TArray< FVector...

 

CurrentSourceTangent

The current source tangent for each trail in this emitter

Public variable

TArray< float >

 

CurrentSourceTangentStrength

The current source tangent strength for each trail in this emitter

Public variable

TArray< FVector...

 

CurrentSourceUp

The current source up for each trail in this emitter

Public variable

int32

 

HeadOnlyParticles

TArray CurrentStartIndices;.

Public variable

int32

 

LastSelectedParticleIndex

The last selected source index (for sequential selection)

Public variable

TArray< FVector...

 

LastSourcePosition

The previous source position for each trail in this emitter

Public variable

TArray< FQuat >

 

LastSourceRotation

The last source rotation for each trail in this emitter

Public variable

TArray< FVector...

 

LastSourceTangent

The previous source tangent for each trail in this emitter

Public variable

TArray< float >

 

LastSourceTangentStrength

The previous source tangent strength for each trail in this emitter

Public variable

TArray< float >

 

LastSourceTimes

The time of the last partice source update

Public variable

TArray< FVector...

 

LastSourceUp

The previous source up for each trail in this emitter

Public variable

AActor *

 

SourceActor

If the source is an actor, this is it

Public variable

FParticleEmitte...

 

SourceEmitter

If the source is an emitter, this is it

Public variable

TArray< int32 >

 

SourceIndices

The indices for the source of each trail (if required)

Public variable

UParticleModule...

 

SourceModule

Source module

Public variable

TArray< FVector...

 

SourceOffsets

The offset from the source for each trail in this emitter

Public variable

TArray< float >

 

SourceTimes

The time of the last partice source update

Public variable

UParticleModule...

 

SpawnPerUnitModule

SpawnPerUnit module (hijacking it for trails here)

Public variable

int32

 

TrailModule_Source_Offset

Payload offset for source module

Public variable

UParticleModule...

 

TrailTypeData

The TypeData module for this trail emitter

Constructors

Name Description

Public function

FParticleRibbonEmitterInstance()

Constructor

Destructors

Name Description

Public function Virtual

~FParticleRibbonEmitterInstance()

Destructor

Functions

Name Description

Public function

void

 

DetermineVertexAndTriangleCount()

Determine the number of vertices and triangles in each trail

Public function

void

 

GetParticleLifetimeAndSize

(
    int32 InTrailIdx,
    const FBaseParticle* InParticl...,
    bool bInNoLivingParticles,
    float& OutOneOverMaxLifetime,
    float& OutSize
)

Get the lifetime and size for a particle being added to the given trail

Public function Virtual

bool

 

GetSpawnPerUnitAmount

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

Public function

void

 

ResolveSource()

Public function

bool

 

ResolveSourcePoint

(
    int32 InTrailIdx,
    FVector& OutPosition,
    FQuat& OutRotation,
    FVector& OutUp,
    FVector& OutTangent,
    float& OutTangentStrength
)

Virtual void UpdateStartParticles(float DeltaTime, bool bFirstTime);

Public function

float

 

Spawn_RateAndBurst

(
    float DeltaTime
)

Spawn ribbon particles from SpawnRate and Burst settings.

Public function

bool

 

Spawn_Source

(
    float DeltaTime
)

Spawn source-based ribbon particles.

Overridden from FParticleTrailsEmitterInstance_Base

Name Description

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

 

ApplyWorldOffset

(
    FVector InOffset,
    bool bWorldShift
)

Called on world origin changes

Protected function Virtual

bool

 

FillReplayData

(
    FDynamicEmitterReplayDataBase& Out...
)

Captures dynamic replay data for this particle system.

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

void

 

InitParameters

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

Public function Virtual

bool

 

IsDynamicDataRequired

(
    UParticleLODLevel* CurrentLODL...
)

Checks some common values for GetDynamicData validity

Public function Virtual

void

 

OnEmitterInstanceKilled

(
    FParticleEmitterInstance* Inst...
)

When an emitter is killed, this will check other emitters and clean up anything pointing to this one

Public function Virtual

float

 

Spawn

(
    float DeltaTime
)

Spawn particles for this emitter instance

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