1. Epic GamesDeveloper
  3. ULandscapeComponent

ULandscapeComponent

API > API/Runtime > API/Runtime/Landscape

   
Name ULandscapeComponent
Type class
Header File /Engine/Source/Runtime/Landscape/Classes/LandscapeComponent.h
Include Path #include "LandscapeComponent.h"

Syntax

UCLASS (  
       HideCategories=(Display, Attachment, Physics, Debug, Collision, Movement, Rendering, PrimitiveComponent, Object, Transform, Mobility, VirtualTexture),  
       ShowCategories=("Rendering|Material"), MinimalAPI, Within=LandscapeProxy)  
class ULandscapeComponent : public UPrimitiveComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

ULandscapeComponent ( const FObjectInitializer& ObjectInitializer
)

   LandscapeComponent.h  

Structs

Name Remarks
FExcludeBox This wrapper is needed to filter out exclude boxes that are completely inside of another exclude box.
FGrassTypeSummary Non-serialized runtime cache of values derived from the assigned grass types.

Constants

Name Type Remarks Include Path
UndoRedoModifiedComponentCount uint32 Records the ULandscapeComponents that are modified in any undo/redo operation that is being applied currently LandscapeComponent.h
UndoRedoModifiedComponents TMap< ULandscapeComponent *, uint32 >   LandscapeComponent.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ActiveExcludedBoxes TArray< FExcludeBox >   LandscapeComponent.h  
CachedLocalBox FBox Cached local-space bounding box, created at heightmap update time LandscapeComponent.h  
ChangeTag uint32   LandscapeComponent.h  
CollisionMipLevel int32 Heightfield mipmap used to generate collision LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
ComponentSizeQuads int32 Total number of quads for this component, has to be >0 LandscapeComponent.h  
EditToolRenderData FLandscapeEditToolRenderData Pointer to data shared with the render thread, used by the editor tools LandscapeComponent.h
  • Transient
  • DuplicateTransient
  • NonTransactional
ForcedLOD int32 Forced LOD level to use when rendering LandscapeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=LandscapeComponent
GrassData TSharedRef< FLandscapeComponentGrassData, ESPMode::ThreadSafe > Grass data for generation LandscapeComponent.h  
GrassTypeSummary FGrassTypeSummary   LandscapeComponent.h  
HeightmapScaleBias FVector4 UV offset to Heightmap data from component local coordinates LandscapeComponent.h  
LastSavedPhysicalMaterialHash uint32 Represents last saved hash for PhysicalMaterialTask LandscapeComponent.h
  • Transient
LayerAllowList TArray< TObjectPtr< ULandscapeLayerInfoObject > > List of layers allowed to be painted on this component. LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
LightingLODBias int32 LOD level Bias to use when lighting building via lightmass, -1 Means automatic LOD calculation based on ForcedLOD + LODBias LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
LODBias int32 LOD level Bias to use when rendering LandscapeComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=LandscapeComponent
LODIndexToMaterialIndex TArray< int8 > Mapping between LOD and Material Index LandscapeComponent.h
  • TextExportTransient
MapBuildDataId FGuid Uniquely identifies this component's built map data. LandscapeComponent.h  
MaterialInstances TArray< TObjectPtr< UMaterialInstanceConstant > >   LandscapeComponent.h
  • TextExportTransient
MaterialInstancesDynamic TArray< TObjectPtr< UMaterialInstanceDynamic > >   LandscapeComponent.h
  • Transient
  • TextExportTransient
MaterialPerLOD TMap< TObjectPtr< UMaterialInterface >, int8 > Represent the chosen material for each LOD LandscapeComponent.h
  • NonPIEDuplicateTransient
MipToMipMaxDeltas TArray< double > Maximum deltas between vertices and their counterparts from other mips. LandscapeComponent.h  
MobileCombinationMaterialInstances TArray< TObjectPtr< UMaterialInstanceConstant > > The editor needs to save out the combination MIC we'll use for mobile, because we cannot generate it at runtime for standalone PIE games LandscapeComponent.h
  • NonPIEDuplicateTransient
MobileDataSourceHash FGuid Hash of source for mobile generated data. LandscapeComponent.h
  • NonPIEDuplicateTransient
MobileMaterialInterfaces TArray< TObjectPtr< UMaterialInterface > > Material interfaces used for mobile LandscapeComponent.h
  • NonPIEDuplicateTransient
MobileWeightmapLayerAllocations TArray< FWeightmapLayerAllocationInfo > Layer allocations used by mobile. LandscapeComponent.h  
MobileWeightmapTextureArray TObjectPtr< UTexture2DArray >   LandscapeComponent.h
  • NonPIEDuplicateTransient
MobileWeightmapTextures TArray< TObjectPtr< UTexture2D > > Generated weightmap textures used for mobile. LandscapeComponent.h
  • NonPIEDuplicateTransient
NegativeZBoundsExtension float Allows overriding the landscape bounds. LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
NumSubsections int32 Number of subsections in X or Y axis LandscapeComponent.h  
OverrideHoleMaterial TObjectPtr< UMaterialInterface >   LandscapeComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LandscapeComponent
  • AdvancedDisplay
