1. Epic GamesDeveloper
  3. ALandscape

ALandscape

Unreal Engine C++ API Reference > Runtime > Landscape

Inheritance Hierarchy

References

   
Module Landscape
Header /Engine/Source/Runtime/Landscape/Classes/Landscape.h
Include #include "Landscape.h"

Syntax

class ALandscape : public ALandscapeProxy

Variables

  Type Name Description
Public variable bool bAreNewLandscapeActorsSpatiallyLoaded Landscape actor has authority on default streaming behavior for new actors : LandscapeStreamingProxies & LandscapeSplineActors
Public variable bool bCanHaveLayersContent  
Public variable bool bEnableEditorLayersTick  
Public variable bool bGrassUpdateEnabled Used to temporarily disable Grass Update in Editor
Public variable bool bIncludeGridSizeInNameForLandscapeActors If true, LandscapeStreamingProxy actors have the grid size included in their name, for backward compatibility we also check the AWorldSettings::bIncludeGridSizeInNameForPartitionedActors
Public variable bool bUseGeneratedLandscapeSplineMeshesActors If true, WorldPartitionLandscapeSplineMeshesBuilder is responsible of generating partitioned actors of type ALandscapeSplineMeshesActor that will contain all landscape spline/controlpoints static meshes.
Public variable FGuid EditingLayer Current Editing Landscape Layer
Public variable TArray< TObjectPtr< UTextureRenderTarget2D > > HeightmapRTList  
Public variable TArray< FLandscapeLayer > LandscapeLayers  
Public variable FGuid LandscapeSplinesTargetLayerGuid Target Landscape Layer for Landscape Splines
Public variable TArray< TWeakObjectPtr< UTexture2D > > 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< TObjectPtr< UTextureRenderTarget2D > > WeightmapRTList  

Constructors

  Type Name Description
Public function  

ALandscape ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

AddBrushToLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function void  
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* InLandscapeComponent
)

  
Public function void

ClearLayer ( const FGuid& InLayerGuid,
TSet< TObjectPtr< ULandscapeComponent >>* InComponents,
ELandscapeClearMode InClearMode,
bool bMarkPackageDirty
)

  
Public function void

ClearLayer ( int32 InLayerIndex,
TSet< TObjectPtr< ULandscapeComponent >>* InComponents,
ELandscapeClearMode InClearMode
)

  
Public function void

ClearPaintLayer ( const FGuid& InLayerGuid,
ULandscapeLayerInfoObject* InLayerInfo
)

  
Public function void

ClearPaintLayer ( int32 InLayerIndex,
ULandscapeLayerInfoObject* InLayerInfo
)

  
Public function void

CollapseLayer ( int32 InLayerIndex
)

  
Public function Const FIntPoint  
Public function bool

ComputeLandscapeLayerBrushInfo ( FTransform& OutLandscapeTransform,
FIntPoint& OutLandscapeSize,
FIntPoint& OutLandscapeRenderTargetSize
)

  
Public function void  
Public function void  
Public function void  
Public function int32

CreateLayer ( FName InName
)

  
Public function void

DeleteLayer ( int32 InLayerIndex
)

  
Public function void  
Public function FLandscapeLayer *  
Public function void  
Public function void

ForceUpdateLayersContent ( bool bIntermediateRender
)

  
Public function void

ForEachLayer ( TFunctionRef< void(struct FLandscapeLayer&)> Fn
)

  
Protected function Const FName  
Public function Const TArray< class ALandscapeBlueprintBrushBase * >

GetBrushesForLayer ( int32 InLayerIndex
)

  
Public function Const ALandscapeBlueprintBrushBase *

GetBrushForLayer ( int32 InLayerIndex,
int32 BrushIndex
)

  
Public function int32

GetBrushIndexForLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function Const int32  
Public function Const float

GetClampedLayerAlpha ( float InAlpha,
bool bInHeightmap
)

  
Public function Const FBox Computes & returns bounds containing all landscape proxies (if any) or this landscape's bounds otherwise.
Public function Const const FGuid &  
Public function Const const FLandscapeLayer *  
Public function FLandscapeLayer *  
Public function Const const FLandscapeLayer *

GetLayer ( int32 InLayerIndex
)

  
Public function Const const FLandscapeLayer *

GetLayer ( const FGuid& InLayerGuid
)

  
Public function Const const FLandscapeLayer *

GetLayer ( const FName& InLayerName
)

  
Public function FLandscapeLayer *

GetLayer ( int32 InLayerIndex
)

  
Public function Const float

