1. Epic GamesDeveloper
  3. ULandscapeComponent

ULandscapeComponent

API > API/Runtime > API/Runtime/Landscape

Inheritance Hierarchy

References

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

Syntax

class ULandscapeComponent : public UPrimitiveComponent

Variables

  Type Name Description
Public variable TArray< FBox > ActiveExcludedBoxes  
Public variable FBox CachedLocalBox Cached local-space bounding box, created at heightmap update time
Public variable uint32 ChangeTag  
Public variable int32 CollisionMipLevel Heightfield mipmap used to generate collision
Public variable int32 ComponentSizeQuads Total number of quads for this component, has to be >0
Public variable FLandscapeEditToolRenderData EditToolRenderData Pointer to data shared with the render thread, used by the editor tools
Public variable int32 ForcedLOD Forced LOD level to use when rendering
Public variable TSharedRef< FLandscapeComponentGrassData, ESPMode::ThreadSafe > GrassData Grass data for generation
Public variable FVector4 HeightmapScaleBias UV offset to Heightmap data from component local coordinates
Public variable uint32 LastSavedPhysicalMaterialHash Represents last saved hash for PhysicalMaterialTask
Public variable TArray< TObjectPtr< ULandscapeLayerInfoObject > > LayerAllowList List of layers allowed to be painted on this component.
Public variable int32 LightingLODBias LOD level Bias to use when lighting building via lightmass, -1 Means automatic LOD calculation based on ForcedLOD + LODBias
Public variable int32 LODBias LOD level Bias to use when rendering
Public variable TArray< int8 > LODIndexToMaterialIndex Mapping between LOD and Material Index
Public variable FGuid MapBuildDataId Uniquely identifies this component's built map data.
Public variable TArray< TObjectPtr< UMaterialInstanceConstant > > MaterialInstances  
Public variable TArray< TObjectPtr< UMaterialInstanceDynamic > > MaterialInstancesDynamic  
Public variable TMap< TObjectPtr< UMaterialInterface >, int8 > MaterialPerLOD Represent the chosen material for each LOD
Public variable TArray< TObjectPtr< UMaterialInstanceConstant > > MobileCombinationMaterialInstances 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
Public variable FGuid MobileDataSourceHash Hash of source for mobile generated data.
Public variable TArray< TObjectPtr< UMaterialInterface > > MobileMaterialInterfaces Material interfaces used for mobile
Public variable TArray< FWeightmapLayerAllocationInfo > MobileWeightmapLayerAllocations Layer allocations used by mobile.
Public variable TArray< TObjectPtr< UTexture2D > > MobileWeightmapTextures Generated weightmap textures used for mobile.
Public variable float NegativeZBoundsExtension Allows overriding the landscape bounds.
Public variable int32 NumSubsections Number of subsections in X or Y axis
Public variable TObjectPtr< UMaterialInterface > OverrideHoleMaterial  
Public variable TObjectPtr< UMaterialInterface > OverrideMaterial  
Public variable uint32 PhysicalMaterialHash Represents hash for last PhysicalMaterialTask
Public variable FLandscapePhysicalMaterialRenderTask PhysicalMaterialTask Physical material update task
Public variable float PositiveZBoundsExtension Allows overriding the landscape bounds.
Public variable int32 SectionBaseX X offset from global components grid origin (in quads)
Public variable int32 SectionBaseY Y offset from global components grid origin (in quads)
Public variable int32 SimpleCollisionMipLevel Heightfield mipmap used to generate simple collision
Public variable uint32 SplineHash  
Public variable FGuid StateId TODO [jonathan.bard] : remove unused :
Public variable float StaticLightingResolution StaticLightingResolution overriding per component, default value 0 means no overriding
Public variable int32 SubsectionSizeQuads Number of quads for a subsection of the component. SubsectionSizeQuads+1 must be a power of two.
Public variable FVector4 WeightmapScaleBias UV offset to component's weightmap data from component local coordinates
Public variable uint32 WeightmapsHash Represents hash of last weightmap usage update
Public variable float WeightmapSubsectionOffset U or V offset into the weightmap for the first subsection, in texture UV space
Public variable TObjectPtr< UTexture2D > XYOffsetmapTexture XYOffsetmap texture reference

Constructors

  Type Name Description
Public function  

ULandscapeComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

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

  
Public function void

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

  
Public function Static void  
Public function Const bool Are the textures we need to render a grassmap currently streamed in?
Public function Const uint32  
Public function Const bool Could a grassmap currently be generated, disregarding whether our textures are streamed in?
Public function bool Returns true if we can currently update physical materials.
Public function void

CheckGenerateMobilePlatformData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

 Generate mobile data if it's missing or outdated
Public function void Clears component's dirtied collision region (used by Layer System)
Public function void

ClearUpdateFlagsForModes ( uint32 InModeMask
)

  
Public function Const bool Returns true if this component has visibility painted
Public function Const uint32

ComputeLayerHash ( bool InReturnEditingHash
)

  
Public function uint32  
Public function void

CopyFinalLayerIntoEditingLayer ( FLandscapeEditDataInterface& DataInterface,
TSet< UTexture2D* >& ProcessedHeightmaps
)

  
Public function Static void

CreateEmptyTextureMips ( UTexture2D* Texture,
bool bClear
)

 Generate empty mipmaps for weightmap
Public function Static void

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

  
Public function void Deletes a material layer from the current edit layer on this component, removing all its data, adjusting other layer's weightmaps if necessary, etc.
Public function 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)
Public function 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.
Public function void Deletes Collision Component
Public function float

EditorGetPaintLayerWeightAtLocation ( const FVector& InLocation,
ULandscapeLayerInfoObject* PaintLayer
)

 Gets the landscape paint layer weight value at the given position using LandscapeLayerInfo .
Public function float

EditorGetPaintLayerWeightByNameAtLocation ( const FVector& InLocation,
const FName InPaintLayerName
)

 Gets the landscape paint layer weight value at the given position using layer name.
Public function void Fills a layer to 100% on this component, adding it if needed and removing other layers that get painted away.
Public function void

FinalizePhysicalMaterial ( bool bInImmediatePhysicsRebuild
)

 Write the physical materials into the LandscapeComponent from the Render & Immediately Rebuild physics if requested
Public function void

FixupWeightmaps ( const FGuid& InEditLayerGuid
)

 Fix up component layers, weightmaps
Public function void Fix up component layers, weightmaps
Public function void  
Public function void

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

 Generate mipmaps for height and tangent data.
Public function Static void

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

 Generate mipmaps for weightmap Assumes all weightmaps are unique to this component.
Public function void

GenerateMobilePlatformPixelData ( bool bIsCooking,
const ITargetPlatform* TargetPlatform
)

  
Public function void Generates mobile platform data for this component.
Public function Static void

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

  
Public function Const ULandscapeHeightfieldCollisionComponent *  
Public function Const UMaterialInstanceConstant *

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

 Helper function for UpdateMaterialInstance to get Material without set parameters
Public function Const void

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

 Extends passed region with this component's 2D bounds (values are in landscape quads)
Public function Const FIntRect Returns the 2D bounds of this component (in landscape quads)
Public function TArray< FWeightmapLayerAllocationInfo > &  
Public function Const const TArray< FWeightmapLayerAllocationInfo > &  
Public function FLandscapeLayerComponentData * Get the Landscape Actor's editing layer data
Public function Const const FLandscapeLayerComponentData * Get the Landscape Actor's editing layer data
Public function Const FGuid Get the Landscape Actor's editing layer GUID
Public function Const TArray< UMaterialInstance * >  
Public function Const TArray< UTexture * > Returns all generated textures and material instances used by this component.
Public function Const void

GetGeneratedTexturesAndMaterialInstances ( TArray< UObject* >& OutTexturesAndMaterials
)

 Returns all generated textures and material instances used by this component.
Public function Const UTexture2D *

GetHeightmap ( bool InReturnEditingHeightmap
)

 Returns the heightmap for this component. If InReturnEditingHeightmap is passed, returns the currently active edit layer's heightmap :
Public function Const UTexture2D *

GetHeightmap ( const FGuid& InLayerGuid
)

 Returns the heightmap for this component and the edit layer specified by InLayerGuid. If InLayerGuid is invalid, returns the final (base) heightmap :
Public function Const ALandscape * Get the landscape actor associated with this component.
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const UMaterialInterface * Returns the components's LandscapeHoleMaterial, or the Component's OverrideLandscapeHoleMaterial if set
Public function Const ULandscapeInfo * Gets the landscape info object for this landscape
Public function Const UMaterialInterface *