OverrideMaterial TObjectPtr< UMaterialInterface >   LandscapeComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=LandscapeComponent
PhysicalMaterialHash uint32 Represents hash for last PhysicalMaterialTask LandscapeComponent.h  
PhysicalMaterialTask FLandscapePhysicalMaterialRenderTask Physical material update task LandscapeComponent.h  
PositiveZBoundsExtension float Allows overriding the landscape bounds. LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
RegisteredEdgeFixup TObjectPtr< ULandscapeHeightmapTextureEdgeFixup > When the component has registered a heightmap texture edge fixup, a reference to the edge fixup and the group are stored here for easy access (the fixup is also referenced via the heightmap AssetUserDatas, and the group can be accessed via the ULandcapeSubsystem) LandscapeComponent.h
  • Transient
  • DuplicateTransient
  • NonTransactional
RegisteredLandscapeGroup FLandscapeGroup *   LandscapeComponent.h
  • Transient
  • DuplicateTransient
  • NonTransactional
SectionBaseX int32 X offset from global components grid origin (in quads) LandscapeComponent.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category=LandscapeComponent
SectionBaseY int32 Y offset from global components grid origin (in quads) LandscapeComponent.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Category=LandscapeComponent
SimpleCollisionMipLevel int32 Heightfield mipmap used to generate simple collision LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
SplineHash uint32   LandscapeComponent.h  
StaticLightingResolution float StaticLightingResolution overriding per component, default value 0 means no overriding LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
  • Meta=(ClampMax=4096)
SubsectionSizeQuads int32 Number of quads for a subsection of the component. SubsectionSizeQuads+1 must be a power of two. LandscapeComponent.h  
WeightmapScaleBias FVector4 UV offset to component's weightmap data from component local coordinates LandscapeComponent.h  
WeightmapsHash uint32 Represents hash of last weightmap usage update LandscapeComponent.h  
WeightmapSubsectionOffset float U or V offset into the weightmap for the first subsection, in texture UV space LandscapeComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bNaniteActive bool   LandscapeComponent.h
  • Transient
bPendingCollisionDataUpdate bool   LandscapeComponent.h
  • Transient
bPendingLayerCollisionDataUpdate bool   LandscapeComponent.h
  • Transient
bPendingPhysicalMaterialInvalidation bool Physical material has been invalidated and no new physical material task has been started since then. LandscapeComponent.h  
bUndoChangedWeightmapAllocs bool   LandscapeComponent.h  
bUserTriggeredChangeRequested bool Store LandscapeComponent.h
  • Transient
CollisionComponentRef TObjectPtr< ULandscapeHeightfieldCollisionComponent > Reference to associated collision component LandscapeComponent.h  
GrassTypes TArray< TObjectPtr< ULandscapeGrassType > > Cached list of grass types supported by the component's material. LandscapeComponent.h  
HeightmapTexture TObjectPtr< UTexture2D > Heightmap texture reference LandscapeComponent.h  
LastLandscapeMaterialAllStateCRCWhenGrassTypesBuilt uint32 The value of the landscape material AllStateCRC the last time the GrassTypes array was updated from it LandscapeComponent.h  
LayerDirtyCollisionHeightData FIntRect Dirtied collision height region when painting (only used by Landscape Layer System) LandscapeComponent.h  
LayersData TMap< FGuid, FLandscapeLayerComponentData > Edit Layers that have data for this component store it here LandscapeComponent.h  
LayerUpdateFlagPerMode uint32   LandscapeComponent.h
  • Transient
LightingGuid FGuid Unique ID for this component, used for caching during distributed lighting LandscapeComponent.h  
ObsoleteEditLayerData TMap< FGuid, FLandscapeLayerComponentData > Obsolete edit layers (Edit layers not tracked by ALandscape). LandscapeComponent.h
  • Transient
PerLODOverrideMaterials TArray< FLandscapePerLODMaterialOverride >   LandscapeComponent.h
  • EditAnywhere
  • Category=LandscapeComponent
WeightmapLayerAllocations TArray< FWeightmapLayerAllocationInfo > List of layers, and the weightmap and channel they are stored LandscapeComponent.h  
WeightmapTextures TArray< TObjectPtr< UTexture2D > > Weightmap texture reference LandscapeComponent.h  
WeightmapTexturesUsage TArray< TObjectPtr< ULandscapeWeightmapUsage > > Final layer data. LandscapeComponent.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddDefaultLayerData ( const FGuid& InLayerGuid,
const TArray< ULandscapeComponent* >& InComponentsUsingHeightmap,
TMap< UTexture2D*, UTexture2D* >& InOutCreatedHeightmapTextures
)

   LandscapeComponent.h  

void AddLayerData ( const FGuid& InLayerGuid,
const FLandscapeLayerComponentData& InData
)

   LandscapeComponent.h  

virtual void AddMapBuildDataGUIDs ( TSet< FGuid >& InGUIDs
) const

   LandscapeComponent.h  

virtual void BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetPlatform
)

   LandscapeComponent.h  

virtual void BeginDestroy()

   LandscapeComponent.h  

virtual FBoxSphereBounds CalcBounds ( const FTransform& LocalToWorld
) const

   LandscapeComponent.h  

