LandscapeGrassType.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 "UObject/Object.h"
#include "Engine/EngineTypes.h"
#include "UObject/PerPlatformProperties.h"
#include "PerQualityLevelProperties.h"
#include "SceneTypes.h"
#include "LandscapeGrassType.generated.h"
 
#define UE_API LANDSCAPE_API
 
class UStaticMesh;
struct FPropertyChangedEvent;
 
UENUM()
enum class EGrassScaling : uint8
{
    Uniform,
    Free,
    LockXY,
};
 
USTRUCT(BlueprintType)
struct FGrassVariety
{
    GENERATED_USTRUCT_BODY()
 
    UE_API FGrassVariety();
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass)
    TObjectPtr<UStaticMesh> GrassMesh;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (ToolTip = "Material Overrides."))
    TArray<TObjectPtr<class UMaterialInterface>> OverrideMaterials;
 
    /* Instances per 10 square meters. */
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000, ClampMax = 1000))
    FPerPlatformFloat GrassDensity;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000, ClampMax = 1000))
    FPerQualityLevelFloat GrassDensityQuality;
 
    /* If true, use a jittered grid sequence for placement, otherwise use a halton sequence. */
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass)
    bool bUseGrid;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (EditCondition = "bUseGrid", UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1))
    float PlacementJitter;
 
    /* The distance where instances will begin to fade out if using a PerInstanceFadeAmount material node. 0 disables. */
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000000, ClampMax = 1000000))
    FPerPlatformInt StartCullDistance;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000000, ClampMax = 1000000))
    FPerQualityLevelInt StartCullDistanceQuality;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000000, ClampMax = 1000000))
    FPerPlatformInt EndCullDistance;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1000000, ClampMax = 1000000))
    FPerQualityLevelInt EndCullDistanceQuality;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass, meta = (UIMin = -1, ClampMin = -1, UIMax = 8, ClampMax = 8))
    int32 MinLOD;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (UIMin = 0.0, ClampMin = 0.0, UIMax = 1.0, ClampMax = 1.0))
    FFloatInterval AllowedDensityRange;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass)
    EGrassScaling Scaling;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass)
    FFloatInterval ScaleX;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (EditCondition = "Scaling == EGrassScaling::Free"))
    FFloatInterval ScaleY;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, meta = (EditCondition = "Scaling == EGrassScaling::Free || Scaling == EGrassScaling::LockXY"))
    FFloatInterval ScaleZ;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, AdvancedDisplay, Category = Grass)
    bool bWeightAttenuatesMaxScale = false;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, AdvancedDisplay, Category = Grass, meta = (UIMin = 0, ClampMin = 0, UIMax = 1, ClampMax = 1, EditCondition = "bWeightAttenuatesMaxScale == true"))
    float MaxScaleWeightAttenuation = 0.5f;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool RandomRotation;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool AlignToSurface;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass, meta = (EditCondition = "AlignToSurface && bUseGrid"))
    bool bAlignToTriangleNormals;
 
    /* Whether to use the landscape's lightmap when rendering the grass. */
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bUseLandscapeLightmap;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, AdvancedDisplay, Category = Grass)
    FLightingChannels LightingChannels;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bReceivesDecals;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bAffectDistanceFieldLighting;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bCastDynamicShadow;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bCastContactShadow;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    bool bKeepInstanceBufferCPUCopy;
 
    UPROPERTY(EditAnywhere, Category = Grass)
    uint32 InstanceWorldPositionOffsetDisableDistance;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category=Grass, AdvancedDisplay)
    EShadowCacheInvalidationBehavior ShadowCacheInvalidationBehavior;
 
    UE_API bool IsGrassQualityLevelEnable() const;
 
    UE_API int32 GetStartCullDistance() const;
 
    UE_API int32 GetEndCullDistance() const;
 
    UE_API float GetDensity() const;
 
};
 
UCLASS(BlueprintType, MinimalAPI)
class ULandscapeGrassType : public UObject
{
    GENERATED_UCLASS_BODY()
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Grass)
    TArray<FGrassVariety> GrassVarieties;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = Scalability)
    uint32 bEnableDensityScaling : 1;
 
    UPROPERTY()
    uint32 StateHash = 0;
 
    UPROPERTY()
    TObjectPtr<UStaticMesh> GrassMesh_DEPRECATED;
    UPROPERTY()
    float GrassDensity_DEPRECATED;
    UPROPERTY()
    float PlacementJitter_DEPRECATED;
    UPROPERTY()
    int32 StartCullDistance_DEPRECATED;
    UPROPERTY()
    int32 EndCullDistance_DEPRECATED;
    UPROPERTY()
    bool RandomRotation_DEPRECATED;
    UPROPERTY()
    bool AlignToSurface_DEPRECATED;
    
    //~ Begin UObject Interface
    virtual void PostLoad() override;
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    //~ End UObject Interface
 
    uint32 ComputeStateHash();
};
 
 
 
#undef UE_API