1. Epic GamesDeveloper
  3. FParticleAnimTrailEmitterInstance

FParticleAnimTrailEmitterInstance

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/ParticleEmitterInstances.h
Include #include "ParticleEmitterInstances.h"

Syntax

struct FParticleAnimTrailEmitterInstance : public FParticleTrailsEmitterInstance_Base

Variables

  Type 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 UParticleModuleSpawnPerUnit * SpawnPerUnitModule SpawnPerUnit module (hijacking it for trails here)
Public variable UParticleModuleTypeDataAnimTrail * 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

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Public function void 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  
Public function 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...
Public function void  
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& Params
)

 Helper to spawn a trail particle during SpawnParticles().

Overridden from FParticleTrailsEmitterInstance_Base

  Type Name Description
Protected function Virtual void Prints out info for all active particles.
Protected function Virtual void

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

 Prints out info for a single particle.
Protected function Virtual void Traverses all trails and prints out debugging info.
Public function Virtual void  
Public function Virtual void

Tick_RecalculateTangents ( float DeltaTime,
UParticleLODLevel* CurrentLODLevel
)

 Tick sub-function that handles recalculation of tangents
Public function Virtual void

UpdateSourceData ( float DeltaTime,
bool bFirstTime
)

  

Overridden from FParticleEmitterInstance

  Type Name Description
Public function Virtual void Begins the trail.
Public function Virtual void Ends the trail.
Protected function Virtual bool Captures dynamic replay data for this particle system.
Public function Virtual void 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 FDynamicEmitterDataBase *

GetDynamicData ( bool bSelected,
ERHIFeatureLevel::Type InFeatureLevel
)

 Retrieves the dynamic data for the emitter
Public function Virtual FDynamicEmitterReplayDataBase * Retrieves replay data for the emitter
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Returns the size of the object/ resource for display to artists/ LDs in the Editor.
Public function Virtual bool Has the instance completed it's run?
Public function Virtual void  
Public function Virtual Const bool  
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page