uint32 CalculatePhysicalMaterialTaskHash()

   LandscapeComponent.h  

bool CanRenderGrassMap()

 Could a grassmap currently be generated, disregarding whether our textures are streamed in? LandscapeComponent.h  

bool CanUpdatePhysicalMaterial()

 Returns true if we can currently update physical materials. LandscapeComponent.h  

void CheckGenerateMobilePlatformData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

 Generate mobile data if it's missing or outdated LandscapeComponent.h  

void ClearDirtyCollisionHeightData()

 Clears component's dirtied collision region (used by Layer System) LandscapeComponent.h  

void ClearUpdateFlagsForModes ( uint32 InModeMask
)

   LandscapeComponent.h  

bool ComponentHasVisibilityPainted()

 Returns true if this component has visibility painted LandscapeComponent.h  

FBox ComputeApproximateBounds()

   LandscapeComponent.h  

uint32 ComputeGrassMapGenerationHash()

 Computes a hash representing the state of the material and grasstypes used by this component. LandscapeComponent.h  

uint32 ComputeLayerHash ( bool InReturnEditingHash
) const

   LandscapeComponent.h  

uint32 ComputeWeightmapsHash()

   LandscapeComponent.h  

void CopyComponentDataToEditLayer ( const FGuid& InSourceEditLayerGuid,
const FGuid& InDestEditLayerGuid,
bool bInUseObsoleteLayerData,
TSet< UTexture2D* >& OutProcessedHeightmaps,
TSet< UTexture2D* >& OutProcessedWeightmaps
)

   LandscapeComponent.h  

virtual FPrimitiveSceneProxy * CreateSceneProxy()

   LandscapeComponent.h  

void DeleteLayer ( ULandscapeLayerInfoObject* LayerInfo,
FLandscapeEditDataInterface& LandscapeEdit
)

 Deletes a material layer from the current edit layer on this component, removing all its data, adjusting other layer's weightmaps if necessary, etc. LandscapeComponent.h  

void DeleteLayerAllocation ( const FGuid& InEditLayerGuid,
int32 InLayerAllocationIdx,
bool bInShouldDirtyPackage
)

 Deletes a layer from this component, but doesn't do anything else (assumes the user knows what he's doing, use DeleteLayer otherwise) LandscapeComponent.h  

bool DeleteLayerIfAllZero ( const FGuid& InEditLayerGuid,
const uint8*const TexDataPtr,
int32 TexSize,
int32 LayerIdx,
bool bShouldDirtyPackage
)

 Deletes a layer from this component if it does not contain data, calling DeleteLayerAllocation. LandscapeComponent.h  

void DeleteLayerInternal ( ULandscapeLayerInfoObject* LayerInfo,
FLandscapeEditDataInterface& LandscapeEdit,
const FGuid& InEditLayerGuid
)

 Deletes a material layer from the specified edit layer on this component, removing all its data, adjusting other layer's weightmaps if necessary, etc. LandscapeComponent.h  

void DestroyCollisionData()

 Deletes Collision Component LandscapeComponent.h  

virtual void DestroyComponent ( bool bPromoteChildren
)

   LandscapeComponent.h  

float EditorGetPaintLayerWeightAtLocation ( const FVector& InLocation,
ULandscapeLayerInfoObject* PaintLayer
)

 Gets the landscape paint layer weight value at the given position using LandscapeLayerInfo . LandscapeComponent.h
  • BlueprintCallable
  • Category="Landscape|Editor"

float EditorGetPaintLayerWeightByNameAtLocation ( const FVector& InLocation,
const FName InPaintLayerName
)

 Gets the landscape paint layer weight value at the given position using layer name. LandscapeComponent.h
  • BlueprintCallable
  • Category="Landscape|Editor"
Fills a layer to 100% on this component, adding it if needed and removing other layers that get painted away. LandscapeComponent.h  

void FinalizePhysicalMaterial ( bool bInImmediatePhysicsRebuild
)

 Write the physical materials into the LandscapeComponent from the Render & Immediately Rebuild physics if requested LandscapeComponent.h  

void FixupWeightmaps ( const FGuid& InEditLayerGuid
)

   LandscapeComponent.h  

void FixupWeightmaps ()

 Fix up component layers, weightmaps LandscapeComponent.h  

void ForEachLayer ( TFunctionRef< void(const FGuid&, struct FLandscapeLayerComponentData&)> Fn
)

   LandscapeComponent.h  

void GenerateHeightmapMips ( TArray< FColor* >& HeightmapTextureMipData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2,
FLandscapeTextureDataInfo* TextureDataInfo
)

 Generate mipmaps for height and tangent data. LandscapeComponent.h  

void GenerateMobilePlatformPixelData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

   LandscapeComponent.h  

void GenerateMobileWeightmapLayerAllocations()

 Generates mobile platform data for this component. LandscapeComponent.h  

ULandscapeHeightfieldCollisionComponent * GetCollisionComponent()

   LandscapeComponent.h  

UMaterialInstanceConstant * GetCombinationMaterial ( FMaterialUpdateContext* InMaterialUpdateContext,
const TArray< FWeightmapLayerAllocationInfo >& Allocations,
int8 InLODIndex,
bool bMobile
) const

 Helper function for UpdateMaterialInstance to get Material without set parameters LandscapeComponent.h  

