Navigation
API > API/Runtime > API/Runtime/Landscape
References
| Module | Landscape |
| Header | /Engine/Source/Runtime/Landscape/Public/LandscapeEditLayerRenderer.h |
| Include | #include "LandscapeEditLayerRenderer.h" |
Syntax
struct FEditLayerRendererState
Remarks
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 render groups this renderer needs when rendering its weightmap (i.e. which weightmap needs to be rendered with which weightmaps : e.g. for weight blending)
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
|||
 |
FEditLayerRendererState
(
ILandscapeEditLayerRenderer* InRenderer, |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | DisableTarget
(
FName InWeightmapLayerName |
Mutates the EnabledTargetTypeState by removing the weightmap in parameter from the list of enabled weightmaps |
 |
void | DisableTargetType
(
ELandscapeToolTargetType InTargetType |
Mutates the EnabledTargetTypeState by removing the target type in parameter from the mask of active target types |
 |
void | DisableTargetTypeMask
(
ELandscapeToolTargetTypeFlags InTargetTypeMask |
Mutates the EnabledTargetTypeState by removing the target type mask in parameter from the mask of active target types |
 |
bool | EnableTarget
(
ELandscapeToolTargetType InTargetType, |
Mutates the EnabledTargetTypeState by adding the weightmap in parameter to the list of enabled weightmaps |
 |
void | EnableTargetType
(
ELandscapeToolTargetType InTargetType |
Mutates the EnabledTargetTypeState by adding the target type in parameter to the mask of active target types |
 |
void | EnableTargetTypeMask
(
ELandscapeToolTargetTypeFlags InTargetTypeMask |
Mutates the EnabledTargetTypeState by adding the target type mask in parameter to the mask of active target types |
  |
const FEditLayerTargetTypeState & | Returns a mask of all target types supported by this renderer | |
  |
TArray< FName > | Returns the list of all weightmaps currently enabled | |
  |
ILandscapeEditLayerRenderer * | GetRenderer () |
Returns the edit layer renderer which this state relates to |
  |
const FEditLayerTargetTypeState & | Returns a mask of all target types supported by this renderer | |
  |
const TArray< FName > & | Returns a list of all weightmaps supported by this renderer (only relevant for ELandscapeToolTargetType::Weightmap (and ELandscapeToolTargetType::Visibility)) | |
  |
TArray< TSet< FName > > | Returns the render groups associated with this renderer. | |
  |
bool | IsTargetEnabled
(
ELandscapeToolTargetType InTargetType, |
Indicates whether a given target type is currently enabled by this renderer |
  |
bool | IsTargetSupported
(
ELandscapeToolTargetType InTargetType, |
Indicates whether a given target type is currently supported by this renderer |