LandscapeEditLayerRendererState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "LandscapeEditTypes.h"
#include "LandscapeEditLayerTargetTypeState.h"
#include "LandscapeEditLayerTargetLayerGroup.h"
#include "UObject/ScriptInterface.h"
 
 
// ----------------------------------------------------------------------------------
// Forward declarations
 
class ILandscapeEditLayerRenderer;
 
 
namespace UE::Landscape::EditLayers
{
 
#if WITH_EDITOR
 
// ----------------------------------------------------------------------------------
 
class FEditLayerRendererState
{
private:
    // Private constructor : either use the constructors taking a merge context in parameter or use GetDummyRendererState()
    FEditLayerRendererState() = default;
 
public:
    static const FEditLayerRendererState& GetDummyRendererState();
 
    LANDSCAPE_API explicit FEditLayerRendererState(const FMergeContext* InMergeContext);
    LANDSCAPE_API explicit FEditLayerRendererState(const FMergeContext* InMergeContext, TScriptInterface<ILandscapeEditLayerRenderer> InRenderer);
 
    TScriptInterface<ILandscapeEditLayerRenderer> GetRenderer() const { return Renderer; }
 
    const FEditLayerTargetTypeState& GetSupportedTargetTypeState() const { return SupportedTargetTypeState; }
 
    const FEditLayerTargetTypeState& GetEnabledTargetTypeState() const { return EnabledTargetTypeState; }
 
    FEditLayerTargetTypeState GetActiveTargetTypeState() const { return ActiveTargetTypeState; }
 
    LANDSCAPE_API void EnableTargetType(ELandscapeToolTargetType InTargetType);
    
    LANDSCAPE_API void EnableTargetTypeMask(ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API void DisableTargetType(ELandscapeToolTargetType InTargetType);
 
    LANDSCAPE_API void DisableTargetTypeMask(ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API void EnableWeightmap(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void EnableWeightmapChecked(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void EnableWeightmap(ELandscapeToolTargetType InTargetType, int32 InWeightmapLayerIndex);
 
    LANDSCAPE_API void DisableWeightmap(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void DisableWeightmapChecked(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void DisableWeightmap(int32 InWeightmapLayerIndex);
 
    LANDSCAPE_API ELandscapeToolTargetTypeFlags GetActiveTargetTypeMask() const;
 
    LANDSCAPE_API bool IsTargetActive(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName = NAME_None) const;
 
    LANDSCAPE_API bool IsTargetActiveChecked(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName = NAME_None) const;
 
    LANDSCAPE_API bool IsTargetActive(ELandscapeToolTargetType InTargetType, int32 InWeightmapLayerIndex = INDEX_NONE) const;
 
    LANDSCAPE_API TArray<FName> GetActiveTargetWeightmaps() const;
 
    LANDSCAPE_API TBitArray<> GetActiveTargetWeightmapBitIndices() const;
 
    TArray<FTargetLayerGroup> GetTargetLayerGroups() const { return TargetLayerGroups; }
 
private:
    void UpdateActiveTargetTypeState();
 
private:
    const FMergeContext* MergeContext = nullptr;
 
    TScriptInterface<ILandscapeEditLayerRenderer> Renderer;
 
    FString DebugName;
    
PRAGMA_DISABLE_EXPERIMENTAL_WARNINGS
    FEditLayerTargetTypeState SupportedTargetTypeState = FEditLayerTargetTypeState::GetDummyTargetTypeState();
    
    FEditLayerTargetTypeState EnabledTargetTypeState = FEditLayerTargetTypeState::GetDummyTargetTypeState();
 
    FEditLayerTargetTypeState ActiveTargetTypeState = FEditLayerTargetTypeState::GetDummyTargetTypeState();
PRAGMA_ENABLE_EXPERIMENTAL_WARNINGS
 
    /* List of groups of target layers that this renderer requires to be rendered together. All target layers listed in SupportedTargetTypeState must belong to 1 (and 1 only) target layer group.
     *  Each target layer group is a bit array for which each bit corresponds to an entry in FMergeContext's AllTargetLayerNames
     */
    TArray<FTargetLayerGroup> TargetLayerGroups;
};
 
#endif // WITH_EDITOR
 
} //namespace UE::Landscape::EditLayers