1. Epic GamesDeveloper
  3. FParticleAnimTrailEmitterInstance

FParticleAnimTrailEmitterInstance

API > API/Runtime > API/Runtime/Engine

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

Syntax

struct FParticleAnimTrailEmitterInstance : public FParticleTrailsEmitterInstance_Base

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FParticleAnimTrailEmitterInstance ( IParticleEmitterInstanceOwner& InComponent
)

 Constructor ParticleEmitterInstances.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FParticleAnimTrailEmitterInstance()

 Destructor ParticleEmitterInstances.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bRenderGeometry uint32 Editor only variables controlling the debug rendering for trails. ParticleEmitterInstances.h  
bRenderSpawnPoints uint32   ParticleEmitterInstances.h  
bRenderTangents uint32   ParticleEmitterInstances.h  
bRenderTessellation uint32   ParticleEmitterInstances.h  
bTagTrailAsDead bool When set, the current trail will be marked as dead in the next tick. ParticleEmitterInstances.h  
bTrailEnabled bool Whether new particles should be spawned. ParticleEmitterInstances.h  
FirstSocketName FName The name of the socket that supplies the first edge for this emitter. ParticleEmitterInstances.h  
HeadOnlyParticles int32 The number of particles in the trail which are either marked ParticleEmitterInstances.h  
Owner const void * The owner of this trail. ParticleEmitterInstances.h  
SecondSocketName FName The name of the socket that supplies the second edge for this emitter. ParticleEmitterInstances.h  
SpawnPerUnitModule UParticleModuleSpawnPerUnit * SpawnPerUnit module (hijacking it for trails here) ParticleEmitterInstances.h  
TrailTypeData UParticleModuleTypeDataAnimTrail * The TypeData module for this trail emitter ParticleEmitterInstances.h  
Width float The width of the trail. ParticleEmitterInstances.h  
WidthMode ETrailWidthMode How the width is applied to the trail. ParticleEmitterInstances.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DetermineVertexAndTriangleCount()

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

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

   ParticleEmitterInstances.h  

bool IsTrailActive()

   ParticleEmitterInstances.h  

virtual void RecalculateTangentAndInterpolationParam ( FBaseParticle* PrevParticle,
FAnimTrailTypeDataPayload* PrevTrailData,
FBaseParticle* CurrParticle,
FAnimTrailTypeDataPayload* CurrTrailData,
FBaseParticle* NextParticle,
FAnimTrailTypeDataPayload* NextTrailData
)

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

void ResolveSource()

   ParticleEmitterInstances.h  

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

 Sets various debug variables for trails. 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 BeginTrail()

 Begins the trail. ParticleEmitterInstances.h  

virtual void EndTrail()

 Ends the trail. ParticleEmitterInstances.h  

virtual void ForceUpdateBoundingBox()

 Force the bounding box to be updated. 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 bool HasCompleted()

 Has the instance completed it's run? ParticleEmitterInstances.h  

virtual void InitParameters ( UParticleEmitter* InTemplate
)

   ParticleEmitterInstances.h  

virtual bool IsTrailEmitter()

   ParticleEmitterInstances.h  

virtual void SetTrailSourceData ( FName InFirstSocketName,
FName InSecondSocketName,
ETrailWidthMode InWidthMode,
float InWidth
)

 Sets the date that defines this trail. ParticleEmitterInstances.h  

virtual float Spawn ( float DeltaTime
)

 Spawn particles for this emitter instance ParticleEmitterInstances.h  

virtual void UpdateBoundingBox ( float DeltaTime
)

 Update the bounding box for the emitter ParticleEmitterInstances.h  

Protected

Name Remarks Include Path Unreal Specifiers

void SpawnParticle ( int32& StartParticleIndex,
const FAnimTrailParticleSpawnParams& Params
)

 Helper to spawn a trail particle during SpawnParticles(). ParticleEmitterInstances.h  

Overridden from FParticleTrailsEmitterInstance_Base

Name Remarks Include Path Unreal Specifiers

virtual void PrintAllActiveParticles()

 Prints out info for all active particles. ParticleEmitterInstances.h  

virtual void PrintParticleData ( FBaseParticle* Particle,
FTrailsBaseTypeDataPayload* TrailData,
int32 CurrentIndex,
int32 TrailIndex
)

 Prints out info for a single particle. ParticleEmitterInstances.h  

virtual void PrintTrails()

 Traverses all trails and prints out debugging info. ParticleEmitterInstances.h  

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