ParticleModuleBeamModifier.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 "Distributions/DistributionVector.h"
#include "Particles/ParticleModule.h"
#include "Particles/Beam/ParticleModuleBeamBase.h"
#include "ParticleModuleBeamModifier.generated.h"
 
class UInterpCurveEdSetup;
class UParticleModuleTypeDataBase;
class UParticleSystemComponent;
struct FCurveEdEntry;
struct FParticleEmitterInstance;
 
UENUM()
enum BeamModifierType : int
{
    PEB2MT_Source UMETA(DisplayName="Source"),
    PEB2MT_Target UMETA(DisplayName="Target"),
    PEB2MT_MAX,
};
 
USTRUCT()
struct FBeamModifierOptions
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=BeamModifierOptions)
    uint32 bModify:1;
 
    UPROPERTY(EditAnywhere, Category=BeamModifierOptions)
    uint32 bScale:1;
 
    UPROPERTY(EditAnywhere, Category=BeamModifierOptions)
    uint32 bLock:1;
 
 
    FBeamModifierOptions()
        : bModify(false)
        , bScale(false)
        , bLock(false)
    {
    }
 
};
 
UCLASS(editinlinenew, hidecategories=Object, meta=(DisplayName = "Beam Modifier"))
class UParticleModuleBeamModifier : public UParticleModuleBeamBase
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Modifier)
    TEnumAsByte<enum BeamModifierType> ModifierType;
 
    UPROPERTY(EditAnywhere, Category=Position)
    struct FBeamModifierOptions PositionOptions;
 
    UPROPERTY(EditAnywhere, Category=Position)
    struct FRawDistributionVector Position;
 
    UPROPERTY(EditAnywhere, Category=Tangent)
    struct FBeamModifierOptions TangentOptions;
 
    UPROPERTY(EditAnywhere, Category=Tangent)
    struct FRawDistributionVector Tangent;
 
    UPROPERTY(EditAnywhere, Category=Tangent)
    uint32 bAbsoluteTangent:1;
 
    UPROPERTY(EditAnywhere, Category=Strength)
    struct FBeamModifierOptions StrengthOptions;
 
    UPROPERTY(EditAnywhere, Category=Strength)
    struct FRawDistributionFloat Strength;
 
    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 void AutoPopulateInstanceProperties(UParticleSystemComponent* PSysComp) override;
    virtual void GetCurveObjects(TArray<FParticleCurvePair>& OutCurves) override;
    virtual bool AddModuleCurvesToEditor(UInterpCurveEdSetup* EdSetup, TArray<const FCurveEdEntry*>& OutCurveEntries) override;
    virtual void GetParticleSysParamsUtilized(TArray<FString>& ParticleSysParamList) override;
    //End UParticleModule Interface
 
 
    // @ todo document
    void    GetDataPointers(FParticleEmitterInstance* Owner, const uint8* ParticleBase, 
        int32& CurrentOffset, FBeam2TypeDataPayload*& BeamDataPayload, 
        FBeamParticleModifierPayloadData*& SourceModifierPayload,
        FBeamParticleModifierPayloadData*& TargetModifierPayload);
 
    // @ todo document
    void    GetDataPointerOffsets(FParticleEmitterInstance* Owner, const uint8* ParticleBase, 
        int32& CurrentOffset, int32& BeamDataOffset, int32& SourceModifierOffset, 
        int32& TargetModifierOffset);
};