void GetComponentExtent ( int32& MinX,
int32& MinY,
int32& MaxX,
int32& MaxY
) const

 Extends passed region with this component's 2D bounds (values are in landscape quads) LandscapeComponent.h  

FIntRect GetComponentExtent ()

 Returns the 2D bounds of this component (in landscape quads) LandscapeComponent.h  

FIntPoint GetComponentKey()

   LandscapeComponent.h  

int32 GetCurrentRuntimeMaterialInstanceCount()

   LandscapeComponent.h  

UMaterialInterface * GetCurrentRuntimeMaterialInterface ( int32 InIndex
) const

   LandscapeComponent.h  
  LandscapeComponent.h  
  LandscapeComponent.h  

virtual TSubclassOf< class UHLODBuilder > GetCustomHLODBuilderClass()

   LandscapeComponent.h  
Get the Landscape Actor's editing layer data LandscapeComponent.h  
  LandscapeComponent.h  

FGuid GetEditingLayerGUID()

 Get the Landscape Actor's editing layer GUID LandscapeComponent.h  

TArray< UMaterialInstance * > GetGeneratedMaterialInstances()

   LandscapeComponent.h  

TArray< UTexture * > GetGeneratedTextures()

   LandscapeComponent.h  

void GetGeneratedTexturesAndMaterialInstances ( TArray< UObject* >& OutTexturesAndMaterials
) const

 Returns all generated textures and material instances used by this component. LandscapeComponent.h  
Returns the array of grass types used by the landscape material. LandscapeComponent.h  

const TArray< ULandscapeGrassType * > & GetGrassTypesBP()

   LandscapeComponent.h
  • BlueprintCallable
  • Category="Landscape|Grass"
  • Meta=(DisplayName="GetGrassTypes", ToolTip="Returns the grass types used by the landscape material on this component")

double GetGrassTypesMaxDiscardDistance()

   LandscapeComponent.h  

UTexture2D * GetHeightmap ( const FGuid& InLayerGuid
) const

 Returns the heightmap for this component and the edit layer specified by InLayerGuid. If InLayerGuid is invalid, returns the final (base) heightmap : LandscapeComponent.h  

UTexture2D * GetHeightmap ( bool InReturnEditingHeightmap
) const

 Returns the heightmap for this component. If InReturnEditingHeightmap is passed, returns the currently active edit layer's heightmap : LandscapeComponent.h  

ALandscape * GetLandscapeActor()

 Get the landscape actor associated with this component. LandscapeComponent.h  

void GetLandscapeComponentNeighbors3x3 ( TStaticArray< ULandscapeComponent*, 9 >& OutNeighborComponents
) const

   LandscapeComponent.h  

void GetLandscapeComponentNeighborsToRender ( TSet< ULandscapeComponent* >& NeighborComponents
) const

   LandscapeComponent.h  

void GetLandscapeComponentWeightmapsToRender ( TSet< ULandscapeComponent* >& WeightmapComponents
) const

   LandscapeComponent.h  

UMaterialInterface * GetLandscapeHoleMaterial()

 Returns the components's LandscapeHoleMaterial, or the Component's OverrideLandscapeHoleMaterial if set LandscapeComponent.h  

ULandscapeInfo * GetLandscapeInfo()

 Gets the landscape info object for this landscape LandscapeComponent.h  

UMaterialInterface * GetLandscapeMaterial ( int8 InLODIndex
) const

 Returns the component's LandscapeMaterial, or the Component's OverrideLandscapeMaterial if set LandscapeComponent.h  

ALandscapeProxy * GetLandscapeProxy()

 Gets the landscape proxy actor which owns this component LandscapeComponent.h  
  LandscapeComponent.h  

const FLandscapeLayerComponentData * GetLayerData ( const FGuid& InLayerGuid
) const

   LandscapeComponent.h  

void GetLayerDebugColorKey ( int32& R,
int32& G,
int32& B
) const

   LandscapeComponent.h  

uint32 GetLayerUpdateFlagPerMode()

   LandscapeComponent.h  

float GetLayerWeightAtLocation ( const FVector& InLocation,
ULandscapeLayerInfoObject* LayerInfo,
TArray< uint8 >* LayerCache,
bool bUseEditingWeightmap
)

   LandscapeComponent.h  

ULevel * GetLevel()

 Get the level in which the owning actor resides LandscapeComponent.h  

virtual void GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage,
int32& ShadowMapMemoryUsage
) const

   LandscapeComponent.h  

const FGuid & GetLightingGuid()

   LandscapeComponent.h  

virtual bool GetLightMapResolution ( int32& Width,
int32& Height
) const

   LandscapeComponent.h  

FGuid GetMapBuildDataId()

   LandscapeComponent.h  

virtual UMaterialInterface * GetMaterial ( int32 ElementIndex
) const

   LandscapeComponent.h  

UMaterialInstance * GetMaterialInstance ( int32 InIndex,
bool InDynamic
) const

   LandscapeComponent.h  

int32 GetMaterialInstanceCount ( bool InDynamic
) const

   LandscapeComponent.h  