GetLandscapeMaterial ( int8 InLODIndex
)

 Returns the component's LandscapeMaterial, or the Component's OverrideLandscapeMaterial if set
Public function Const ALandscapeProxy * Gets the landscape proxy actor which owns this component
Public function Static FString

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

 Generate a key for a component's layer allocations to use with MaterialInstanceConstantMap.
Public function FLandscapeLayerComponentData *

GetLayerData ( const FGuid& InLayerGuid
)

  
Public function Const const FLandscapeLayerComponentData *

GetLayerData ( const FGuid& InLayerGuid
)

  
Public function Const void

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

  
Public function Const uint32  
Public function float

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

  
Public function Const ULevel * Get the level in which the owning actor resides
Public function Const const FGuid &  
Public function Const FGuid  
Public function Const UMaterialInstance *

GetMaterialInstance ( int32 InIndex,
bool InDynamic
)

  
Public function Const int32

GetMaterialInstanceCount ( bool InDynamic
)

  
Public function Const UMaterialInstanceDynamic *

GetMaterialInstanceDynamic ( int32 InIndex
)

 Gets the landscape material instance dynamic for this component
Public function Const const FMeshMapBuildData *  
Public function Const bool  
Public function Const bool  
Public function Const const TArray< FLandscapePerLODMaterialOverride > &  
Public function Const bool

GetRenderPhysicalMaterials ( TArray< UPhysicalMaterial* >& OutPhysicalMaterials
)

 Get the physical materials that are configured by the landscape component graphical material.
Public function Const FIntPoint  
Public function Virtual void

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

  
Public function Const void

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

  
Public function Const bool  
Public function Const ULandscapeLayerInfoObject *  
Public function Const const TArray< FWeightmapLayerAllocationInfo > &

GetWeightmapLayerAllocations ( const FGuid& InLayerGuid
)

  
Public function TArray< FWeightmapLayerAllocationInfo > &

GetWeightmapLayerAllocations ( bool InReturnEditingWeightmap
)

  
Public function Const const TArray< FWeightmapLayerAllocationInfo > &

GetWeightmapLayerAllocations ( bool InReturnEditingWeightmap
)

  
Public function TArray< FWeightmapLayerAllocationInfo > &

GetWeightmapLayerAllocations ( const FGuid& InLayerGuid
)

  
Public function Const const TArray< UTexture2D * > &

GetWeightmapTextures ( const FGuid& InLayerGuid
)

  
Public function TArray< TObjectPtr< UTexture2D > > &

GetWeightmapTextures ( const FGuid& InLayerGuid
)

  
Public function Const const TArray< UTexture2D * > &

GetWeightmapTextures ( bool InReturnEditingWeightmap
)

  
Public function TArray< TObjectPtr< UTexture2D > > &

GetWeightmapTextures ( bool InReturnEditingWeightmap
)

  
Public function Const const TArray< ULandscapeWeightmapUsage * > &

GetWeightmapTexturesUsage ( const FGuid& InLayerGuid
)

  
Public function TArray< TObjectPtr< ULandscapeWeightmapUsage > > &

GetWeightmapTexturesUsage ( bool InReturnEditingWeightmap
)

  
Public function Const const TArray< ULandscapeWeightmapUsage * > &

GetWeightmapTexturesUsage ( bool InReturnEditingWeightmap
)

  
Public function TArray< TObjectPtr< ULandscapeWeightmapUsage > > &

GetWeightmapTexturesUsage ( const FGuid& InLayerGuid
)

  
Public function Const bool  
Public function void

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

 Initialize the landscape component
Public function void

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

  
Public function void

InitializeLayersWeightmapUsage ( const FGuid& InLayerGuid
)

  
Public function void

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

  
Public function Const bool Is the grassmap data outdated, eg by a material
Public function Const bool Returns true if the component has a valid LandscapeHoleMaterial
Public function Const bool  
Public function Const bool True if the component's landscape material supports grass
Public function void

ReallocateWeightmaps ( FLandscapeEditDataInterface* DataInterface,
bool InCanUseEditingWeightmap,
bool InSaveToTransactionBuffer,
bool InForceReallocate,
ALandscapeProxy* InTargetProxy,
TArray< UTexture* >* OutNewCreatedTextures
)

 Create weightmaps for this component for the layers specified in the WeightmapLayerAllocations array, works in the landscape current edit layer when InCanUseEditingWeightmap is true
