1. Epic GamesDeveloper
  3. FEditLayerRendererState

FEditLayerRendererState

[FEditLayerRendererState](API\Runtime\Landscape\FEditLayerRendererState) describes the entire state of an edit layer renderer : what it is capable of doing (SupportedTargetTypeState, immutable) and what it is currently doing (EnabledTargetTypeState, mutable) These states are provided by [IEditLayerRendererProvider](API\Runtime\Landscape\IEditLayerRendererProvider) in order to describe both what the renderer can do and what it currently does by default.

API > API/Runtime > API/Runtime/Landscape

FEditLayerRendererState describes the entire state of an edit layer renderer : what it is capable of doing (SupportedTargetTypeState, immutable) and what it is currently doing (EnabledTargetTypeState, mutable) These states are provided by IEditLayerRendererProvider in order to describe both what the renderer can do and what it currently does by default. e.g. a disabled edit layer supports rendering heightmaps but its enabled state for the heightmap target type is false. This way, the user can selectively enable it at merge time without altering the entire landscape's state (i.e. just for the purpose of a specific merge render) A target type must be both supported and enabled on a given edit layer renderer in order for this renderer to render anything. It also describes the target layer groups this renderer needs when rendering its weightmap (i.e. which weightmap needs to be rendered with which weightmaps : e.g. for weight blending)

   
Name FEditLayerRendererState
Type class
Header File /Engine/Source/Runtime/Landscape/Public/LandscapeEditLayerRendererState.h
Include Path #include "LandscapeEditLayerRendererState.h"

Syntax

class FEditLayerRendererState

Constructors

Name Remarks Include Path Unreal Specifiers
  LandscapeEditLayerRendererState.h  

FEditLayerRendererState ( const FMergeContext* InMergeContext
)

   LandscapeEditLayerRendererState.h  
Private constructor : either use the constructors taking a merge context in parameter or use GetDummyRendererState() LandscapeEditLayerRendererState.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTargetTypeState FEditLayerTargetTypeState Intersection of SupportedTargetTypeState and EnabledTargetTypeState (defines what is both supported and enabled on this renderer) LandscapeEditLayerRendererState.h  
DebugName FString For debug purposes : this is the same as Renderer->GetEditLayerRendererDebugName() but having a member makes it easier to debug in the watch window LandscapeEditLayerRendererState.h  
EnabledTargetTypeState FEditLayerTargetTypeState Struct that contains the enabled target types and the which weightmap are currently enabled by this renderer. LandscapeEditLayerRendererState.h  
MergeContext const FMergeContext * Global context being used for this merge : contains generic information about the landscape, its available layer names, etc. LandscapeEditLayerRendererState.h  
Renderer TScriptInterface< ILandscapeEditLayerRenderer > Renderer associated with this state LandscapeEditLayerRendererState.h  
SupportedTargetTypeState FEditLayerTargetTypeState Struct that contains the supported target types and the which weightmap are supported by this renderer. LandscapeEditLayerRendererState.h  
TargetLayerGroups TArray< FTargetLayerGroup > List of groups of target layers that this renderer requires to be rendered together. LandscapeEditLayerRendererState.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DisableTargetType ( ELandscapeToolTargetType InTargetType
)

 Mutates the EnabledTargetTypeState by removing the target type in parameter from the mask of active target types LandscapeEditLayerRendererState.h  

void DisableTargetTypeMask ( ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Mutates the EnabledTargetTypeState by removing the target type mask in parameter from the mask of active target types LandscapeEditLayerRendererState.h  

void DisableWeightmap ( const FName& InWeightmapLayerName
)

 Mutates the EnabledTargetTypeState by removing the weightmap in parameter from the list of enabled weightmaps, if it is known to the merge context LandscapeEditLayerRendererState.h  

void DisableWeightmap ( int32 InWeightmapLayerIndex
)

 Mutates the EnabledTargetTypeState by removing the weightmap in parameter from the list of enabled weightmaps. LandscapeEditLayerRendererState.h  

void DisableWeightmapChecked ( const FName& InWeightmapLayerName
)

 Mutates the EnabledTargetTypeState by removing the weightmap in parameter from the list of enabled weightmaps. LandscapeEditLayerRendererState.h  

void EnableTargetType ( ELandscapeToolTargetType InTargetType
)

 Mutates the EnabledTargetTypeState by adding the target type in parameter to the mask of active target types LandscapeEditLayerRendererState.h  

void EnableTargetTypeMask ( ELandscapeToolTargetTypeFlags InTargetTypeMask
)

 Mutates the EnabledTargetTypeState by adding the target type mask in parameter to the mask of active target types LandscapeEditLayerRendererState.h  

void EnableWeightmap ( ELandscapeToolTargetType InTargetType,
int32 InWeightmapLayerIndex
)

 Mutates the EnabledTargetTypeState by adding the weightmap in parameter to the list of enabled weightmaps. LandscapeEditLayerRendererState.h  

void EnableWeightmap ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
)

 Mutates the EnabledTargetTypeState by adding the weightmap in parameter to the list of enabled weightmaps, if it is known to the merge context LandscapeEditLayerRendererState.h  

void EnableWeightmapChecked ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
)

 Mutates the EnabledTargetTypeState by adding the weightmap in parameter to the list of enabled weightmaps. LandscapeEditLayerRendererState.h  

ELandscapeToolTargetTypeFlags GetActiveTargetTypeMask()

 Returns the mask of target types that are both supported and enabled by this renderer LandscapeEditLayerRendererState.h  

FEditLayerTargetTypeState GetActiveTargetTypeState()

 Returns a mask of all target types / weightmaps supported and enabled on this renderer LandscapeEditLayerRendererState.h  

TBitArray GetActiveTargetWeightmapBitIndices()

 Returns a list of all weightmaps supported and enabled by this renderer (only relevant for ELandscapeToolTargetType::Weightmap (and ELandscapeToolTargetType::Visibility)) LandscapeEditLayerRendererState.h  

TArray< FName > GetActiveTargetWeightmaps()

 Returns a list of all weightmaps supported and enabled by this renderer (only relevant for ELandscapeToolTargetType::Weightmap (and ELandscapeToolTargetType::Visibility)) LandscapeEditLayerRendererState.h  

const FEditLayerTargetTypeState & GetEnabledTargetTypeState()

 Returns a mask of all target types / weightmaps enabled on this renderer LandscapeEditLayerRendererState.h  
Returns the edit layer renderer which this state relates to LandscapeEditLayerRendererState.h  

const FEditLayerTargetTypeState & GetSupportedTargetTypeState()

 Returns a mask of all target types / weightmaps supported by this renderer LandscapeEditLayerRendererState.h  
Returns the target layer groups associated with this renderer. LandscapeEditLayerRendererState.h  

bool IsTargetActive ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
) const

 Indicates whether a given target type and weightmap layer name is currently supported and enabled by this renderer. LandscapeEditLayerRendererState.h  

bool IsTargetActive ( ELandscapeToolTargetType InTargetType,
int32 InWeightmapLayerIndex
) const

 Indicates whether a given target type and weightmap layer name is currently supported and enabled by this renderer. LandscapeEditLayerRendererState.h  

bool IsTargetActiveChecked ( ELandscapeToolTargetType InTargetType,
const FName& InWeightmapLayerName
) const

 Indicates whether a given target type and weightmap layer name is currently supported and enabled by this renderer. LandscapeEditLayerRendererState.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FEditLayerRendererState & GetDummyRendererState()

   LandscapeEditLayerRendererState.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page