ParticleModuleLocationSkelVertSurface.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 "Particles/Location/ParticleModuleLocationBase.h"
#include "ParticleModuleLocationSkelVertSurface.generated.h"
 
class UParticleLODLevel;
class UParticleModuleTypeDataBase;
class UParticleSystemComponent;
class USkeletalMeshComponent;
struct FParticleEmitterInstance;
class FSkeletalMeshLODRenderData;
struct FSkelMeshRenderSection;
 
UENUM()
enum ELocationSkelVertSurfaceSource : int
{
    VERTSURFACESOURCE_Vert UMETA(DisplayName="Vertices"),
    VERTSURFACESOURCE_Surface UMETA(DisplayName="Surfaces"),
    VERTSURFACESOURCE_MAX,
};
 
struct FModuleLocationVertSurfaceInstancePayload
{
    TWeakObjectPtr<USkeletalMeshComponent> SourceComponent;
    TWeakObjectPtr<AActor> CachedActor;
    int32 VertIndex;
    int32 NumValidAssociatedBoneIndices;
    TPreallocatedArrayProxy<int32> ValidAssociatedBoneIndices;
    TPreallocatedArrayProxy<FVector3f> PrevFrameBonePositions;
    TPreallocatedArrayProxy<FVector3f> BoneVelocities;
 
    int32 MeshMinLOD;
 
    void InitArrayProxies(int32 FixedArraySize)
    {
        // Calculate offsets into instance data buffer for the arrays and initialize the buffer proxies. The allocation 
        // size for these arrays is calculated in RequiredBytesPerInstance.
        const uint32 StructSize = sizeof(FModuleLocationVertSurfaceInstancePayload);
        ValidAssociatedBoneIndices = TPreallocatedArrayProxy<int32>((uint8*)this + StructSize, FixedArraySize);
 
        uint32 StructOffset = StructSize + (FixedArraySize * sizeof(int32));
        PrevFrameBonePositions = TPreallocatedArrayProxy<FVector3f>((uint8*)this + StructOffset, FixedArraySize);
 
        StructOffset = StructSize + (FixedArraySize * sizeof(int32)) + (FixedArraySize * sizeof(FVector3f));
        BoneVelocities = TPreallocatedArrayProxy<FVector3f>((uint8*)this + StructOffset, FixedArraySize);
    }
 
    inline bool MeshIsValid() { return SourceComponent.IsValid() && MeshMinLOD != INDEX_NONE; }
};
 
struct FModuleLocationVertSurfaceParticlePayload
{
    int32 SourceIndex;
};
 
 
UCLASS(editinlinenew, hidecategories=Object, meta=(DisplayName = "Skel Vert/Surf Location"), MinimalAPI)
class UParticleModuleLocationSkelVertSurface : public UParticleModuleLocationBase
{
    GENERATED_UCLASS_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=VertSurface)
    TEnumAsByte<enum ELocationSkelVertSurfaceSource> SourceType;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    FVector UniversalOffset;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    uint32 bUpdatePositionEachFrame:1;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    uint32 bOrientMeshEmitters:1;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    uint32 bInheritBoneVelocity:1;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    float InheritVelocityScale;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    FName SkelMeshActorParamName;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=VertSurface)
    TObjectPtr<class USkeletalMesh> EditorSkelMesh;
 
#endif // WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=VertSurface)
    TArray<FName> ValidAssociatedBones;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    uint32 bEnforceNormalCheck:1;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    FVector NormalToCompare;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    float NormalCheckToleranceDegrees;
 
    UPROPERTY()
    float NormalCheckTolerance;
 
    UPROPERTY(EditAnywhere, Category=VertSurface)
    TArray<int32> ValidMaterialIndices;
 
    UPROPERTY(EditAnywhere, Category = VertSurface)
    uint32 bInheritVertexColor : 1;
 
    UPROPERTY(EditAnywhere, Category = VertSurface)
    uint32 bInheritUV : 1;
 
    UPROPERTY(EditAnywhere, Category = VertSurface)
    uint32 InheritUVChannel;
 
    //~ Begin UObject Interface
    ENGINE_API virtual void PostLoad() override;
#if WITH_EDITOR
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif // WITH_EDITOR
    //~ End UObject Interface
 
    //Begin UParticleModule Interface
    ENGINE_API virtual void Spawn(const FSpawnContext& Context) override;
    ENGINE_API virtual void Update(const FUpdateContext& Context) override;
    ENGINE_API virtual void FinalUpdate(const FUpdateContext& Context) override;
    ENGINE_API virtual uint32   PrepPerInstanceBlock(FParticleEmitterInstance* Owner, void* InstData) override;
    ENGINE_API virtual uint32   RequiredBytes(UParticleModuleTypeDataBase* TypeData) override;
    ENGINE_API virtual uint32   RequiredBytesPerInstance() override;
    virtual bool    TouchesMeshRotation() const override { return true; }
    ENGINE_API virtual void AutoPopulateInstanceProperties(UParticleSystemComponent* PSysComp) override;
    virtual bool CanTickInAnyThread() override
    {
        return false;
    }
#if WITH_EDITOR
    ENGINE_API virtual int32 GetNumberOfCustomMenuOptions() const override;
    ENGINE_API virtual bool GetCustomMenuEntryDisplayString(int32 InEntryIndex, FString& OutDisplayString) const override;
    ENGINE_API virtual bool PerformCustomMenuEntry(int32 InEntryIndex) override;
    ENGINE_API virtual bool IsValidForLODLevel(UParticleLODLevel* LODLevel, FString& OutErrorString) override;
#endif
    //End UParticleModule Interface
 
    ENGINE_API void GetSkeletalMeshComponentSource(const FContext& Context, FModuleLocationVertSurfaceInstancePayload* InstancePayload);
 
    ENGINE_API bool GetParticleLocation(const FContext& Context, FModuleLocationVertSurfaceInstancePayload* InstPayload, USkeletalMeshComponent* InSkelMeshComponent, int32 InPrimaryVertexIndex, FVector& OutPosition, FQuat& OutRotation, bool bSpawning = false);
 
    ENGINE_API bool VertInfluencedByActiveBone(FParticleEmitterInstance* Owner, FModuleLocationVertSurfaceInstancePayload* InstPayload, USkeletalMeshComponent* InSkelMeshComponent, int32 InVertexIndex, int32* OutBoneIndex = NULL);
 
    ENGINE_API void UpdateBoneIndicesList(FParticleEmitterInstance* Owner);
 
private:
    ENGINE_API bool VertInfluencedByActiveBoneTyped(FSkeletalMeshLODRenderData& LODData, int32 LODIndex, const FSkelMeshRenderSection& Section, int32 VertIndex, USkeletalMeshComponent* InSkelMeshComponent, FModuleLocationVertSurfaceInstancePayload* InstancePayload, int32* OutBoneIndex);
};