Landscape.h File Reference

#include "CoreMinimal.h"
#include "LandscapeComponent.h"
#include "UObject/ObjectMacros.h"
#include "LandscapeProxy.h"
#include "LandscapeBlueprintBrushBase.h"
#include "LandscapeEditTypes.h"
#include "Delegates/DelegateCombinations.h"
#include "Templates/SubclassOf.h"
#include "Algo/Transform.h"
#include "LandscapeLayerInfoObject.h"
#include "Landscape.generated.h"

Go to the source code of this file.

Classes
struct	FLandscapeLayerBrush
struct	FLandscapeLayer
struct	FOnLandscapeEditLayersMergedParams
struct	FLandscapeEditLayerRenderCommonParams
struct	FLandscapeEditLayerRenderHeightParams
struct	FLandscapeEditLayerRenderWeightParams

Namespaces
namespace	EditLayersHeightmapLocalMerge_RenderThread
namespace	EditLayersWeightmapLocalMerge_RenderThread
namespace	UE
namespace	UE::Landscape
namespace	UE::Landscape::EditLayers

Enumerations
enum class	ERTDrawingType : uint8 {   RTAtlas , RTAtlasToNonAtlas , RTNonAtlasToAtlas , RTNonAtlas ,   RTMips }
enum class	EHeightmapRTType : uint8 {   HeightmapRT_CombinedAtlas , HeightmapRT_CombinedNonAtlas , HeightmapRT_Scratch1 , HeightmapRT_Scratch2 ,   HeightmapRT_Scratch3 , HeightmapRT_Mip1 , HeightmapRT_Mip2 , HeightmapRT_Mip3 ,   HeightmapRT_Mip4 , HeightmapRT_Mip5 , HeightmapRT_Mip6 , HeightmapRT_Mip7 ,   HeightmapRT_Count }
enum class	EWeightmapRTType : uint8 {   WeightmapRT_Scratch_RGBA , WeightmapRT_Scratch1 , WeightmapRT_Scratch2 , WeightmapRT_Scratch3 ,   WeightmapRT_Mip0 , WeightmapRT_Mip1 , WeightmapRT_Mip2 , WeightmapRT_Mip3 ,   WeightmapRT_Mip4 , WeightmapRT_Mip5 , WeightmapRT_Mip6 , WeightmapRT_Mip7 ,   WeightmapRT_Count }
enum	ELandscapeBlendMode : int { LSBM_AdditiveBlend , LSBM_AlphaBlend , LSBM_MAX }

Functions
	UCLASS (MinimalAPI, showcategories=(Display, Movement, Collision, Lighting, LOD, Input), hidecategories=(Mobility)) class ALandscape

Enumeration Type Documentation

EHeightmapRTType

enum class EHeightmapRTType : uint8

strong

Enumerator
HeightmapRT_CombinedAtlas
HeightmapRT_CombinedNonAtlas
HeightmapRT_Scratch1
HeightmapRT_Scratch2
HeightmapRT_Scratch3
HeightmapRT_Mip1
HeightmapRT_Mip2
HeightmapRT_Mip3
HeightmapRT_Mip4
HeightmapRT_Mip5
HeightmapRT_Mip6
HeightmapRT_Mip7
HeightmapRT_Count

ELandscapeBlendMode

enum ELandscapeBlendMode : int

Enumerator
LSBM_AdditiveBlend
LSBM_AlphaBlend
LSBM_MAX

ERTDrawingType

enum class ERTDrawingType : uint8

strong

Enumerator
RTAtlas
RTAtlasToNonAtlas
RTNonAtlasToAtlas
RTNonAtlas
RTMips

EWeightmapRTType

enum class EWeightmapRTType : uint8

strong

Enumerator
WeightmapRT_Scratch_RGBA
WeightmapRT_Scratch1
WeightmapRT_Scratch2
WeightmapRT_Scratch3
WeightmapRT_Mip0
WeightmapRT_Mip1
WeightmapRT_Mip2
WeightmapRT_Mip3
WeightmapRT_Mip4
WeightmapRT_Mip5
WeightmapRT_Mip6
WeightmapRT_Mip7
WeightmapRT_Count

Function Documentation

UCLASS()

UCLASS	(	MinimalAPI	,
		showcategories	= (Display, Movement, Collision, Lighting, LOD, Input),
		hidecategories	= (Mobility)
	)

Computes & returns bounds containing all currently loaded landscape proxies (if any) or this landscape's bounds otherwise

Render the final heightmap in the requested top-down window as one -atlased- texture in the provided render target 2D Can be called at runtime.

Parameters

InWorldTransform	World transform of the area where the texture should be rendered
InExtents	Extents of the area where the texture should be rendered (local to InWorldTransform). If size is zero, then the entire loaded landscape will be exported.
OutRenderTarget	Render target in which the texture will be rendered. The size/format of the render target will be respected.

Returns

false in case of failure (e.g. invalid inputs, incompatible render target format...)

Render the final weightmap for the requested layer, in the requested top-down window, as one -atlased- texture in the provided render target 2D Can be called at runtime.

Parameters

InWorldTransform	World transform of the area where the texture should be rendered
InExtents	Extents of the area where the texture should be rendered (local to InWorldTransform). If size is zero, then the entire loaded landscape will be exported.
InWeightmapLayerName	Weightmap layer that is being requested to render
OutRenderTarget	Render target in which the texture will be rendered. The size/format of the render target will be respected.

Returns

false in case of failure (e.g. invalid inputs, incompatible render target format...)

Render the final weightmaps for the requested layers, in the requested top-down window, as one -atlased- texture in the provided render target (2D or 2DArray) Can be called at runtime.

Parameters

InWorldTransform	World transform of the area where the texture should be rendered
InExtents	Extents of the area where the texture should be rendered (local to InWorldTransform). If size is zero, then the entire loaded landscape will be exported.
InWeightmapLayerNames	List of weightmap layers that are being requested to render
OutRenderTarget	Render target in which the texture will be rendered. The size/format of the render target will be respected. If a UTextureRenderTarget2D is passed, the requested layers will be packed in the RGBA channels in order (up to the number of channels available with the render target's format). If a UTextureRenderTarget2DArray is passed, the requested layers will be packed in the RGBA channels of each slice (up to the number of channels * slices available with the render target's format and number of slices).

Returns

false in case of failure (e.g. invalid inputs, incompatible render target format...)

Retrieves the names of valid paint layers on this landscape (editor-only : returns nothing at runtime) @Param bInIncludeVisibilityLayer whether the visibility layer's name should be included in the list or not

Returns

the list of paint layer names