1. Epic GamesDeveloper
  3. ULandscapeEditLayerBase

ULandscapeEditLayerBase

Base class for all landscape edit layers.

API > API/Runtime > API/Runtime/Landscape

Base class for all landscape edit layers. By implementing the various virtual functions, we are able to customize the behavior of the edit layer wrt the landscape tools in a generic way (e.g. does it support sculpting tools? painting tools? can it be collapsed?, etc.)

   
Name ULandscapeEditLayerBase
Type class
Header File /Engine/Source/Runtime/Landscape/Classes/LandscapeEditLayer.h
Include Path #include "LandscapeEditLayer.h"

Syntax

UCLASS (MinimalAPI, Abstract)  
class ULandscapeEditLayerBase :  
    public UObject ,  
    public UE::Landscape::EditLayers::IEditLayerRendererProvider

Inheritance Hierarchy

Derived Classes

Typedefs

Name Type Remarks Include Path
FCanExecuteDelegate TBaseDelegate_TwoParams< bool, const FExecuteParams &, FText & >   LandscapeEditLayer.h
FExecuteDelegate TBaseDelegate_OneParam< FExecuteResult, const FExecuteParams & >   LandscapeEditLayer.h
FOnLayerDataChanged TMulticastDelegate_OneParam< void, const FOnLandscapeEditLayerDataChangedParams & > Delegate triggered whenever a change occurred on the edit layer's data LandscapeEditLayer.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bSuccess bool   LandscapeEditLayer.h  
CanExecuteDelegate FCanExecuteDelegate   LandscapeEditLayer.h  
EditLayer const ULandscapeEditLayerBase *   LandscapeEditLayer.h  
ExecuteDelegate FExecuteDelegate   LandscapeEditLayer.h  
Label FText   LandscapeEditLayer.h  
Landscape ALandscape *   LandscapeEditLayer.h  
Layer const FLandscapeLayer *   LandscapeEditLayer.h  
OnLayerDataChangedDelegate FOnLayerDataChanged   LandscapeEditLayer.h  
Reason FText   LandscapeEditLayer.h  
WeightmapLayerAllocationBlend TMap< TObjectPtr< ULandscapeLayerInfoObject >, bool >   LandscapeEditLayer.h
  • Setter="SetWeightmapLayerAllocationBlendInternal"
  • Meta=(EditCondition="!bLocked")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddOrUpdateWeightmapAllocationLayerBlend ( TObjectPtr< ULandscapeLayerInfoObject > InKey,
bool InValue,
bool bInModify
)

 Updates the value of an existing layer allocation or adds a weightmap layer allocation if no entry is found LandscapeEditLayer.h  

FExecuteParams ( const ULandscapeEditLayerBase* InEditLayer,
ALandscape* InLandscape
)

   LandscapeEditLayer.h  

FExecuteParams ( const FLandscapeLayer* InLayer,
ALandscape* InLandscape
)

   LandscapeEditLayer.h  

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FEditLayerAction > GetActions()

   LandscapeEditLayer.h  

virtual float GetAlphaForTargetType ( ELandscapeToolTargetType InType
) const

 Gets the alpha value for a given target type LandscapeEditLayer.h  

virtual FFloatInterval GetAlphaRangeForTargetType ( ELandscapeToolTargetType InType
) const

   LandscapeEditLayer.h  

virtual ELandscapeBlendMode GetBlendMode()

   LandscapeEditLayer.h  

virtual FString GetDefaultName()

   LandscapeEditLayer.h  

const ULandscapeEditLayerBase * GetEditLayer()

   LandscapeEditLayer.h  

virtual ELandscapeToolTargetTypeFlags GetEnabledTargetTypeMask()

   LandscapeEditLayer.h  

virtual const FGuid & GetGuid()

   LandscapeEditLayer.h  

ALandscape * GetLandscape()

   LandscapeEditLayer.h  

const FLandscapeLayer * GetLayer()

   LandscapeEditLayer.h  

virtual FName GetName()

   LandscapeEditLayer.h  

virtual void GetRenderDependencies ( TSet< UObject* >& OutDependencies
) const

   LandscapeEditLayer.h  

virtual const TMap< TObjectPtr< ULandscapeLayerInfoObject >, bool > & GetWeightmapLayerAllocationBlend()

   LandscapeEditLayer.h  

virtual bool IsLocked()

   LandscapeEditLayer.h  

virtual bool IsVisible()

   LandscapeEditLayer.h  

virtual bool NeedsPersistentTextures()

   LandscapeEditLayer.h  

FOnLayerDataChanged::RegistrationType & OnLayerDataChanged()

   LandscapeEditLayer.h  

