1. Epic GamesDeveloper
  3. ULandscapeInfo

ULandscapeInfo

API > API/Runtime > API/Runtime/Landscape

Inheritance Hierarchy

References

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

Syntax

class ULandscapeInfo : public UObject

Variables

  Type Name Description
Public variable int32 ComponentNumSubsections  
Public variable int32 ComponentSizeQuads  
Public variable FVector DrawScale  
Public variable TWeakObjectPtr< ALandscape > LandscapeActor  
Public variable FGuid LandscapeGuid  
Public variable TArray< FLandscapeInfoLayerSettings > Layers  
Public variable int32 RegionSizeInComponents  
Public variable TMap< FIntPoint, float > SelectedRegion  
Public variable TArray< TWeakObjectPtr< ALandscapeStreamingProxy > > StreamingProxies  
Public variable int32 SubsectionSizeQuads  
Public variable TMap< FIntPoint, FLandscapeAddCollision > XYtoAddCollisionMap Lookup map used by the "add component" tool.
Public variable TMap< FIntPoint, ULandscapeHeightfieldCollisionComponent * > XYtoCollisionComponentMap Map of the offsets (in component space) to the collision components. Should always be valid.
Public variable TMap< FIntPoint, ULandscapeComponent * > XYtoComponentMap Map of the offsets (in component space) to the component. Valid in editor only.

Constructors

  Type Name Description
Public function  

ULandscapeInfo ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool

ApplySplines ( bool bOnlySelected,
TSet< TObjectPtr< ULandscapeComponent >>* OutModifiedComponents,
bool bMarkPackageDirty
)

  
Public function Const bool  
Public function Const bool Returns true if new Landscape actors should be spatially loaded in WorldPartition (LandscapeStreamingProxy & LandscapeSplineActor)
Public function Const bool

CanDeleteLandscape ( FText& OutReason
)

  
Public function Const bool Will tell if the landscape actor can have some content related to the layer system
Public function void Will clear all component dirty data
Public function void

ClearSelectedRegion ( bool bIsComponentwise
)

  
Public function void  
Public function ALandscapeSplineActor *

CreateSplineActor ( const FVector& Location
)

  
Public function void

DeleteLayer ( ULandscapeLayerInfoObject* LayerInfo,
const FName& LayerName
)

  
Public function void

ExportHeightmap ( const FString& Filename,
const FIntRect& ExportRegion
)

  
Public function void

ExportHeightmap ( const FString& Filename
)

  
Public function void

ExportLayer ( ULandscapeLayerInfoObject* LayerInfo,
const FString& Filename,
const FIntRect& ExportRegion
)

  
Public function void

ExportLayer ( ULandscapeLayerInfoObject* LayerInfo,
const FString& Filename
)

  
Public function Static ULandscapeInfo *

Find ( UWorld* InWorld,
const FGuid& LandscapeGuid
)

  
Public function Static ULandscapeInfo *

FindOrCreate ( UWorld* InWorld,
const FGuid& LandscapeGuid
)

  
Public function void

FixupProxiesTransform ( bool bDirty
)

 Fixes up proxies relative position to landscape actor basically makes sure that each LandscapeProxy RootComponent transform reflects LandscapeSectionOffset value requires LandscapeActor to be loaded Does not work in World composition mode!
Public function Const void  
Public function Const void  
Public function void  
Public function Const void Runs the given function on the root landscape actor and all streaming proxies, with the posibility of early exit Most easily used with a lambda as follows: ForEachLandscapeProxy( -> bool { return continueLoop ? true : false; });
Public function Const FBox  
Public function Const void

GetComponentsInRegion ( int32 X1,
int32 Y1,
int32 X2,
int32 Y2,
TSet< ULandscapeComponent* >& OutComponents,
bool bOverlap
)

  
Public function Const ALandscapeProxy *

GetCurrentLevelLandscapeProxy ( bool bRegistered
)

 Returns landscape which is spawned in the current level that was previously added to this landscape info object
Public function Const bool  
Public function Const uint32

GetGridSize ( uint32 InGridSizeInComponents
)

 Returns LandscapeStreamingProxy Cell Size in WorldPartition
Public function FVector

GetLandscapeCenterPos ( float& LengthZ,
int32 MinX,
int32 MinY,
int32 MaxX,
int32 MaxY
)

  
Public function Const bool

GetLandscapeExtent ( int32& MinX,
int32& MinY,
int32& MaxX,
int32& MaxY
)

  
Public function Const bool

GetLandscapeExtent ( ALandscapeProxy* Proxy,
FIntRect& ProxyExtent
)

  
Public function Const bool

GetLandscapeExtent ( FIntRect& LandscapeExtent
)

  
Public function Const ALandscapeProxy * Returns shared landscape or landscape proxy, mostly for transformations
Public function Const ALandscapeProxy * Returns the landscape proxy of this landscape info in the given level (if it exists)
Public function Const bool

GetLandscapeXYComponentBounds ( FIntRect& OutXYComponentBounds
)

  
Public function Const FLandscapeEditorLayerSettings &  
Public function Const ULandscapeLayerInfoObject *

GetLayerInfoByName ( FName LayerName,
ALandscapeProxy* Owner
)

  
Public function Const int32

GetLayerInfoIndex ( FName LayerName,
ALandscapeProxy* Owner
)

  
Public function Const int32  
Public function Const FBox  
Public function Const int32  
Public function Const TArray< UPackage * >  
Public function bool