UMaterialInstanceDynamic * GetMaterialInstanceDynamic ( int32 InIndex
) const

 Gets the landscape material instance dynamic for this component LandscapeComponent.h
  • BlueprintCallable
  • Category="Landscape|Runtime|Material"

virtual bool GetMaterialPropertyPath ( int32 ElementIndex,
UObject*& OutOwner,
FString& OutPropertyPath,
FProperty*& OutProperty
)

   LandscapeComponent.h  

const FMeshMapBuildData * GetMeshMapBuildData()

   LandscapeComponent.h  

virtual int32 GetNumMaterials()

   LandscapeComponent.h  
Computes the number of mips that are actually usable, i.e.: LandscapeComponent.h  

const FLandscapeLayerComponentData * GetObsoleteEditLayerData ( const FGuid& InLayerGuid
) const

   LandscapeComponent.h  

const TMap< FGuid, FLandscapeLayerComponentData > & GetObsoleteEditLayersData()

 Obsolete edit layer helpers. LandscapeComponent.h  

bool GetPendingCollisionDataUpdate()

   LandscapeComponent.h  

bool GetPendingLayerCollisionDataUpdate()

   LandscapeComponent.h  

const TArray< FLandscapePerLODMaterialOverride > & GetPerLODOverrideMaterials()

   LandscapeComponent.h  

const TArray< UTexture2D * > & GetRenderedWeightmapTexturesForFeatureLevel ( ERHIFeatureLevel::Type FeatureLevel
) const

   LandscapeComponent.h  

bool GetRenderPhysicalMaterials ( TArray< UPhysicalMaterial* >& OutPhysicalMaterials
) const

 Get the physical materials that are configured by the landscape component graphical material. LandscapeComponent.h  

virtual void GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

   LandscapeComponent.h  

virtual TArray< URuntimeVirtualTexture * > const & GetRuntimeVirtualTextures()

   LandscapeComponent.h  

FIntPoint GetSectionBase()

   LandscapeComponent.h  

virtual void GetStaticLightingInfo ( FStaticLightingPrimitiveInfo& OutPrimitiveInfo,
const TArray< ULightComponent* >& InRelevantLights,
const FLightingBuildOptions& Options
)

   LandscapeComponent.h  

virtual ELightMapInteractionType GetStaticLightingType()

   LandscapeComponent.h  

virtual int32 GetStaticLightMapResolution()

   LandscapeComponent.h  

virtual void GetStreamingRenderAssetInfo ( FStreamingTextureLevelContext& LevelContext,
TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets
) const

   LandscapeComponent.h  

bool GetUndoChangedWeightmapAllocs()

   LandscapeComponent.h  

virtual void GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
) const

   LandscapeComponent.h  

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

   LandscapeComponent.h  

bool GetUserTriggeredChangeRequested()

   LandscapeComponent.h  

virtual ERuntimeVirtualTextureMainPassType GetVirtualTextureRenderPassType()

   LandscapeComponent.h  

ULandscapeLayerInfoObject * GetVisibilityLayer()

   LandscapeComponent.h  

TArray< FWeightmapLayerAllocationInfo > & GetWeightmapLayerAllocations ( bool InReturnEditingWeightmap
)

   LandscapeComponent.h  

const TArray< FWeightmapLayerAllocationInfo > & GetWeightmapLayerAllocations ( bool InReturnEditingWeightmap
) const

   LandscapeComponent.h  
  LandscapeComponent.h  
  LandscapeComponent.h  

const TArray< UTexture2D * > & GetWeightmapTextures ( bool InReturnEditingWeightmap
) const

   LandscapeComponent.h  

TArray< TObjectPtr< UTexture2D > > & GetWeightmapTextures ( const FGuid& InLayerGuid
)

   LandscapeComponent.h  

const TArray< UTexture2D * > & GetWeightmapTextures ( const FGuid& InLayerGuid
) const

   LandscapeComponent.h  

TArray< TObjectPtr< UTexture2D > > & GetWeightmapTextures ( bool InReturnEditingWeightmap
)

   LandscapeComponent.h  

TArray< TObjectPtr< ULandscapeWeightmapUsage > > & GetWeightmapTexturesUsage ( bool InReturnEditingWeightmap
)

   LandscapeComponent.h  

const TArray< ULandscapeWeightmapUsage * > & GetWeightmapTexturesUsage ( bool InReturnEditingWeightmap
) const

   LandscapeComponent.h  
  LandscapeComponent.h  

const TArray< ULandscapeWeightmapUsage * > & GetWeightmapTexturesUsage ( const FGuid& InLayerGuid
) const

   LandscapeComponent.h  

bool HasLayersData()

   LandscapeComponent.h  

void Init ( int32 InBaseX,
int32 InBaseY,
int32 InComponentSizeQuads,
int32 InNumSubsections,
int32 InSubsectionSizeQuads
)

 Initialize the landscape component LandscapeComponent.h  

void InitHeightmapData ( TArray< FColor >& Heights,
bool bUpdateCollision
)

   LandscapeComponent.h  

void InitializeLayersWeightmapUsage ( const FGuid& InLayerGuid
)

   LandscapeComponent.h  

