LandscapeEditLayerTargetTypeState.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "LandscapeEditTypes.h"
 
 
// ----------------------------------------------------------------------------------
// Forward declarations
 
class ILandscapeEditLayerRenderer;
 
namespace UE::Landscape::EditLayers
{
    class FMergeContext;
    class FEditLayerRendererState;
}
// namespace UE::Landscape::EditLayers
 
 
// ----------------------------------------------------------------------------------
 
namespace UE::Landscape::EditLayers
{
 
#if WITH_EDITOR
 
class FEditLayerTargetTypeState
{
    friend ILandscapeEditLayerRenderer;
    friend FEditLayerRendererState;
 
private:
    // Private constructor : either use the constructors taking a merge context in parameter or use GetDummyTargetTypeState()
    FEditLayerTargetTypeState() = default;
 
public:
    static const FEditLayerTargetTypeState& GetDummyTargetTypeState();
 
    LANDSCAPE_API FEditLayerTargetTypeState(const FMergeContext* InMergeContext);
 
    LANDSCAPE_API FEditLayerTargetTypeState(const FMergeContext* InMergeContext, ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API FEditLayerTargetTypeState(const FMergeContext* InMergeContext, ELandscapeToolTargetTypeFlags InTargetTypeMask, const TArrayView<const FName>& InSupportedWeightmaps, bool bInChecked);
 
    LANDSCAPE_API FEditLayerTargetTypeState(const FMergeContext* InMergeContext, ELandscapeToolTargetTypeFlags InTargetTypeMask, const TBitArray<>& InSupportedWeightmapLayerIndices);
    
    LANDSCAPE_API bool IsActive(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName = NAME_None) const;
 
    LANDSCAPE_API bool IsActiveChecked(ELandscapeToolTargetType InTargetType, const FName& InWeightmapLayerName = NAME_None) const;
 
    LANDSCAPE_API bool IsActive(ELandscapeToolTargetType InTargetType, int32 InWeightmapLayerIndex = INDEX_NONE) const;
 
    LANDSCAPE_API TArray<FName> GetActiveWeightmaps() const;
 
    LANDSCAPE_API TBitArray<> GetActiveWeightmapBitIndices() const;
 
    ELandscapeToolTargetTypeFlags GetTargetTypeMask() const { return TargetTypeMask; }
 
    LANDSCAPE_API void SetTargetTypeMask(ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API void AddTargetType(ELandscapeToolTargetType InTargetType);
 
    LANDSCAPE_API void AddTargetTypeMask(ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API void RemoveTargetType(ELandscapeToolTargetType InTargetType);
 
    LANDSCAPE_API void RemoveTargetTypeMask(ELandscapeToolTargetTypeFlags InTargetTypeMask);
 
    LANDSCAPE_API void AddWeightmap(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void AddWeightmapChecked(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void AddWeightmap(int32 InWeightmapLayerIndex);
 
    LANDSCAPE_API void RemoveWeightmap(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void RemoveWeightmapChecked(const FName& InWeightmapLayerName);
 
    LANDSCAPE_API void RemoveWeightmap(int32 InWeightmapLayerIndex);
 
    FEditLayerTargetTypeState Intersect(const FEditLayerTargetTypeState& InOther) const;
 
    bool operator == (const FEditLayerTargetTypeState& InOther) const;
 
    FString ToString() const;
 
private:
    const FMergeContext* MergeContext = nullptr;
 
    ELandscapeToolTargetTypeFlags TargetTypeMask = ELandscapeToolTargetTypeFlags::None;
    
    TBitArray<> WeightmapTargetLayerBitIndices;
};
#endif // WITH_EDITOR
 
} //namespace UE::Landscape::EditLayers