UParticleModuleTypeDataRibbon | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/Engine


Name	UParticleModuleTypeDataRibbon
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/Particles/TypeData/ParticleModuleTypeDataRibbon.h
Include Path	#include "Particles/TypeData/ParticleModuleTypeDataRibbon.h"

Syntax

UCLASS (MinimalAPI, EditInlineNew, HideCategories=Object, Meta=(DisplayName="Ribbon Data"))  
class UParticleModuleTypeDataRibbon : public UParticleModuleTypeDataBase

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UParticleModule → UParticleModuleTypeDataBase → UParticleModuleTypeDataRibbon

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UParticleModuleTypeDataRibbon ( const FObjectInitializer& ObjectInitializer )		Particles/TypeData/ParticleModuleTypeDataRibbon.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bClipSourceSegement	uint32	If true, do not join the trail to the source position	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
bDeadTrailsOnDeactivate	uint32	If true, when the system is deactivated, mark trails as dead.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
bDeadTrailsOnSourceLoss	uint32	If true, when the source of a trail is 'lost' (ie, the source particle dies), mark the current trail as dead.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
bEnablePreviousTangentRecalculation	uint32	If true, recalculate the previous tangent when a new particle is spawned	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
bEnableTangentDiffInterpScale	uint32	If this flag is enabled, the system will scale the number of interpolated vertices based on the difference in the tangents of neighboring particles.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
bRenderGeometry	uint32	Trail Rendering Variables. If true, render the trail geometry (this should typically be on)	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
bRenderSpawnPoints	uint32	If true, render stars at each spawned particle point along the trail	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
bRenderTangents	uint32	If true, render a line showing the tangent at each spawned particle point along the trail	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
bRenderTessellation	uint32	If true, render the tessellated path between spawned particles	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
bSpawnInitialParticle	uint32	If true, ribbon will spawn a particle when it first starts moving	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
bTangentRecalculationEveryFrame	uint32	If true, recalculate tangents every frame to allow velocity/acceleration to be applied	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
DistanceTessellationStepSize	float	The distance step size for tessellation.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
MaxParticleInTrailCount	int32	Max particles per trail	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
MaxTessellationBetweenParticles	int32	General Trail Variables.	Particles/TypeData/ParticleModuleTypeDataRibbon.h
MaxTrailCount	int32	The number of live trails	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
RenderAxis	TEnumAsByte< enum ETrailsRenderAxisOption >	The 'render' axis for the trail (what axis the trail is stretched out on) Trails_CameraUp - Traditional camera-facing trail.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
SheetsPerTrail	int32	The number of sheets to render for the trail.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Trail
TangentSpawningScalar	float	Trail Spawning Variables.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Spawn
TangentTessellationScalar	float	The tangent scalar for tessellation.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering
TilingDistance	float	The (estimated) covered distance to tile the 2nd UV set at.	Particles/TypeData/ParticleModuleTypeDataRibbon.h	EditAnywhere Category=Rendering

Functions

Public

Overridden from UParticleModuleTypeDataBase

Name	Remarks	Include Path	Unreal Specifiers
virtual void CollectPSOPrecacheData ( const UParticleEmitter* Emitter, FPSOPrecacheParams& OutParams )		Particles/TypeData/ParticleModuleTypeDataRibbon.h
virtual FParticleEmitterInstance * CreateInstance ( UParticleEmitter* InEmitterParent, IParticleEmitterInstanceOwner& InComponent )		Particles/TypeData/ParticleModuleTypeDataRibbon.h
virtual EPrimitiveType GetPrimitiveType()		Particles/TypeData/ParticleModuleTypeDataRibbon.h
virtual const FVertexFactoryType * GetVertexFactoryType()		Particles/TypeData/ParticleModuleTypeDataRibbon.h

Overridden from UParticleModule

Name	Remarks	Include Path	Unreal Specifiers
virtual uint32 RequiredBytes ( UParticleModuleTypeDataBase* TypeData )	Returns the number of bytes that the module requires in the particle payload block.	Particles/TypeData/ParticleModuleTypeDataRibbon.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		Particles/TypeData/ParticleModuleTypeDataRibbon.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Functions

Public

Overridden from UParticleModuleTypeDataBase

Overridden from UParticleModule

Overridden from UObject