void InitializeObsoleteEditLayerData ( const TSet< FGuid >& InParentEditLayerGuids
)

   LandscapeComponent.h  

void InitWeightmapData ( TArray< ULandscapeLayerInfoObject* >& LayerInfos,
TArray< TArray< uint8 > >& Weights
)

   LandscapeComponent.h  

ULandscapeHeightmapTextureEdgeFixup * InstallOrUpdateTextureUserDatas ( bool bUseEdgeFixup,
bool bUseCompression,
bool bUpdateSnapshotNow,
int32 HeightmapCompressionMipThreshold
)

 Installs new or updates existing TextureUserDatas for this component: up to one ULandscapeHeightmapTextureEdgeFixup and up to one UTextureMipDataProviderFactory (either ULandscapeTextureStorageProviderFactory or ULandscapeTextureMipEdgeOverrideFactory). LandscapeComponent.h  
Invalidate the grass type summary. LandscapeComponent.h  

virtual void InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighting,
bool bTranslationOnly
)

   LandscapeComponent.h  

void InvalidatePhysicalMaterial()

 Invalidate current or pending physical material data LandscapeComponent.h  

bool IsGrassMapOutdated()

 Returns true if the component HAS grass data, but it is not up to date LandscapeComponent.h  

bool IsGrassTypeSummaryValid()

   LandscapeComponent.h  

virtual bool IsHLODRelevant()

   LandscapeComponent.h  

bool IsLandscapeHoleMaterialValid()

 Returns true if the component has a valid LandscapeHoleMaterial LandscapeComponent.h  

bool IsNaniteActive()

   LandscapeComponent.h  

virtual bool IsPrecomputedLightingValid()

   LandscapeComponent.h  

virtual bool IsShown ( const FEngineShowFlags& ShowFlags
) const

   LandscapeComponent.h  

bool MaterialHasGrass()

   LandscapeComponent.h  

virtual void OnRegister()

   LandscapeComponent.h  

virtual void OnUnregister()

   LandscapeComponent.h  

virtual void OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType TeleportType
)

   LandscapeComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   LandscapeComponent.h  

virtual void PostEditUndo()

   LandscapeComponent.h  

virtual void PostInitProperties()

   LandscapeComponent.h  

virtual void PostLoad()

   LandscapeComponent.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   LandscapeComponent.h  

virtual void PreEditUndo()

   LandscapeComponent.h  

virtual void PreFeatureLevelChange ( ERHIFeatureLevel::Type PendingFeatureLevel
)

   LandscapeComponent.h  

virtual void PropagateLightingScenarioChange()

   LandscapeComponent.h  

TArray< UTexture * > ReallocateWeightmaps ( FLandscapeEditDataInterface* DataInterface,
const FGuid& InEditLayerGuid,
bool bInSaveToTransactionBuffer,
bool bInForceReallocate,
ALandscapeProxy* InTargetProxy,
TSet< ULandscapeComponent* >* InRestrictSharingToComponents
)

 Create weightmaps for this component for the layers specified in the WeightmapLayerAllocations array, works in the specified edit layer LandscapeComponent.h  

void RemoveGrassMap()

 Destroys grass map data stored on the component LandscapeComponent.h  
  LandscapeComponent.h  

void RemoveInvalidWeightmaps ( const FGuid& InEditLayerGuid
)

   LandscapeComponent.h  

void RemoveLayerData ( const FGuid& InLayerGuid
)

   LandscapeComponent.h  

void RemoveObsoleteEditLayerData ( const FGuid& InLayerGuid
)

   LandscapeComponent.h  

TArray< uint16 > RenderWPOHeightmap ( int32 LOD
)

 Renders the heightmap of this component (including material world-position-offset) at the specified LOD LandscapeComponent.h  

TArray< UTexture * > RepairInvalidTextures ()

 Repair invalid texture data that might have been introduced by a faulty version. LandscapeComponent.h  

void ReplaceLayer ( ULandscapeLayerInfoObject* FromLayerInfo,
ULandscapeLayerInfoObject* ToLayerInfo,
FLandscapeEditDataInterface& LandscapeEdit
)

 Replaces one layerinfo on this component with another LandscapeComponent.h  

void ReplaceLayerInternal ( ULandscapeLayerInfoObject* FromLayerInfo,
ULandscapeLayerInfoObject* ToLayerInfo,
FLandscapeEditDataInterface& LandscapeEdit,
const FGuid& InEditLayerGUID
)

   LandscapeComponent.h  

void RequestDeferredClientUpdate()

   LandscapeComponent.h  

void RequestEditingClientUpdate ( bool bInUserTriggered
)

   LandscapeComponent.h  

void RequestHeightmapUpdate ( bool bUpdateAll,
bool bUpdateCollision,
bool bInUserTriggered
)

   LandscapeComponent.h  

void RequestWeightmapUpdate ( bool bUpdateAll,
bool bUpdateCollision,
bool bInUserTriggered
)

   LandscapeComponent.h  

virtual void Serialize ( FArchive& Ar
)

   LandscapeComponent.h  

void SerializeStateHashes ( FArchive& Ar
)

 Serialize all hashes/guids that record the current state of this component LandscapeComponent.h  

