ParticleModuleTypeDataBeam2.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Distributions/DistributionFloat.h"
#include "Particles/TypeData/ParticleModuleTypeDataBase.h"
#include "ParticleModuleTypeDataBeam2.generated.h"
 
class UInterpCurveEdSetup;
class UParticleEmitter;
class UParticleModuleBeamModifier;
class UParticleModuleBeamNoise;
class UParticleModuleBeamSource;
class UParticleModuleBeamTarget;
class UParticleSystemComponent;
struct FCurveEdEntry;
struct FParticleEmitterInstance;
 
UENUM()
enum EBeam2Method : int
{
    PEB2M_Distance UMETA(DisplayName="Distance"),
    PEB2M_Target UMETA(DisplayName="Target"),
    PEB2M_Branch UMETA(DisplayName="Branch"),
    PEB2M_MAX,
};
 
//
// Beam Tapering Variables.
//
UENUM()
enum EBeamTaperMethod : int
{
    PEBTM_None UMETA(DisplayName="None"),
    PEBTM_Full UMETA(DisplayName="Full"),
    PEBTM_Partial UMETA(DisplayName="Partial"),
    PEBTM_MAX,
};
 
//
// Beam Multi-target Variables.
//
USTRUCT()
struct FBeamTargetData
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=BeamTargetData)
    FName TargetName;
 
    UPROPERTY(EditAnywhere, Category=BeamTargetData)
    float TargetPercentage;
 
 
    FBeamTargetData()
        : TargetPercentage(0)
    {
    }
 
};
 
UCLASS(editinlinenew, dontcollapsecategories, hidecategories=Object, MinimalAPI, meta=(DisplayName = "Beam Data"))
class UParticleModuleTypeDataBeam2 : public UParticleModuleTypeDataBase
{
    GENERATED_UCLASS_BODY()
 
    //
    // General Beam Variables.
    //
    
    
    UPROPERTY(EditAnywhere, Category=Beam)
    TEnumAsByte<enum EBeam2Method> BeamMethod;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    int32 TextureTile;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    float TextureTileDistance;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    int32 Sheets;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    int32 MaxBeamCount;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    float Speed;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    int32 InterpolationPoints;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    uint32 bAlwaysOn:1;
 
    UPROPERTY(EditAnywhere, Category=Beam)
    int32 UpVectorStepSize;
 
    //
    // Beam Branching Variables.
    //
    
    UPROPERTY(EditAnywhere, Category=Branching)
    FName BranchParentName;
 
    //
    // Beam Distance Variables.
    //
    
    UPROPERTY(EditAnywhere, Category=Distance)
    struct FRawDistributionFloat Distance;
 
    UPROPERTY(EditAnywhere, Category=Taper)
    TEnumAsByte<enum EBeamTaperMethod> TaperMethod;
 
    UPROPERTY(EditAnywhere, Category=Taper)
    struct FRawDistributionFloat TaperFactor;
 
    UPROPERTY(EditAnywhere, Category=Taper)
    struct FRawDistributionFloat TaperScale;
 
    //
    // Beam Rendering Variables.
    //
    UPROPERTY(EditAnywhere, Category=Rendering)
    uint32 RenderGeometry:1;
 
    UPROPERTY(EditAnywhere, Category=Rendering)
    uint32 RenderDirectLine:1;
 
    UPROPERTY(EditAnywhere, Category=Rendering)
    uint32 RenderLines:1;
 
    UPROPERTY(EditAnywhere, Category=Rendering)
    uint32 RenderTessellation:1;
 
    TArray<UParticleModuleBeamSource*>      LOD_BeamModule_Source;
    TArray<UParticleModuleBeamTarget*>      LOD_BeamModule_Target;
    TArray<UParticleModuleBeamNoise*>       LOD_BeamModule_Noise;
    TArray<UParticleModuleBeamModifier*>    LOD_BeamModule_SourceModifier;
    TArray<UParticleModuleBeamModifier*>    LOD_BeamModule_TargetModifier;
 
    void InitializeDefaults();
 
    //~ Begin UObject Interface
#if WITH_EDITOR
    virtual void    PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    virtual void    PostInitProperties() override;
    //~ End UObject Interface
 
 
    //~ Begin UParticleModule Interface
    virtual void    Spawn(const FSpawnContext& Context) override;
    virtual void    Update(const FUpdateContext& Context) override;
    virtual uint32  RequiredBytes(UParticleModuleTypeDataBase* TypeData) override;
    virtual bool    AddModuleCurvesToEditor(UInterpCurveEdSetup* EdSetup, TArray<const FCurveEdEntry*>& OutCurveEntries) override;
    virtual bool CanTickInAnyThread() override
    {
        return true;
    }
    //~ End UParticleModule Interface
 
 
    //~ Begin UParticleModuleTypeDataBase Interface
    virtual FParticleEmitterInstance* CreateInstance(UParticleEmitter* InEmitterParent, IParticleEmitterInstanceOwner& InComponent) override;
    virtual void CacheModuleInfo(UParticleEmitter* Emitter) override;
    virtual const FVertexFactoryType* GetVertexFactoryType() const override;
    virtual EPrimitiveType GetPrimitiveType() const { return PT_TriangleStrip; }
    virtual void CollectPSOPrecacheData(const UParticleEmitter* Emitter, FPSOPrecacheParams& OutParams) override;
    //~ End UParticleModuleTypeDataBase Interface
 
 
    virtual void    GetDataPointers(FParticleEmitterInstance* Owner, const uint8* ParticleBase, 
            int32& CurrentOffset, FBeam2TypeDataPayload*& BeamData, FVector*& InterpolatedPoints, 
            float*& NoiseRate, float*& NoiseDeltaTime, FVector*& TargetNoisePoints, 
            FVector*& NextNoisePoints, float*& TaperValues, float*& NoiseDistanceScale,
            FBeamParticleModifierPayloadData*& SourceModifier,
            FBeamParticleModifierPayloadData*& TargetModifier);
 
    virtual void    GetDataPointerOffsets(FParticleEmitterInstance* Owner, const uint8* ParticleBase, 
            int32& CurrentOffset, int32& BeamDataOffset, int32& InterpolatedPointsOffset, int32& NoiseRateOffset, 
            int32& NoiseDeltaTimeOffset, int32& TargetNoisePointsOffset, int32& NextNoisePointsOffset, 
            int32& TaperCount, int32& TaperValuesOffset, int32& NoiseDistanceScaleOffset);
 
    void    GetNoiseRange(FVector& NoiseMin, FVector& NoiseMax);
};