ParticleModuleTypeDataMesh.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 "Math/RandomStream.h"
#include "Distributions/DistributionVector.h"
#include "Particles/Orientation/ParticleModuleOrientationAxisLock.h"
#include "Particles/TypeData/ParticleModuleTypeDataBase.h"
#include "ParticleModuleTypeDataMesh.generated.h"
 
class UParticleEmitter;
class UParticleSystemComponent;
struct FParticleEmitterInstance;
class UStaticMesh;
 
UENUM()
enum EMeshScreenAlignment : int
{
    PSMA_MeshFaceCameraWithRoll UMETA(DisplayName="Face Camera With Roll"),
    PSMA_MeshFaceCameraWithSpin UMETA(DisplayName="Face Camera With Spin"),
    PSMA_MeshFaceCameraWithLockedAxis UMETA(DisplayName="Face Camera With Locked-Axis"),
    PSMA_MAX,
};
 
UENUM()
enum EMeshCameraFacingUpAxis : int
{
    CameraFacing_NoneUP UMETA(DisplayName="None"),
    CameraFacing_ZUp UMETA(DisplayName="Z Up"),
    CameraFacing_NegativeZUp UMETA(DisplayName="-Z Up"),
    CameraFacing_YUp UMETA(DisplayName="Y Up"),
    CameraFacing_NegativeYUp UMETA(DisplayName="-Y Up"),
    CameraFacing_MAX,
};
 
UENUM()
enum EMeshCameraFacingOptions : int
{
    XAxisFacing_NoUp UMETA(DisplayName="X Axis Facing : No Up"),
    XAxisFacing_ZUp UMETA(DisplayName="X Axis Facing : Z Up"),
    XAxisFacing_NegativeZUp UMETA(DisplayName="X Axis Facing : -Z Up"),
    XAxisFacing_YUp UMETA(DisplayName="X Axis Facing : Y Up"),
    XAxisFacing_NegativeYUp UMETA(DisplayName="X Axis Facing : -Y Up"),
 
    LockedAxis_ZAxisFacing UMETA(DisplayName="Locked Axis : Z Axis Facing"),
    LockedAxis_NegativeZAxisFacing UMETA(DisplayName="Locked Axis : -Z Axis Facing"),
    LockedAxis_YAxisFacing UMETA(DisplayName="Locked Axis : Y Axis Facing"),
    LockedAxis_NegativeYAxisFacing UMETA(DisplayName="Locked Axis : -Y Axis Facing"),
 
    VelocityAligned_ZAxisFacing UMETA(DisplayName="Velocity Aligned : Z Axis Facing"),
    VelocityAligned_NegativeZAxisFacing UMETA(DisplayName="Velocity Aligned : -Z Axis Facing"),
    VelocityAligned_YAxisFacing UMETA(DisplayName="Velocity Aligned : Y Axis Facing"),
    VelocityAligned_NegativeYAxisFacing UMETA(DisplayName="Velocity Aligned : -Y Axis Facing"),
 
    EMeshCameraFacingOptions_MAX,
};
 
UCLASS(editinlinenew, hidecategories=Object, MinimalAPI, meta=(DisplayName = "Mesh Data"))
class UParticleModuleTypeDataMesh : public UParticleModuleTypeDataBase
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Mesh)
    TObjectPtr<UStaticMesh> Mesh;
 
    FRandomStream RandomStream;
 
    UPROPERTY(EditAnywhere, Category = Mesh)
    float LODSizeScale;
 
    UPROPERTY(EditAnywhere, Category = Mesh)
    uint8 bUseStaticMeshLODs : 1;
 
    UPROPERTY()
    uint8 CastShadows:1;
 
    UPROPERTY()
    uint8 DoCollisions:1;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    TEnumAsByte<enum EMeshScreenAlignment> MeshAlignment;
 
    UPROPERTY(EditAnywhere, Category=Mesh)
    uint8 bOverrideMaterial:1;
 
    UPROPERTY(EditAnywhere, Category = Mesh)
    uint8 bOverrideDefaultMotionBlurSettings : 1;
 
    UPROPERTY(EditAnywhere, Category = Mesh, meta=(EditCondition="bOverrideDefaultMotionBlurSettings"))
    uint8 bEnableMotionBlur : 1;
 
    UPROPERTY(EditAnywhere, Category=Orientation)
    FRawDistributionVector RollPitchYawRange;
 
    UPROPERTY(EditAnywhere, Category=Orientation)
    TEnumAsByte<EParticleAxisLock> AxisLockOption;
 
    UPROPERTY(EditAnywhere, Category=CameraFacing)
    uint8 bCameraFacing:1;
 
    UPROPERTY()
    TEnumAsByte<enum EMeshCameraFacingUpAxis> CameraFacingUpAxisOption_DEPRECATED;
 
    UPROPERTY(EditAnywhere, Category=CameraFacing)
    TEnumAsByte<enum EMeshCameraFacingOptions> CameraFacingOption;
 
    UPROPERTY(EditAnywhere, Category=CameraFacing)
    uint8 bApplyParticleRotationAsSpin : 1;
 
    UPROPERTY(EditAnywhere, Category=CameraFacing)
    uint8 bFaceCameraDirectionRatherThanPosition : 1;
 
    UPROPERTY(EditAnywhere, Category = Collision)
    uint8 bCollisionsConsiderPartilceSize : 1;
 
    static int32 GetCurrentDetailMode();
    static int32 GetMeshParticleMotionBlurMinDetailMode();
 
#if WITH_EDITOR
    void OnMeshChanged();
#endif
 
    virtual void PostLoad();
 
    //~ Begin UObject Interface
    virtual bool IsPostLoadThreadSafe() const override;
#if WITH_EDITOR
    virtual void BeginDestroy() override;
    virtual void PreEditChange(FProperty* PropertyThatWillChange) override;
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
 
    virtual void    Serialize(FArchive& Ar) override;
 
    //~ End UObject Interface
 
    void CreateDistribution();
 
    //~ Begin UParticleModule Interface
    virtual void    SetToSensibleDefaults(UParticleEmitter* Owner) override;
    //~ End UParticleModule Interface
 
    //~ Begin UParticleModuleTypeDataBase Interface
    virtual FParticleEmitterInstance* CreateInstance(UParticleEmitter* InEmitterParent, IParticleEmitterInstanceOwner& InComponent) override;
    virtual const FVertexFactoryType* GetVertexFactoryType() const override;
    virtual void CollectPSOPrecacheData(const UParticleEmitter* Emitter, FPSOPrecacheParams& OutParams) override;
    virtual bool    SupportsSpecificScreenAlignmentFlags() const override { return true;    }   
    virtual bool    SupportsSubUV() const override { return true; }
    virtual bool    IsAMeshEmitter() const override { return true; }
    virtual bool    IsMotionBlurEnabled() const override 
    { 
        if (bOverrideDefaultMotionBlurSettings)
        {
            return bEnableMotionBlur;
        }
        else
        {
            return GetMeshParticleMotionBlurMinDetailMode() >= 0 && GetCurrentDetailMode() >= GetMeshParticleMotionBlurMinDetailMode();
        }
    }
 
    //~ End UParticleModuleTypeDataBase Interface
};