GetOverlappedComponents ( const FTransform& InAreaWorldTransform,
const FBox2D& InAreaExtents,
TMap< FIntPoint, ULandscapeComponent* >& OutOverlappedComponents,
FIntRect& OutComponentIndicesBoundingRect
)

 Retrieve the components currently loaded that overlap with a given "window" area
Public function Const TSet< ULandscapeComponent * >  
Public function Const bool

GetSelectedExtent ( int32& MinX,
int32& MinY,
int32& MaxX,
int32& MaxY
)

  
Public function Const TSet< ULandscapeComponent * >  
Public function Const TArray< TScriptInterface< ILandscapeSplineInterface > >  
Public function Const void

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

  
Public function Const bool

HasUnloadedComponentsInRegion ( int32 X1,
int32 Y1,
int32 X2,
int32 Y2
)

  
Public function void

Initialize ( UWorld* InWorld,
const FGuid& InLandscapeGuid
)

 Called after creating object so that it can initialize its state
Public function Const bool

IsRegistered ( const ALandscapeProxy* Proxy
)

 Returns true if the Proxy is currently registered with this ULandscapeInfo
Public function bool

IsValidPosition ( int32 X,
int32 Y
)

  
Public function void  
Public function bool

MarkObjectDirty ( UObject* InObject,
bool bInForceResave
)

 See UObjectBaseUtility::MarkPackageDirty
Public function bool

ModifyObject ( UObject* InObject,
bool bAlwaysMarkDirty
)

 Landscapes are a bit special in that they contain derived data within their source data, which can be updated on-the-fly depending on many external factors (e.g. a procedural edit layer can invalidate some data on load).
Public function ALandscapeProxy *

MoveComponentsToLevel ( const TArray< ULandscapeComponent* >& InComponents,
ULevel* TargetLevel,
FName NewProxyName
)

 Moves Components to target level.
Public function ALandscapeProxy *

MoveComponentsToProxy ( const TArray< ULandscapeComponent* >& InComponents,
ALandscapeProxy* LandscapeProxy,
bool bSetPositionAndOffset,
ULevel* TargetLevel
)

 Moves Components to target proxy.
Public function void Moves Splines connected to this control point to target Proxy.
Public function void Moves all Splines to target Spline owner.
Public function void

MoveSplinesToLevel ( ULandscapeSplinesComponent* InSplineComponent,
ULevel* TargetLevel
)

 Moves all Splines to target level.
Public function void

MoveSplinesToProxy ( ULandscapeSplinesComponent* InSplineComponent,
ALandscapeProxy* InLandscapeProxy
)

 Moves all Splines to target Proxy. Creates ULandscapeSplineComponent if needed
Public function void

MoveSplineToLevel ( ULandscapeSplineControlPoint* InControlPoint,
ULevel* TargetLevel
)

 Moves Splines connected to this control point to target level.
Public function void

MoveSplineToProxy ( ULandscapeSplineControlPoint* InControlPoint,
ALandscapeProxy* InLandscapeProxy
)

 Moves Splines connected to this control point to target Proxy.
Public function void  
Public function void  
Public function Static void

RecreateLandscapeInfo ( UWorld* InWorld,
bool bMapCheck
)

 Recreate all LandscapeInfo objects in given world
Public function void

RegisterActor ( ALandscapeProxy* Proxy,
bool bMapCheck,
bool bUpdateAllAddCollisions
)

 Associates passed actor with this info object
Public function void

RegisterActorComponent ( ULandscapeComponent* Component,
bool bMapCheck
)

 Associates passed landscape component with this info object
Public function void Server doesn't have ULandscapeComponent use CollisionComponents instead to get height on landscape
Public function void  
Public function void  
Public function void  
Public function void  
Public function void

Reset ()

 Resets all actors, proxies, components registrations
Public function Static void

SetForceNonSpatiallyLoadedByDefault ( bool bInForceNonSpatiallyLoadedByDefault
)

  
Public function Const bool  
Public function void Deassociates passed actor with this info object
Public function void Deassociates passed landscape component with this info object
Public function void  
Public function void  
Public function void

UpdateAddCollision ( FIntPoint LandscapeKey
)

  
Public function void Only for use by the "add component" tool. Todo - move into the tool?
Public function void

UpdateAllComponentMaterialInstances ( bool bInInvalidateCombinationMaterials
)

 Will call UpdateAllComponentMaterialInstances on all LandscapeProxies
Public function void Update per-component layer allow list to include the currently painted layers.
Public function void  
Public function bool

UpdateLayerInfoMap ( ALandscapeProxy* Proxy,
bool bInvalidate
)

  
Public function void

UpdateNanite ( const ITargetPlatform* InTargetPlatform
)

  
Public function Static void Updates the spline registrations (with ALL landscape infos) when a spline has changed the landscape it is targeting
Public function void

UpdateSelectedComponents ( TSet< ULandscapeComponent* >& NewComponents,
bool bIsComponentwise
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
bForceNonSpatiallyLoadedByDefault  

Deprecated Variables

  Type Name Description
Public variable TArray< TObjectPtr< ALandscapeStreamingProxy > > Proxies This property has been deprecated, please use the StreamingProxies property instead

Deprecated Functions

  Type Name Description
Public function Const void This function has been deprecated, please use the ForEachLandscapeProxy property instead
Public function Static bool Use ULandscapeSubsystem::GetDirtyOnlyInMode() instead
Public function void Texture Baking is officially deprecated now and nothing updates it anymore

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page