1. Epic GamesDeveloper
  3. FParticleRibbonEmitterInstance

FParticleRibbonEmitterInstance

API > API/Runtime > API/Runtime/Engine

   
Name FParticleRibbonEmitterInstance
Type struct
Header File /Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h
Include Path #include "ParticleEmitterInstances.h"

Syntax

struct FParticleRibbonEmitterInstance : public FParticleTrailsEmitterInstance_Base

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FParticleRibbonEmitterInstance ( IParticleEmitterInstanceOwner& InComponent
)

 Constructor ParticleEmitterInstances.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FParticleRibbonEmitterInstance()

 Destructor ParticleEmitterInstances.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CurrentLifetimes TArray< float > The lifetime to use for each ribbon ParticleEmitterInstances.h  
CurrentSizes TArray< float > The size to use for each ribbon ParticleEmitterInstances.h  
CurrentSourcePosition TArray< FVector > The current source position for each trail in this emitter ParticleEmitterInstances.h  
CurrentSourceRotation TArray< FQuat > The current source rotation for each trail in this emitter ParticleEmitterInstances.h  
CurrentSourceTangent TArray< FVector > The current source tangent for each trail in this emitter ParticleEmitterInstances.h  
CurrentSourceTangentStrength TArray< float > The current source tangent strength for each trail in this emitter ParticleEmitterInstances.h  
CurrentSourceUp TArray< FVector > The current source up for each trail in this emitter ParticleEmitterInstances.h  
HeadOnlyParticles int32 TArray CurrentStartIndices;. ParticleEmitterInstances.h  
LastSelectedParticleIndex int32 The last selected source index (for sequential selection) ParticleEmitterInstances.h  
LastSourcePosition TArray< FVector > The previous source position for each trail in this emitter ParticleEmitterInstances.h  
LastSourceRotation TArray< FQuat > The last source rotation for each trail in this emitter ParticleEmitterInstances.h  
LastSourceTangent TArray< FVector > The previous source tangent for each trail in this emitter ParticleEmitterInstances.h  
LastSourceTangentStrength TArray< float > The previous source tangent strength for each trail in this emitter ParticleEmitterInstances.h  
LastSourceTimes TArray< float > The time of the last partice source update ParticleEmitterInstances.h  
LastSourceUp TArray< FVector > The previous source up for each trail in this emitter ParticleEmitterInstances.h  
SourceActor AActor * If the source is an actor, this is it ParticleEmitterInstances.h  
SourceEmitter FParticleEmitterInstance * If the source is an emitter, this is it ParticleEmitterInstances.h  
SourceIndices TArray< int32 > The indices for the source of each trail (if required) ParticleEmitterInstances.h  
SourceModule UParticleModuleTrailSource * Source module ParticleEmitterInstances.h  
SourceOffsets TArray< FVector > The offset from the source for each trail in this emitter ParticleEmitterInstances.h  
SourceTimes TArray< float > The time of the last partice source update ParticleEmitterInstances.h  
SpawnPerUnitModule UParticleModuleSpawnPerUnit * SpawnPerUnit module (hijacking it for trails here) ParticleEmitterInstances.h  
TrailModule_Source_Offset int32 Payload offset for source module ParticleEmitterInstances.h  
TrailTypeData UParticleModuleTypeDataRibbon * The TypeData module for this trail emitter ParticleEmitterInstances.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DetermineVertexAndTriangleCount()

 Determine the number of vertices and triangles in each trail ParticleEmitterInstances.h  

void GetParticleLifetimeAndSize ( int32 InTrailIdx,
const FBaseParticle* InParticle,
bool bInNoLivingParticles,
float& OutOneOverMaxLifetime,
float& OutSize
)

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

virtual bool GetSpawnPerUnitAmount ( float DeltaTime,
int32 InTrailIdx,
int32& OutCount,
float& OutRate
)

   ParticleEmitterInstances.h  

void ResolveSource()

   ParticleEmitterInstances.h  

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

 Virtual void UpdateStartParticles(float DeltaTime, bool bFirstTime); ParticleEmitterInstances.h  

float Spawn_RateAndBurst ( float DeltaTime
)

 Spawn ribbon particles from SpawnRate and Burst settings. ParticleEmitterInstances.h  

bool Spawn_Source ( float DeltaTime
)

 Spawn source-based ribbon particles. ParticleEmitterInstances.h  

Overridden from FParticleTrailsEmitterInstance_Base

Name Remarks Include Path Unreal Specifiers

virtual void SetupTrailModules()

   ParticleEmitterInstances.h  

virtual void Tick_RecalculateTangents ( float DeltaTime,
UParticleLODLevel* CurrentLODLevel
)

 Tick sub-function that handles recalculation of tangents ParticleEmitterInstances.h  

virtual void UpdateSourceData ( float DeltaTime,
bool bFirstTime
)

   ParticleEmitterInstances.h  

Overridden from FParticleEmitterInstance

Name Remarks Include Path Unreal Specifiers

virtual void ApplyWorldOffset ( FVector InOffset,
bool bWorldShift
)

 Called on world origin changes ParticleEmitterInstances.h  

virtual void GetAllocatedSize ( int32& OutNum,
int32& OutMax
)

 Retrieve the allocated size of this instance. ParticleEmitterInstances.h  

virtual FDynamicEmitterDataBase * GetDynamicData ( bool bSelected,
ERHIFeatureLevel::Type InFeatureLevel
)

 Retrieves the dynamic data for the emitter ParticleEmitterInstances.h  

virtual FDynamicEmitterReplayDataBase * GetReplayData()

 Retrieves replay data for the emitter ParticleEmitterInstances.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

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

virtual void InitParameters ( UParticleEmitter* InTemplate
)

   ParticleEmitterInstances.h  

virtual bool IsDynamicDataRequired ( UParticleLODLevel* CurrentLODLevel
)

 Checks some common values for GetDynamicData validity ParticleEmitterInstances.h  

virtual void OnEmitterInstanceKilled ( FParticleEmitterInstance* Instance
)

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

virtual float Spawn ( float DeltaTime
)

 Spawn particles for this emitter instance ParticleEmitterInstances.h  

Protected

Overridden from FParticleEmitterInstance

Name Remarks Include Path Unreal Specifiers

virtual bool FillReplayData ( FDynamicEmitterReplayDataBase& OutData
)

 Captures dynamic replay data for this particle system. ParticleEmitterInstances.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page