ALandscape

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Landscape

Header

/Engine/Source/Runtime/Landscape/Classes/Landscape.h

Include

#include "Landscape.h"

Syntax

class ALandscape : public ALandscapeProxy

Variables

Name Description

Public variable

bool

 

bCanHaveLayersContent

Public variable

bool

 

bGrassUpdateEnabled

Used to temporarily disable Grass Update in Editor

Public variable

FGuid

 

EditingLayer

Current Editing Landscape Layer

Public variable

TArray< TObject...

 

HeightmapRTList

Public variable

TArray< FLandsc...

 

LandscapeLayers

Public variable

FGuid

 

LandscapeSplinesTargetLayerGuid

Target Landscape Layer for Landscape Splines

Public variable

TSet< TObjectPt...

 

TrackedStreamingInTextures

List of textures that are not fully streamed in yet (updated every frame to track textures that have finished streaming in)

Public variable

TArray< TObject...

 

WeightmapRTList

Constructors

Name Description

Public function

ALandscape

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

AddBrushToLayer

(
    int32 InLayerIndex,
    ALandscapeBlueprintBrushBase* ...
)

Public function

void

 

AddLayersToProxy

(
    ALandscapeProxy* InProxy
)

Public function Static

void

 

CalcComponentIndicesNoOverlap

(
    const int32 X1,
    const int32 Y1,
    const int32 X2,
    const int32 Y2,
    const int32 ComponentSizeQuads,
    int32& ComponentIndexX1,
    int32& ComponentIndexY1,
    int32& ComponentIndexX2,
    int32& ComponentIndexY2
)

Exclude Components with overlapped vertices X2/Y2 Coordinates are "inclusive" max values

Public function Static

void

 

CalcComponentIndicesOverlap

(
    const int32 X1,
    const int32 Y1,
    const int32 X2,
    const int32 Y2,
    const int32 ComponentSizeQuads,
    int32& ComponentIndexX1,
    int32& ComponentIndexY1,
    int32& ComponentIndexX2,
    int32& ComponentIndexY2
)

Include Components with overlapped vertices X2/Y2 Coordinates are "inclusive" max values

Public function

void

 

ClearDirtyData

(
    ULandscapeComponent* InLandsca...
)

Public function

void

 

ClearLayer

(
    const FGuid& InLayerGuid,
    TSet< TObjectPtr< ULandscapeCompone...,
    ELandscapeClearMode InClearMode,
    bool bMarkPackageDirty
)

Public function

void

 

ClearLayer

(
    int32 InLayerIndex,
    TSet< TObjectPtr< ULandscapeCompone...,
    ELandscapeClearMode InClearMode
)

Public function

void

 

ClearPaintLayer

(
    int32 InLayerIndex,
    ULandscapeLayerInfoObject* InL...
)

Public function

void

 

ClearPaintLayer

(
    const FGuid& InLayerGuid,
    ULandscapeLayerInfoObject* InL...
)

Public function

void

 

CollapseLayer

(
    int32 InLayerIndex
)

Public function Const

FIntPoint

 

ComputeComponentCounts()

Public function

bool

 

ComputeLandscapeLayerBrushInfo

(
    FTransform& OutLandscapeTransform,
    FIntPoint& OutLandscapeSize,
    FIntPoint& OutLandscapeRenderTarge...
)

Public function

void

 

CopyOldDataToDefaultLayer()

Public function

void

 

CopyOldDataToDefaultLayer

(
    ALandscapeProxy* Proxy
)

Public function

void

 

CreateDefaultLayer()

Public function

int32

 

CreateLayer

(
    FName InName
)

Public function

void

 

DeleteLayer

(
    int32 InLayerIndex
)

Public function

void

 

DeleteLayers()

Public function

FLandscapeLa...

 

DuplicateLayerAndMoveBrushes

(
    const FLandscapeLayer& InOtherLaye...
)

Public function

void

 

ForceLayersFullUpdate()

Public function