void SetCollisionComponent ( ULandscapeHeightfieldCollisionComponent* InCollisionComponent
)

   LandscapeComponent.h  

void SetForcedLOD ( int32 InForcedLOD
)

   LandscapeComponent.h
  • BlueprintCallable
  • Category="LandscapeComponent"

void SetGrassTypes ( const TArray< TObjectPtr< ULandscapeGrassType > >& InGrassTypes
)

 Temporarily sets the grass type for this component. LandscapeComponent.h  

void SetGrassTypesMaxDiscardDistance ( const float InGrassTypesMaxDiscardDistance
)

   LandscapeComponent.h  

void SetHeightmap ( UTexture2D* NewHeightmap
)

   LandscapeComponent.h  

void SetLightingGuid()

   LandscapeComponent.h  

void SetLOD ( bool bForced,
int32 InLODValue
)

   LandscapeComponent.h  

void SetLODBias ( int32 InLODBias
)

   LandscapeComponent.h
  • BlueprintCallable
  • Category="LandscapeComponent"

virtual void SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

   LandscapeComponent.h  

void SetNaniteActive ( bool bValue
)

   LandscapeComponent.h  

void SetPendingCollisionDataUpdate ( bool bInPendingCollisionDataUpdate
)

   LandscapeComponent.h  

void SetPendingLayerCollisionDataUpdate ( bool bInPendingLayerCollisionDataUpdate
)

   LandscapeComponent.h  

void SetPerLODOverrideMaterials ( const TArray< FLandscapePerLODMaterialOverride >& InValue
)

   LandscapeComponent.h  

void SetSectionBase ( FIntPoint InSectionBase
)

   LandscapeComponent.h  

void SetUndoChangedWeightmapAllocs ( bool bInVal
)

   LandscapeComponent.h  

void SetUserTriggeredChangeRequested ( bool bInUserTriggeredChangeRequested
)

   LandscapeComponent.h  

void SetWeightmapLayerAllocations ( const TArray< FWeightmapLayerAllocationInfo >& InNewWeightmapLayerAllocations
)

   LandscapeComponent.h  

void SetWeightmapTextures ( const TArray< UTexture2D* >& InNewWeightmapTextures,
bool InApplyToEditingWeightmap
)

   LandscapeComponent.h  

void SetWeightmapTexturesInternal ( const TArray< UTexture2D* >& InNewWeightmapTextures,
const FGuid& InEditLayerGuid
)

   LandscapeComponent.h  

void SetWeightmapTexturesUsage ( const TArray< ULandscapeWeightmapUsage* >& InNewWeightmapTexturesUsage,
bool InApplyToEditingWeightmap
)

   LandscapeComponent.h  

void SetWeightmapTexturesUsageInternal ( const TArray< ULandscapeWeightmapUsage* >& InNewWeightmapTexturesUsage,
const FGuid& InEditLayerGuid
)

   LandscapeComponent.h  

bool UpdateCachedBounds ( bool bInApproximateBounds
)

 Recalculate cached bounds using height values. Returns true when the bounds were changed. LandscapeComponent.h  

void UpdateCollisionData ( bool bInUpdateHeightfieldRegion
)

 Updates collision component height data for the entire component, locking and unlocking heightmap textures LandscapeComponent.h  

void UpdateCollisionHeightData ( const FColor* HeightmapTextureMipData,
const FColor* SimpleCollisionHeightmapTextureData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2,
bool bUpdateBounds,
bool bInUpdateHeightfieldRegion
)

 Create or updates collision component height data LandscapeComponent.h  

void UpdateCollisionLayerData ( const FColor*const* WeightmapTextureMipData,
const FColor*const*const SimpleCollisionWeightmapTextureMipData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2
)

 Update collision component dominant layer data LandscapeComponent.h  
Update collision component dominant layer data for the whole component, locking and unlocking the weightmap textures. LandscapeComponent.h  

void UpdateCollisionPhysicalMaterialData ( TArray< UPhysicalMaterial* > const& InPhysicalMaterials,
TArray< uint8 > const& InMaterialIds
)

 Update collision component physical materials from render task results. LandscapeComponent.h  

void UpdateDirtyCollisionHeightData ( FIntRect Region
)

 Cumulates component's dirtied collision region that will need to be updated (used by Layer System) LandscapeComponent.h  

void UpdatedSharedPropertiesFromActor()

 Updates the values of component-level properties exposed by the Landscape Actor LandscapeComponent.h  

void UpdateEditToolRenderData()

   LandscapeComponent.h  

bool UpdateGrassTypes ( bool bForceUpdate
)

 If the LandscapeMaterial has changed, updates the GrassTypes array. LandscapeComponent.h  

void UpdateLayerAllowListFromPaintedLayers()

 Update layer allow list to include the currently painted layers. LandscapeComponent.h  
Update the MaterialInstance parameters to match the layer and weightmaps for this component Creates the MaterialInstance if it doesn't exist. LandscapeComponent.h  

void UpdateMaterialInstances ( FMaterialUpdateContext& InOutMaterialContext,
TArray< class FComponentRecreateRenderStateContext >& InOutRecreateRenderStateContext
)

   LandscapeComponent.h  