Public function void

ReallocateWeightmapsInternal ( FLandscapeEditDataInterface* DataInterface,
const FGuid& InEditLayerGuid,
bool InSaveToTransactionBuffer,
bool InForceReallocate,
ALandscapeProxy* InTargetProxy,
TArray< UTexture* >* OutNewCreatedTextures
)

 Create weightmaps for this component for the layers specified in the WeightmapLayerAllocations array, works in the specified edit layer
Protected function void

RecreateCollisionComponent ( bool bUseSimpleCollision
)

  
Public function void  
Public function void  
Public function void

RemoveInvalidWeightmaps ( const FGuid& InEditLayerGuid
)

  
Public function void

RemoveLayerData ( const FGuid& InLayerGuid
)

  
Public function void Creates and destroys cooked grass data stored in the map
Public function TArray< uint16 >

RenderWPOHeightmap ( int32 LOD
)

 Renders the heightmap of this component (including material world-position-offset) at the specified LOD
Public function TArray< UTexture * > Repair invalid texture data that might have been introduced by a faulty version.
Public function void Replaces one layerinfo on this component with another
Public function void

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

 Replaces one layerinfo on this component with another
Public function void  
Public function void

RequestEditingClientUpdate ( bool bInUserTriggered
)

  
Public function void

RequestHeightmapUpdate ( bool bUpdateAll,
bool bUpdateCollision,
bool bInUserTriggered
)

  
Public function void

RequestWeightmapUpdate ( bool bUpdateAll,
bool bUpdateCollision,
bool bInUserTriggered
)

  
Public function void Serialize all hashes/guids that record the current state of this component
Public function void  
Public function void

SetForcedLOD ( int32 InForcedLOD
)

  
Public function void

SetHeightmap ( UTexture2D* NewHeightmap
)

  
Public function void  
Public function void

SetLOD ( bool bForced,
int32 InLODValue
)

  
Public function void

SetLODBias ( int32 InLODBias
)

  
Public function void

SetNaniteActive ( bool bValue
)

  
Public function void

SetPendingCollisionDataUpdate ( bool bInPendingCollisionDataUpdate
)

  
Public function void

SetPendingLayerCollisionDataUpdate ( bool bInPendingLayerCollisionDataUpdate
)

  
Public function void  
Public function void

SetSectionBase ( FIntPoint InSectionBase
)

  
Public function void

SetUserTriggeredChangeRequested ( bool bInUserTriggeredChangeRequested
)

  
Public function void

SetWeightmapLayerAllocations ( const TArray< FWeightmapLayerAllocationInfo >& InNewWeightmapLayerAllocations
)

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

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

  
Public function void

UpdateCachedBounds ( bool bInApproximateBounds
)

 Recalculate cached bounds using height values.
Public function void

UpdateCollisionData ( bool bInUpdateHeightfieldRegion
)

 Updates collision component height data for the entire component, locking and unlocking heightmap textures
Protected function void

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

  
Public function void

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

 Create or updates collision component height data
Public function void Update collision component dominant layer data for the whole component, locking and unlocking the weightmap textures.
Public function 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
Public function void

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

 Update collision component physical materials from render task results.
Public function Static void

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

  
Public function void

UpdateDirtyCollisionHeightData ( FIntRect Region
)

 Cumulates component's dirtied collision region that will need to be updated (used by Layer System)
Protected function void

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

  
Public function void Updates the values of component-level properties exposed by the Landscape Actor
Public function void  
Public function void Update layer allow list to include the currently painted layers.
Public function void Update the MaterialInstance parameters to match the layer and weightmaps for this component Creates the MaterialInstance if it doesn't exist.
Public function void

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

 Update the MaterialInstance parameters to match the layer and weightmaps for this component Creates the MaterialInstance if it doesn't exist.
Public function void Internal implementation of UpdateMaterialInstances, not safe to call directly.
Public function 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
Public function void Updates navigation properties to match landscape actor's
Public function void Update physical material render tasks.
Public function void Updates the reject navmesh underneath flag in the collision component
Public function Static void

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

  
Public function Const bool  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual Const void