void

 

ForceUpdateLayersContent

(
    bool bIntermediateRender
)

Public function

void

 

ForEachLayer

(
    TFunctionRef< void...
)

Protected function Const

FName

 

GenerateUniqueLayerName

(
    FName InName
)

Public function Const

TArray< clas...

 

GetBrushesForLayer

(
    int32 InLayerIndex
)

Public function Const

ALandscapeBl...

 

GetBrushForLayer

(
    int32 InLayerIndex,
    int32 BrushIndex
)

Public function

int32

 

GetBrushIndexForLayer

(
    int32 InLayerIndex,
    ALandscapeBlueprintBrushBase* ...
)

Public function Const

int32

 

GetBrushLayer

(
    ALandscapeBlueprintBrushBase* ...
)

Public function Const

float

 

GetClampedLayerAlpha

(
    float InAlpha,
    bool bInHeightmap
)

Public function Const

FBox

 

GetCompleteBounds()

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

Public function Const

const FGuid ...

 

GetEditingLayer()

Public function

FLandscapeLa...

 

GetLandscapeSplinesReservedLayer()

Public function Const

const FLands...

 

GetLandscapeSplinesReservedLayer()

Public function Const

const FLands...

 

GetLayer

(
    const FGuid& InLayerGuid
)

Public function

FLandscapeLa...

 

GetLayer

(
    int32 InLayerIndex
)

Public function Const

const FLands...

 

GetLayer

(
    int32 InLayerIndex
)

Public function Const

const FLands...

 

GetLayer

(
    const FName& InLayerName
)

Public function Const

float

 

GetLayerAlpha

(
    int32 InLayerIndex,
    bool bInHeightmap
)

Public function Const

uint8

 

GetLayerCount()

Public function Const

int32

 

GetLayerIndex

(
    FName InLayerName
)

Public function Const

FBox

 

GetLoadedBounds()

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

Public function Const

void

 

GetUsedPaintLayers

(
    const FGuid& InLayerGuid,
    TArray< ULandscapeLayerInfoObject&...
)

Public function Const

void

 

GetUsedPaintLayers

(
    int32 InLayerIndex,
    TArray< ULandscapeLayerInfoObject&...
)

Public function

bool

 

HasAllComponent()

Public function

void

 

InitializeLandscapeLayersWeightmapUsage()

Public function Const

bool

 

IsEditingLayerReservedForSplines()

Public function Const

bool

 

IsLayerBlendSubstractive

(
    int32 InLayerIndex,
    const TWeakObjectPtr< ULandscapeLay...
)

Public function Const

bool

 

IsLayerNameUnique

(
    const FName& InName
)

Public function Const

bool

 

IsMaxLayersReached()

Public function Const

bool

 

IsUpToDate()

Public function

void

 

OnBlueprintBrushChanged()

Public function

FLandscapeBl...

 

OnBlueprintBrushChangedDelegate()

Public function

FLandscapeFu...

 

OnFullHeightmapRenderDoneDelegate()

Public function

void

 

OnLayerInfoSplineFalloffModulationChanged

(
    ULandscapeLayerInfoObject* InL...
)

Public function

void

 

OnPreSave()

Public function

void

 

RegisterLandscapeEdMode

(
    ILandscapeEdModeInterface* InL...
)

Layers stuff.

Public function

void

 

ReleaseLayersRenderingResource()

Public function

void

 

RemoveBrush

(
    ALandscapeBlueprintBrushBase* ...
)

Public function

void

 

RemoveBrushFromLayer

(
    int32 InLayerIndex,
    int32 InBrushIndex
)

Public function

void

 

RemoveBrushFromLayer

(
    int32 InLayerIndex,
    ALandscapeBlueprintBrushBase* ...
)

Public function

bool

 

ReorderLayer

(
    int32 InStartingLayerIndex,
    int32 InDestinationLayerIndex
)

Public function

bool

 

ReorderLayerBrush