void UpdateMaterialInstances_Internal ( FMaterialUpdateContext& Context
)

 Internal implementation of UpdateMaterialInstances, not safe to call directly. LandscapeComponent.h  

void UpdateNavigationRelevance()

 Updates navigation properties to match landscape actor's LandscapeComponent.h  

void UpdatePhysicalMaterialTasks()

 Update physical material render tasks. LandscapeComponent.h  

void UpdateRejectNavmeshUnderneath()

 Updates the reject navmesh underneath flag in the collision component LandscapeComponent.h  

bool ValidateCombinationMaterial ( UMaterialInstanceConstant* InCombinationMaterial
) const

   LandscapeComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RecreateCollisionComponent ( bool bUseSimpleCollision
)

   LandscapeComponent.h  

virtual bool SupportsStaticLighting()

 Whether the component type supports static lighting. LandscapeComponent.h  

void UpdateCollisionHeightBuffer ( int32 InComponentX1,
int32 InComponentY1,
int32 InComponentX2,
int32 InComponentY2,
int32 InCollisionMipLevel,
int32 InHeightmapSizeU,
int32 InHeightmapSizeV,
const FColor*const InHeightmapTextureMipData,
uint16* CollisionHeightData,
uint16* GrassHeightData
)

   LandscapeComponent.h  

void UpdateDominantLayerBuffer ( int32 InComponentX1,
int32 InComponentY1,
int32 InComponentX2,
int32 InComponentY2,
int32 InCollisionMipLevel,
int32 InWeightmapSizeU,
int32 InVisibilityLayerIdx,
const TArray< uint8* >& InCollisionDataPtrs,
const TArray< ULandscapeLayerInfoObject* >& InLayerInfos,
uint8* DominantLayerData
)

   LandscapeComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddReferencedObjects ( UObject* InThis,
FReferenceCollector& Collector
)

   LandscapeComponent.h  

static void CreateEmptyTextureMips ( UTexture2D* Texture,
ELandscapeTextureUsage TextureUsage,
ELandscapeTextureType TextureType,
bool bClear
)

 If bClear is true, clears all mips on the specified texture to zero if bClear is false, clears all mips EXCEPT MIP 0 to zero Updates the texture hash appropriately for the given usage and texture type LandscapeComponent.h  

static void DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

   LandscapeComponent.h  

static void GenerateMipsTempl ( int32 InNumSubsections,
int32 InSubsectionSizeQuads,
UTexture2D* WeightmapTexture,
DataType* BaseMipData
)

 Generate mipmaps for weightmap Assumes all weightmaps are unique to this component. LandscapeComponent.h  

static void GenerateWeightmapMips ( int32 InNumSubsections,
int32 InSubsectionSizeQuads,
UTexture2D* WeightmapTexture,
FColor* BaseMipData
)

   LandscapeComponent.h  

static FString GetLayerAllocationKey ( const TArray< FWeightmapLayerAllocationInfo >& Allocations,
UMaterialInterface* LandscapeMaterial,
bool bMobile
)

 Generate a key for a component's layer allocations to use with MaterialInstanceConstantMap. LandscapeComponent.h  

static void UpdateDataMips ( int32 InNumSubsections,
int32 InSubsectionSizeQuads,
UTexture2D* Texture,
TArray< uint8* >& TextureMipData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2,
FLandscapeTextureDataInfo* TextureDataInfo
)

   LandscapeComponent.h  

static void UpdateMipsTempl ( int32 InNumSubsections,
int32 InSubsectionSizeQuads,
UTexture2D* WeightmapTexture,
TArray< DataType* >& WeightmapTextureMipData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2,
FLandscapeTextureDataInfo* TextureDataInfo
)

 Update mipmaps for existing weightmap texture LandscapeComponent.h  

static void UpdateWeightmapMips ( int32 InNumSubsections,
int32 InSubsectionSizeQuads,
UTexture2D* WeightmapTexture,
TArray< FColor* >& WeightmapTextureMipData,
int32 ComponentX1,
int32 ComponentY1,
int32 ComponentX2,
int32 ComponentY2,
FLandscapeTextureDataInfo* TextureDataInfo
)

   LandscapeComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
CollisionComponent_DEPRECATED TLazyObjectPtr< ULandscapeHeightfieldCollisionComponent >   LandscapeComponent.h  
IrrelevantLights_DEPRECATED TArray< FGuid > Legacy irrelevant lights LandscapeComponent.h  
MaterialInstance_DEPRECATED TObjectPtr< UMaterialInstanceConstant >   LandscapeComponent.h  
MobileCombinationMaterialInstance_DEPRECATED TObjectPtr< UMaterialInstanceConstant >   LandscapeComponent.h
  • NonPIEDuplicateTransient
MobileMaterialInterface_DEPRECATED TObjectPtr< UMaterialInterface >   LandscapeComponent.h
  • NonPIEDuplicateTransient
OverrideMaterials_DEPRECATED PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FLandscapeComponentMaterialOverride >   LandscapeComponent.h  
XYOffsetmapTexture_DEPRECATED TObjectPtr< UTexture2D >   LandscapeComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page