AddMapBuildDataGUIDs ( TSet< FGuid >& InGUIDs
)

 Add the used GUIDs from UMapBuildDataRegistry::MeshBuildData.
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const void

GetLightAndShadowMapMemoryUsage ( int32& LightMapMemoryUsage,
int32& ShadowMapMemoryUsage
)

 Returns the light and shadow map memory for this primitive in its out variables.
Public function Virtual Const bool

GetLightMapResolution ( int32& Width,
int32& Height
)

 Returns the lightmap resolution used for this primitive instance in the case of it supporting texture light/ shadow maps.
Public function Virtual Const UMaterialInterface *

GetMaterial ( int32 ElementIndex
)

 Returns the material used by the element at the specified index
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const TArray< URuntimeVirtualTexture * > const & Get the array of runtime virtual textures into which we render the mesh for this actor.
Public function Virtual Const ELightMapInteractionType Requests whether the component will use texture, vertex or no lightmaps.
Public function Virtual Const int32 Returns the static lightmap resolution used for this primitive.
Public function Virtual Const void Enumerates the streaming textures/meshes used by the primitive.
Public function Virtual Const void

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

 Retrieves the materials used in this component
Public function Virtual Const ERuntimeVirtualTextureMainPassType Get the runtime virtual texture pass settings.
Public function Virtual Const bool

IsShown ( const FEngineShowFlags& ShowFlags
)

 Would this primitive be shown with these rendering flags.
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Protected function Virtual Const bool Whether the component type supports static lighting.

Overridden from USceneComponent

  Type Name Description
Public function Virtual Const FBoxSphereBounds

CalcBounds ( const FTransform& LocalToWorld
)

 Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.
Public function Virtual bool

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

 Returns full material property path and UObject owner property object Path examples: Material property path with array element and inner struct Materials[0].InnerStruct.Material Material property path with array element Materials[0] Simple material property path Materials
Public function Virtual Const bool True if our precomputed lighting is up to date
Public function Virtual void Called to update any visuals needed for a feature level change
Public function Virtual void Updates any visuals after the lighting has changed

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

DestroyComponent ( bool bPromoteChildren
)

 Unregister the component, remove it from its outer Actor's Components array and mark for pending kill.
Public function Virtual Const TSubclassOf< class UHLODBuilder > Return the custom HLODBuilder class that should be used to generate HLODs for components of this type.
Public function Virtual void

InvalidateLightingCacheDetailed ( bool bInvalidateBuildEnqueuedLighting,
bool bTranslationOnly
)

 Called when this actor component has moved, allowing it to discard statically cached lighting information.
Public function Virtual Const bool Override to specify that a component is relevant to the HLOD generation.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
Public function Virtual void Called before destroying the object.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
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 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
Public function Virtual void Called before applying a transaction to the object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

Name Description
UndoRedoModifiedComponentCount Records the ULandscapeComponents that are modified in any undo/redo operation that is being applied currently
UndoRedoModifiedComponents  

Deprecated Variables

  Type Name Description
Public variable FGuid BakedTextureMaterialGuid BakedTextureMaterialGuid is officially deprecated now and nothing updates it anymore
Public variable TLazyObjectPtr< ULandscapeHeightfieldCollisionComponent > CollisionComponent_DEPRECATED  
Public variable TObjectPtr< UTexture2D > GIBakedBaseColorTexture GIBakedBaseColorTexture is officially deprecated now and nothing updates it anymore
Public variable TArray< FGuid > IrrelevantLights_DEPRECATED Legacy irrelevant lights
Public variable FGuid LastBakedTextureMaterialGuid LastBakedTextureMaterialGuid is officially deprecated now and nothing updates it anymore
Public variable TObjectPtr< UMaterialInstanceConstant > MaterialInstance_DEPRECATED  
Public variable TObjectPtr< UMaterialInstanceConstant > MobileCombinationMaterialInstance_DEPRECATED  
Public variable TObjectPtr< UMaterialInterface > MobileMaterialInterface_DEPRECATED  
Public variable PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FLandscapeComponentMaterialOverride > OverrideMaterials_DEPRECATED OverrideMaterials has been deprecated, use PerLODOverrideMaterials instead.

Deprecated Functions

  Type Name Description
Public function void

SetEditingLayer ( const FGuid& InEditingLayer
)

 SetEditingLayer has been deprecated, use GetLandscapeActor()->SetEditingLayer() instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page