(
    int32 InLayerIndex,
    int32 InStartingLayerBrushIndex,
    int32 InDestinationLayerBrushIndex
)

Public function

void

 

RequestLayersContentUpdate

(
    ELandscapeLayerUpdateMode InModeMas...
)

Public function

void

 

RequestLayersContentUpdateForceAll

(
    ELandscapeLayerUpdateMode InModeMas...
)

Public function

void

 

RequestLayersInitialization

(
    bool bInRequestContentUpdate
)

Public function

void

 

RequestProxyLayersWeightmapUsageUpdate()

Public function

void

 

RequestSplineLayerUpdate()

Public function

void

 

SetEditingLayer

(
    const FGuid& InLayerGuid
)

Public function

void

 

SetGrassUpdateEnabled

(
    bool bInGrassUpdateEnabled
)

Public function

void

 

SetLandscapeSplinesReservedLayer

(
    int32 InLayerIndex
)

Public function

void

 

SetLayerAlpha

(
    int32 InLayerIndex,
    const float InAlpha,
    bool bInHeightmap
)

Public function

void

 

SetLayerLocked

(
    int32 InLayerIndex,
    bool bLocked
)

Public function

void

 

SetLayerName

(
    int32 InLayerIndex,
    const FName& InName
)

Public function

void

 

SetLayerSubstractiveBlendStatus

(
    int32 InLayerIndex,
    bool InStatus,
    const TWeakObjectPtr< ULandscapeLay...
)

Public function

void

 

SetLayerVisibility

(
    int32 InLayerIndex,
    bool bInVisible
)

Public function

void

 

ShowAllLayers()

Public function

void

 

ShowOnlySelectedLayer

(
    int32 InLayerIndex
)

Public function Static

void

 

SplitHeightmap

(
    ULandscapeComponent* Comp,
    ALandscapeProxy* TargetProxy,
    FMaterialUpdateContext* InOutU...,
    TArray< class FComponentRecreateRen...,
    bool InReregisterComponent
)

Public function

void

 

TickLayers

(
    float DeltaTime
)

Public function

void

 

ToggleCanHaveLayersContent()

Public function

void

 

UnregisterLandscapeEdMode()

Public function

void

 

UpdateLandscapeSplines

(
    const FGuid& InLayerGuid,
    bool bInUpdateOnlySelected,
    bool bInForceUpdateAllCompoments
)

Public function

void

 

UpdateProxyLayersWeightmapUsage()

Public function Const

void

 

ValidateProxyLayersWeightmapUsage()

Overridden from ALandscapeProxy

Name Description

Public function Virtual

ALandscape &...

 

GetLandscapeActor()

Public function Virtual Const

const ALands...

 

GetLandscapeActor()

Public function Virtual Const

bool

 

HasLayersContent()

Will tell if the landscape proxy as some content related to the layer system

Overridden from AActor

Name Description

Public function Virtual Const

bool

 

CanChangeIsSpatiallyLoadedFlag()

Returns true if this actor allows changing the spatially loaded flag.

Public function Virtual Const

bool

 

CanDeleteSelectedActor

(
    FText& OutReason
)

When selected can this actor be deleted?

Public function Virtual

void

 

PostEditMove

(
    bool bFinished
)

Called after an actor has been moved in the editor

Public function Virtual

bool

 

ShouldImport

(
    FString* ActorPropString,
    bool IsMovingLevel
)

Called before editor paste, true allow import

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Public function Virtual

void

 

PostDuplicate

(
    bool bDuplicateForPIE
)

Called after duplication & serialization and before PostLoad.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditChange

(
    FProperty* PropertyAboutToChan...
)

This is called when a property is about to be modified externally

Public function Virtual

void

 

PreSave

(
    FObjectPreSaveContext SaveContext
)

Presave function.

Classes

Typedefs

Name

Description

FDirtyDelegate

Deprecated Functions

Name Description

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform* TargetP...
)

Use version that takes FObjectPreSaveContext instead.