virtual void OnLayerRemoved ()

 Called by landscape after removing this layer from its list so that the layer can do any cleanup that it might need to do. LandscapeEditLayer.h  

virtual bool RemoveAndCopyWeightmapAllocationLayerBlend ( TObjectPtr< ULandscapeLayerInfoObject > InKey,
bool& bOutValue,
bool bInModify
)

 Remove and Copy a weightmap layer allocation for a given LayerInfoObj LandscapeEditLayer.h  

virtual void SetAlphaForTargetType ( ELandscapeToolTargetType InType,
float InNewValue,
bool bInModify,
EPropertyChangeType::Type InChangeType
)

 Sets the alpha value for a given target type LandscapeEditLayer.h  

virtual void SetGuid ( const FGuid& InGuid,
bool bInModify
)

 Sets the layer's Guid value LandscapeEditLayer.h  

virtual void SetLocked ( bool bInLocked,
bool bInModify
)

 Sets the layer's locked value LandscapeEditLayer.h  

virtual void SetName ( FName InName,
bool bInModify
)

 Sets the layer's Name value LandscapeEditLayer.h  

virtual void SetVisible ( bool bInVisible,
bool bInModify
)

 Sets the layer's visibility value LandscapeEditLayer.h  

virtual void SetWeightmapLayerAllocationBlend ( const TMap< TObjectPtr< ULandscapeLayerInfoObject >, bool >& InWeightmapLayerAllocationBlend,
bool bInModify
)

 Sets the layers WeightmapLayerAllocation map LandscapeEditLayer.h  

virtual bool SupportsAlphaForTargetType ( ELandscapeToolTargetType InType
) const

   LandscapeEditLayer.h  

virtual bool SupportsBeingCollapsedAway()

   LandscapeEditLayer.h  

virtual bool SupportsBlueprintBrushes()

   LandscapeEditLayer.h  

virtual bool SupportsCollapsingTo()

   LandscapeEditLayer.h  

virtual bool SupportsEditingTools()

   LandscapeEditLayer.h  

virtual bool SupportsMultiple()

   LandscapeEditLayer.h  

virtual bool SupportsTargetType ( ELandscapeToolTargetType InType
) const

   LandscapeEditLayer.h  

Overridden from IEditLayerRendererProvider

Name Remarks Include Path Unreal Specifiers

virtual TArray< UE::Landscape::EditLayers::FEditLayerRendererState > GetEditLayerRendererStates ( const UE::Landscape::EditLayers::FMergeContext* InMergeContext
)

 By default this does nothing in a landscape edit layer, but subclasses can override it if they would like to provide additional renderers. LandscapeEditLayer.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BroadcastOnLayerDataChanged ( FName InPropertyName,
bool bInUserTriggered,
bool bRequiresLandscapeUpdate,
bool bInHasValueChanged,
EPropertyChangeType::Type InChangeType
)

 Internal function meant to be called whenever the edit layer data changes, broadcast the OnLayerDataChanged event LandscapeEditLayer.h  

float & GetAlphaForTargetTypeRef ( ELandscapeToolTargetType InType
)

 Internal function that returns a reference to the alpha value corresponding to a given target type (HeightmapAlpha, WeightmapAlpha, ...) LandscapeEditLayer.h  

FProperty * GetAlphaPropertyForTargetType ( ELandscapeToolTargetType InType
) const

 Internal function that returns the alpha FProperty corresponding to a given target type (HeightmapAlpha, WeightmapAlpha, ...) LandscapeEditLayer.h  

void SetGuidInternal ( const FGuid& InGuid
)

 End UObject implementation. LandscapeEditLayer.h  

void SetHeightmapAlphaInternal ( float InNewValue
)

   LandscapeEditLayer.h  

void SetLockedInternal ( bool bInLocked
)

   LandscapeEditLayer.h  

void SetNameInternal ( FName InName
)

   LandscapeEditLayer.h  

void SetVisibleInternal ( bool bInVisible
)

   LandscapeEditLayer.h  

void SetWeightmapAlphaInternal ( float InNewValue
)

   LandscapeEditLayer.h  

void SetWeightmapLayerAllocationBlendInternal ( const TMap< TObjectPtr< ULandscapeLayerInfoObject >, bool >& InWeightmapLayerAllocationBlend
)

 Marked as UE_INTERNAL to prevent external usage before blend refactor with the introduction of blend groups and premultiplied alpha blending. LandscapeEditLayer.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   LandscapeEditLayer.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   LandscapeEditLayer.h  

virtual void PostEditUndo()

   LandscapeEditLayer.h  

virtual void PostLoad()

 Begin UObject implementation. LandscapeEditLayer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page