GetLayerAlpha ( int32 InLayerIndex,
bool bInHeightmap
)

  
Public function Const uint8  
Public function Const int32

GetLayerIndex ( FName InLayerName
)

  
Public function Const FBox Computes & returns bounds containing all currently loaded landscape proxies (if any) or this landscape's bounds otherwise
Public function uint32  
Public function Const void

GetUsedPaintLayers ( int32 InLayerIndex,
TArray< ULandscapeLayerInfoObject* >& OutUsedLayerInfos
)

  
Public function Const void

GetUsedPaintLayers ( const FGuid& InLayerGuid,
TArray< ULandscapeLayerInfoObject* >& OutUsedLayerInfos
)

  
Public function Const bool  
Public function Const bool  
Public function bool  
Public function Const bool  
Public function void  
Public function Const bool  
Public function Const bool

IsLayerBlendSubstractive ( int32 InLayerIndex,
const TWeakObjectPtr< ULandscapeLayerInfoObject >& InLayerInfoObj
)

  
Public function Const bool

IsLayerNameUnique ( const FName& InName
)

  
Public function Const bool  
Public function Const bool  
Public function bool

IsValidRenderTargetFormatHeightmap ( EPixelFormat InRenderTargetFormat,
bool& bOutCompressHeight
)

  
Public function void  
Public function FLandscapeBlueprintBrushChangedDelegate &  
Public function FLandscapeFullHeightmapRenderDoneDelegate &  
Public function void  
Public function void  
Public function bool

PrepareTextureResources ( bool bInWaitForStreaming
)

  
Public function void  
Public function void  
Public function void  
Public function void

RemoveBrushFromLayer ( int32 InLayerIndex,
int32 InBrushIndex
)

  
Public function void

RemoveBrushFromLayer ( int32 InLayerIndex,
ALandscapeBlueprintBrushBase* InBrush
)

  
Public function void

RenderHeightmap ( const FTransform& InWorldTransform,
const FBox2D& InExtents,
UTextureRenderTarget2D* OutRenderTarget
)

  
Public function bool

ReorderLayer ( int32 InStartingLayerIndex,
int32 InDestinationLayerIndex
)

  
Public function bool

ReorderLayerBrush ( int32 InLayerIndex,
int32 InStartingLayerBrushIndex,
int32 InDestinationLayerBrushIndex
)

  
Public function void

RequestLayersContentUpdate ( ELandscapeLayerUpdateMode InModeMask
)

  
Public function void

RequestLayersContentUpdateForceAll ( ELandscapeLayerUpdateMode InModeMask,
bool bInUserTriggered
)

  
Public function void

RequestLayersInitialization ( bool bInRequestContentUpdate
)

  
Public function void  
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< ULandscapeLayerInfoObject >& InLayerInfoObj
)

  
Public function void

SetLayerVisibility ( int32 InLayerIndex,
bool bInVisible
)

  
Public function void

SetLODGroupKey ( uint32 InLODGroupKey
)

  
Public function void  
Public function void  
Public function void

ShowOnlySelectedLayer ( int32 InLayerIndex
)

  
Public function Static void

SplitHeightmap ( ULandscapeComponent* Comp,
ALandscapeProxy* TargetProxy,
FMaterialUpdateContext* InOutUpdateContext,
TArray< class FComponentRecreateRenderStateContext >* InOutRecreateRenderStateContext,
bool InReregisterComponent
)

  
Public function void

TickLayers ( float DeltaTime
)

  
Public function void  
Public function void  
Public function void

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

  
Public function void  
Public function Const void  

Overridden from ALandscapeProxy

  Type Name Description
Public function Virtual Const const ALandscape *  
Public function Virtual ALandscape *  
Public function Virtual Const bool Will tell if the landscape proxy as some content related to the layer system
Public function Virtual void

UpdateCachedHasLayersContent ( bool bInCheckComponentDataIntegrity
)

  

Overridden from AActor

  Type Name Description
Public function Virtual Const bool 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 Called when an actor is done spawning into the world (from UWorld::SpawnActor), both in the editor and during gameplay For actors with a root component, the location and rotation will have already been set.
Public function Virtual void

PostEditMove ( bool bFinished
)

 Called after an actor has been moved in the editor
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual bool

ShouldImport ( FStringView ActorPropString,
bool IsMovingLevel
)

 Called before editor paste, true allow import

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void 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& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void 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 Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

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

Classes

  Type Name Description
Public class FLandscapeBlueprintBrushChangedDelegate    
Public class FLandscapeFullHeightmapRenderDoneDelegate    

Constants

Name Description
AffectsLandscapeActorDescProperty  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.