Navigation
API > API/Runtime > API/Runtime/Landscape
| Name | ALandscapeProxy |
| Type | class |
| Header File | /Engine/Source/Runtime/Landscape/Classes/LandscapeProxy.h |
| Include Path | #include "LandscapeProxy.h" |
Syntax
UCLASS (Abstract, MinimalAPI, NotBlueprintable, NotPlaceable,
HideCategories=(Display, Attachment, Physics, Debug, Lighting),
ShowCategories=(Lighting, Rendering, Transformation), HideCategories=(Mobility))
class ALandscapeProxy :
public APartitionActor,
public ILandscapeSplineInterface
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → APartitionActor → ALandscapeProxy
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
ALandscapeProxy
(
const FObjectInitializer& ObjectInitializer |
LandscapeProxy.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ALandscapeProxy() |
LandscapeProxy.h |
Classes
| Name | Remarks |
|---|---|
| FLandscapeMaterialChangedDelegate |
Structs
| Name | Remarks |
|---|---|
| FGrassTypeSummary | Non-serialized runtime cache of values derived from the assigned grass types. |
| FRawMeshExportParams |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| GrassUpdateInterval | int32 | LandscapeProxy.h | |
| LandscapeInheritedTag | TCHAR const * | LandscapeProxy.h | |
| LandscapeOverridableTag | TCHAR const * | LandscapeProxy.h | |
| LandscapeProxies | TArray< ALandscapeProxy * > | Maintain list of Proxies for faster iteration | LandscapeProxy.h |
| NaniteComponentMaxSide | int32 | LandscapeProxy.h | |
| NaniteMaxComponents | int32 | LandscapeProxy.h | |
| OnLandscapeProxyFixupSharedDataDelegate | FOnLandscapeProxyFixupSharedDataDelegate | LandscapeProxy.h | |
| VisibilityLayer | ULandscapeLayerInfoObject * | LandscapeProxy.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AsyncFoliageTasks | TArray< FAsyncTask< FAsyncGrassTask > * > | A transient data structure for tracking the grass tasks | LandscapeProxy.h | |
| bAffectDistanceFieldLighting | uint8 | Controls whether the primitive should affect dynamic distance field lighting methods. | LandscapeProxy.h |
|
| bAffectDynamicIndirectLighting | uint8 | Controls whether the primitive should influence indirect lighting. | LandscapeProxy.h |
|
| bAffectIndirectLightingWhileHidden | uint8 | Controls whether the primitive should affect indirect lighting when hidden. | LandscapeProxy.h |
|
| bBakeMaterialPositionOffsetIntoCollision | uint32 | Whether to bake the landscape material's vertical world position offset into the collision heightfield. | LandscapeProxy.h |
|
| bCastContactShadow | uint8 | Whether the object should cast contact shadows. This flag is only used if CastShadow is true. | LandscapeProxy.h |
|
| bCastDynamicShadow | uint8 | Controls whether the primitive should cast shadows in the case of non precomputed shadowing. | LandscapeProxy.h |
|
| bCastFarShadow | uint32 | When enabled, the component will be rendering into the far shadow cascades(only for directional lights). | LandscapeProxy.h |
|
| bCastHiddenShadow | uint8 | If true, the primitive will cast shadows even if bHidden is true. | LandscapeProxy.h |
|
| bCastShadowAsTwoSided | uint32 | Whether this primitive should cast dynamic shadows as if it were a two sided material. | LandscapeProxy.h |
|
| bCastStaticShadow | uint8 | Whether the object should cast a static shadow from shadow casting lights. | LandscapeProxy.h |
|
| bFillCollisionUnderLandscapeForNavmesh | uint32 | Set to true to prevent navmesh generation under the terrain geometry | LandscapeProxy.h |
|
| bGenerateOverlapEvents | uint32 | If true, Landscape will generate overlap events when other components are overlapping it (eg Begin Overlap). | LandscapeProxy.h |
|
| bHoldout | uint8 | If this is True, this primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. | LandscapeProxy.h |
|
| bIsLandscapeActorRegisteredWithLandscapeInfo | bool | True when this Proxy's LandscapeActor has registered with the LandscapeInfo, (and our shared properties are fully updated) | LandscapeProxy.h | |
| bIsRegisteredWithLandscapeInfo | bool | True when this Proxy is registered with the LandscapeInfo | LandscapeProxy.h | |
| bIsRegisteredWithSubsystem | bool | True when this Proxy is registered with the ULandscapeSubsystem | LandscapeProxy.h | |
| bNeedsWeightmapUsagesUpdate | bool | Set to true when on undo, when it's necessary to completely regenerate weightmap usages (since some weightmap allocations are transactional and others not, e.g. splines edit layer) | LandscapeProxy.h | |
| BodyInstance | FBodyInstance | Collision profile settings for this landscape | LandscapeProxy.h |
|
| bRenderCustomDepth | uint32 | If true, the Landscape will be rendered in the CustomDepth pass (usually used for outlines) | LandscapeProxy.h |
|
| bSetCreateRuntimeVirtualTextureVolumes | bool | Placeholder for details customization button. | LandscapeProxy.h |
|
| bStripGrassWhenCookedClient | bool | Strip Grass data when cooked for client | LandscapeProxy.h |
|
| bStripGrassWhenCookedServer | bool | Strip Grass data when cooked for server | LandscapeProxy.h |
|
| bStripPhysicsWhenCookedClient | bool | Strip Physics/collision components when cooked for client | LandscapeProxy.h |
|
| bStripPhysicsWhenCookedServer | bool | Strip Physics/collision components when cooked for server | LandscapeProxy.h |
|
| bTemporarilyDisableWeightmapUsagesValidation | bool | Set to true when we know that weightmap usages are being reconstructed and might be temporarily invalid as a result (ValidateProxyLayersWeightmapUsage should be called after setting this back to false) | LandscapeProxy.h | |
| bUsedForNavigation | uint32 | Hints navigation system whether this landscape will ever be navigated on. | LandscapeProxy.h |
|
| bUseDynamicMaterialInstance | bool | When set to true it will generate MaterialInstanceDynamic for each components, so material can be changed at runtime | LandscapeProxy.h |
|
| bUseLandscapeForCullingInvisibleHLODVertices | bool | Flag whether or not this Landscape's surface can be used for culling hidden triangles | LandscapeProxy.h |
|
| bUseMaterialPositionOffsetInStaticLighting | uint32 | Whether to use the landscape material's vertical world position offset when calculating static lighting. | LandscapeProxy.h |
|
| bUseScalableLODSettings | bool | Allows to specify LOD distribution settings per quality level. | LandscapeProxy.h |
|
| bVirtualTextureRenderWithQuad | bool | Use a single quad to render this landscape to runtime virtual texture pages. | LandscapeProxy.h |
|
| bVirtualTextureRenderWithQuadHQ | bool | Use highest quality heightmap interpolation when using a single quad to render this landscape to runtime virtual texture pages. | LandscapeProxy.h |
|
| CastShadow | uint8 | Controls whether the primitive component should cast a shadow or not. | LandscapeProxy.h |
|
| CollisionComponents | TArray< TObjectPtr< ULandscapeHeightfieldCollisionComponent > > | Array of LandscapeHeightfieldCollisionComponent | LandscapeProxy.h | |
| CollisionMipLevel | int32 | Landscape LOD to use for collision tests. Higher numbers use less memory and process faster, but are much less accurate. | LandscapeProxy.h |
|
| ComponentSizeQuads | int32 | Data set at creation time | LandscapeProxy.h |
|
| CurrentVersion | uint32 | CurrentVersion is bumped whenever a landscape component has an undo/redo operation applied. | LandscapeProxy.h | |
| CustomDepthStencilValue | int32 | Optionally write this 0-255 value to the stencil buffer in CustomDepth pass (Requires project setting or r.CustomDepth == 3) | LandscapeProxy.h |
|
| CustomDepthStencilWriteMask | ERendererStencilMask | Mask used for stencil buffer writes. | LandscapeProxy.h |
|
| DefaultPhysMaterial | TObjectPtr< UPhysicalMaterial > | Default physical material, used when no per-layer values physical materials | LandscapeProxy.h |
|
| ExportLOD | int32 | LOD level to use when exporting the landscape to obj or FBX | LandscapeProxy.h |
|
| FeatureLevelChangedDelegateHandle | FDelegateHandle | Handle so we can unregister the delegate | LandscapeProxy.h | |
| FoliageCache | FCachedLandscapeFoliage | A transient data structure for tracking the grass | LandscapeProxy.h | |
| FoliageComponents | TArray< TObjectPtr< UHierarchicalInstancedStaticMeshComponent > > | LandscapeProxy.h |
|
|
| FrameOffsetForTickInterval | uint32 | Frame offset for tick interval | LandscapeProxy.h | |
| GrassTypesMaxDiscardDistance | float | Only used outside of the editor (e.g. in cooked builds) - this value is no longer authoritative TODO [chris.tchou] remove Cached grass max discard distance for all grass types in all landscape components with landscape grass configured | LandscapeProxy.h | |
| GrassTypeSummary | FGrassTypeSummary | LandscapeProxy.h | ||
| HadLayersContentAtPostLoadTime | TOptional< bool > | LandscapeProxy.h | ||
| HeightmapsCPUReadback | TMap< UTexture2D *, FLandscapeEditLayerReadback * > | LandscapeProxy.h | ||
| HLODMaterialOverride | TObjectPtr< UMaterialInterface > | Specify a custom HLOD material to apply to the HLOD mesh. | LandscapeProxy.h |
|
| HLODMeshSourceLOD | int32 | Specify which LOD to use for the HLOD mesh if HLODMeshSourceLODPolicy is set to SpecificLOD. | LandscapeProxy.h |
|
| HLODMeshSourceLODPolicy | ELandscapeHLODMeshSourceLODPolicy | Specify how to choose the LOD used as input for the HLOD mesh. | LandscapeProxy.h |
|
| HLODTextureSize | int32 | Specify the texture size to use for the HLOD mesh if HLODTextureSizePolicy is set to SpecificSize. | LandscapeProxy.h |
|
| HLODTextureSizePolicy | ELandscapeHLODTextureSizePolicy | Specify how to choose the texture size of the resulting HLOD mesh. | LandscapeProxy.h |
|
| LandscapeComponents | TArray< TObjectPtr< ULandscapeComponent > > | The array of LandscapeComponent that are used by the landscape | LandscapeProxy.h | |
| LandscapeHoleMaterial | TObjectPtr< UMaterialInterface > | Material used to render landscape components with holes. | LandscapeProxy.h |
|
| LandscapeMaterial | TObjectPtr< UMaterialInterface > | Combined material used to render the landscape | LandscapeProxy.h |
|
| LandscapeSectionOffset | FIntPoint | LandscapeProxy.h | ||
| LDMaxDrawDistance | float | Max draw distance exposed to LDs. | LandscapeProxy.h |
|
| LightingChannels | FLightingChannels | Channels that this Landscape should be in. | LandscapeProxy.h |
|
| LightmassSettings | FLightmassPrimitiveSettings | The Lightmass settings for this object. | LandscapeProxy.h |
|
| LOD0DistributionSetting | float | The distribution setting used to change the LOD 0 generation, 1.25 is the normal distribution, numbers influence directly the LOD0 proportion on screen. | LandscapeProxy.h |
|
| LOD0ScreenSize | float | This is the starting screen size used to calculate the distribution. | LandscapeProxy.h |
|
| LODBlendRange | float | This controls the area that blends LOD between neighboring sections. | LandscapeProxy.h |
|
| LODDistributionSetting | float | The distribution setting used to change the LOD generation, 3 is the normal distribution, small number mean you want your last LODs to take more screen space and big number mean you want your first LODs to take more screen space. | LandscapeProxy.h |
|
| LODGroupKey | uint32 | Specifies the LOD Group (Zero is No Group). | LandscapeProxy.h |
|
| MaterialInstanceConstantMap | TMap< FString, TObjectPtr< UMaterialInstanceConstant > > | Map of material instance constants used to for the components. | LandscapeProxy.h | |
| MaxLODLevel | int32 | Max LOD level to use when rendering, -1 means the max available | LandscapeProxy.h |
|
| MaxPaintedLayersPerComponent | int32 | LandscapeProxy.h |
|
|
| NaniteComponents | TArray< TObjectPtr< ULandscapeNaniteComponent > > | LandscapeProxy.h |
|
|
| NavigationGeometryGatheringMode | ENavDataGatheringMode | LandscapeProxy.h |
|
|
| NegativeZBoundsExtension | float | Allows overriding the landscape bounds. | LandscapeProxy.h |
|
| NonNaniteVirtualShadowMapConstantDepthBias | float | Constant bias to handle the worst artifacts of the continuous LOD morphing when rendering to VSM. | LandscapeProxy.h |
|
| NonNaniteVirtualShadowMapInvalidationHeightErrorThreshold | float | For non-Nanite landscape, cached VSM pages need to be invalidated when continuous LOD morphing introduces a height difference that is too large between the current landscape component's profile and the one that was used when the shadow was shadow was last cached. | LandscapeProxy.h |
|
| NonNaniteVirtualShadowMapInvalidationScreenSizeLimit | float | Screen size under which VSM invalidation stops occurring. | LandscapeProxy.h |
|
| NumSubsections | int32 | LandscapeProxy.h |
|
|
| OnComponentDataChanged | FOnLandscapeProxyComponentDataChanged | LandscapeProxy.h | ||
| PositiveZBoundsExtension | float | Allows overriding the landscape bounds. | LandscapeProxy.h |
|
| RegisteredToSubsystem | TObjectPtr< ULandscapeSubsystem > | Used to detect incorrect registration/unregistration behavior | LandscapeProxy.h |
|
| RegistrationCount | uint32 | Tracks the number of times this Proxy has been registered since load | LandscapeProxy.h | |
| ReimportDestinationLayerGuid | FGuid | Height and weightmap import destination layer guid | LandscapeProxy.h | |
| ReimportHeightmapFilePath | FString | LandscapeProxy.h | ||
| RuntimeVirtualTextures | TArray< TObjectPtr< URuntimeVirtualTexture > > | Array of runtime virtual textures into which we draw this landscape. | LandscapeProxy.h |
|
| ScalableLOD0DistributionSetting | FPerQualityLevelFloat | Scalable (per-quality) version of 'LOD 0'. | LandscapeProxy.h |
|
| ScalableLOD0ScreenSize | FPerQualityLevelFloat | Scalable (per-quality) version of 'LOD 0 Screen Size'. | LandscapeProxy.h |
|
| ScalableLODDistributionSetting | FPerQualityLevelFloat | Scalable (per-quality) version of 'Other LODs'. | LandscapeProxy.h |
|
| ShadowCacheInvalidationBehavior | EShadowCacheInvalidationBehavior | Control shadow invalidation behavior, in particular with respect to Virtual Shadow Maps and material effects like World Position Offset. | LandscapeProxy.h |
|
| SimpleCollisionMipLevel | int32 | If set higher than the "Collision Mip Level", this specifies the Landscape LOD to use for "simple collision" tests, otherwise the "Collision Mip Level" is used for both simple and complex collision. | LandscapeProxy.h |
|
| StaticLightingLOD | int32 | LOD level to use when running lightmass (increase to 1 or 2 for large landscapes to stop lightmass crashing) | LandscapeProxy.h |
|
| StaticLightingResolution | float | The resolution to cache lighting at, in texels/quad in one axis Total resolution would be changed by StaticLightingResolution*StaticLightingResolution Automatically calculate proper value for removing seams | LandscapeProxy.h |
|
| StreamingDistanceMultiplier | float | Allows artists to adjust the distance where textures using UV 0 are streamed in/out. | LandscapeProxy.h |
|
| SubsectionSizeQuads | int32 | LandscapeProxy.h |
|
|
| TargetLayersForFixup | TMap< FName, TObjectPtr< ULandscapeLayerInfoObject > > | LandscapeProxy.h | ||
| VirtualTextureLodBias | int32 | Bias to the LOD selected for rendering to runtime virtual textures. | LandscapeProxy.h |
|
| VirtualTextureNumLods | int32 | Number of mesh levels to use when rendering landscape into runtime virtual texture. | LandscapeProxy.h |
|
| VirtualTextureRenderPassType | ERuntimeVirtualTextureMainPassType | Controls if this component draws in the main pass as well as in the virtual texture. | LandscapeProxy.h |
|
| WeightmapFixupVersion | uint32 | LandscapeProxy.h | ||
| WeightmapsCPUReadback | TMap< UTexture2D *, FLandscapeEditLayerReadback * > | LandscapeProxy.h | ||
| WeightmapUsageMap | TMap< TObjectPtr< UTexture2D >, TObjectPtr< ULandscapeWeightmapUsage > > | Map of weightmap usage | LandscapeProxy.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AsyncWorkMonitor | FAsyncWorkMonitor | LandscapeProxy.h | ||
| bHasEditLayersOnLoad | bool | True if this proxy's first component has edit layer data on load. | LandscapeProxy.h | |
| SectionBase | FIntPoint | Offset in quads from global components grid origin (in quads) | LandscapeProxy.h | |
| TargetLayers | TMap< FName, FLandscapeTargetLayerSettings > | LandscapeProxy.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLandscapeTargetLayerSettings & AddTargetLayer
(
const FName& Name, |
Add a TargetLayer with the given name or a generated unique name if the given name is invalid. | LandscapeProxy.h | |
| Add a TargetLayer with a unique name and no layer object info. | LandscapeProxy.h | ||
bool AreNaniteComponentsValid
(
const FGuid& InProxyContentId |
LandscapeProxy.h | ||
bool AuditNaniteMaterials() |
LandscapeProxy.h | ||
virtual void BeginCacheForCookedPlatformData
(
const ITargetPlatform* TargetPlatform |
LandscapeProxy.h | ||
void BuildGrassMaps
(
FScopedSlowTask* InSlowTask |
LandscapeProxy.h | ||
void BuildGrassMaps () |
LandscapeProxy.h | ||
bool BuildPhysicalMaterial () |
Builds the physical materials on the components of this proxy | LandscapeProxy.h | |
void BuildPhysicalMaterial
(
FScopedSlowTask* InSlowTask |
LandscapeProxy.h | ||
virtual bool CanEditChange
(
const FProperty* InProperty |
LandscapeProxy.h | ||
bool CanHaveLayersContent() |
LandscapeProxy.h | ||
virtual void ChangeComponentScreenSizeToUseSubSections
(
float InComponentScreenSizeToUseSubSections |
LandscapeProxy.h |
|
|
void ChangedPhysMaterial() |
Changed Physical Material. | LandscapeProxy.h | |
virtual void ChangeLODDistanceFactor
(
float InLODDistanceFactor |
Change the Level of Detail distance factor | LandscapeProxy.h |
|
void CheckGenerateMobilePlatformData
(
bool bIsCooking, |
LandscapeProxy.h | ||
void ClearNaniteTransactional() |
LandscapeProxy.h | ||
uint32 ComputeLandscapeKey () |
Computes the rendering key for this landscape proxy | LandscapeProxy.h | |
void CopySharedProperties
(
ALandscapeProxy* InLandscape |
Copy properties from parent Landscape actor. | LandscapeProxy.h | |
virtual TUniquePtr< class FWorldPartitionActorDesc > CreateClassActorDesc() |
LandscapeProxy.h | ||
ULandscapeInfo * CreateLandscapeInfo
(
bool bMapCheck, |
Creates the LandscapeInfo if necessary, then registers this proxy with it | LandscapeProxy.h | |
UTexture2D * CreateLandscapeTexture
(
int32 InSizeX, |
Creates a Texture2D for use by this landscape proxy or one of its components. | LandscapeProxy.h | |
UTexture2DArray * CreateLandscapeTextureArray
(
int32 InSizeX, |
Creates a Texture2DArray for use by this landscape proxy or one of its components. | LandscapeProxy.h | |
UTexture2D * CreateLandscapeToolTexture
(
int32 InSizeX, |
Creates a Texture2D for use by this landscape proxy or one of its components for tools . | LandscapeProxy.h | |
ULandscapeLayerInfoObject * CreateLayerInfo
(
const TCHAR* InLayerName, |
LandscapeProxy.h | ||
virtual void CreateSplineComponent
(
const FVector& Scale3D |
LandscapeProxy.h | ||
virtual void CreateSplineComponent () |
LandscapeProxy.h | ||
ULandscapeWeightmapUsage * CreateWeightmapUsage() |
Creates a LandscapeWeightMapUsage object outered to this proxy. | LandscapeProxy.h | |
virtual void DeleteUnusedLayers () |
Delete all unused layers in components. | LandscapeProxy.h |
|
virtual void Destroyed() |
LandscapeProxy.h | ||
void DisplayObsoleteEditLayerMapCheck
(
ALandscape* InParentLandscape |
Displays the obsolete edit layers within the LandscapeComponents in a actionable MapCheck log Asks users to copy obsolete layer data or delete for good. | LandscapeProxy.h | |
virtual void EditorApplyMirror
(
const FVector& MirrorScale, |
LandscapeProxy.h | ||
virtual void EditorApplyScale
(
const FVector& DeltaScale, |
LandscapeProxy.h | ||
void EditorApplySpline
(
USplineComponent* InSplineComponent, |
Deform landscape using a given spline | LandscapeProxy.h |
|
virtual bool EditorCanAttachTo
(
const AActor* InParent, |
LandscapeProxy.h | ||
void EditorSetLandscapeMaterial
(
UMaterialInterface* NewLandscapeMaterial |
Setter for LandscapeMaterial. Has no effect outside the editor. | LandscapeProxy.h |
|
void EnableNaniteComponents
(
bool bInNaniteActive |
LandscapeProxy.h | ||
bool ExportToRawMesh
(
const FRawMeshExportParams& InExportParams, |
Exports landscape geometry into a raw mesh according to the export params | LandscapeProxy.h | |
bool ExportToRawMeshDataCopy
(
const FRawMeshExportParams& InExportParams, |
LandscapeProxy.h | ||
virtual void FinishDestroy() |
LandscapeProxy.h | ||
void FixupSharedData
(
ALandscape* Landscape, |
Assign only mismatching data and mark proxy package dirty. | LandscapeProxy.h | |
void FixupWeightmaps() |
Fix up component layers, weightmaps | LandscapeProxy.h | |
void FlushGrassComponents
(
const TSet< ULandscapeComponent* >* OnlyForComponents, |
Flush the grass cache, removing grass instances on the given components (or all proxy components if the component set is not specified). | LandscapeProxy.h | |
const FName GenerateUniqueTargetLayerName() |
Generate a unique TargetLayer name. | LandscapeProxy.h | |
FAsyncWorkMonitor & GetAsyncWorkMonitor() |
LandscapeProxy.h | ||
FIntRect GetBoundingRect() |
LandscapeProxy.h | ||
virtual uint32 GetDefaultGridSize
(
UWorld* InWorld |
LandscapeProxy.h | ||
bool GetDisableRuntimeGrassMapGeneration() |
LandscapeProxy.h | ||
virtual FGuid GetGridGuid() |
LandscapeProxy.h | ||
TOptional< float > GetHeightAtLocation
(
FVector Location, |
LandscapeProxy.h | ||
void GetHeightValues
(
int32& SizeX, |
Fills an array with height values | LandscapeProxy.h | |
virtual const ALandscape * GetLandscapeActor () |
LandscapeProxy.h |
|
|
virtual ALandscape * GetLandscapeActor () |
LandscapeProxy.h |
|
|
virtual UMaterialInterface * GetLandscapeHoleMaterial() |
Get Hole Landscape Material assigned to this Landscape. | LandscapeProxy.h | |
virtual UMaterialInterface * GetLandscapeMaterial
(
int8 InLODIndex |
Get Landscape Material assigned to this Landscape. | LandscapeProxy.h | |
const TArray< FName > GetLayersFromMaterial () |
LandscapeProxy.h | ||
TArray< float > GetLODScreenSizeArray() |
Retrieve the screen size at which each LOD should be rendered. | LandscapeProxy.h | |
FGuid GetNaniteComponentContentId() |
LandscapeProxy.h | ||
FGuid GetNaniteContentId() |
LandscapeProxy.h | ||
virtual int32 GetNaniteLODIndex() |
LandscapeProxy.h | ||
virtual float GetNaniteMaxEdgeLengthFactor() |
LandscapeProxy.h | ||
virtual int32 GetNanitePositionPrecision() |
LandscapeProxy.h | ||
TSet< FPrimitiveComponentId > GetNanitePrimitiveComponentIds() |
LandscapeProxy.h | ||
virtual float GetNaniteSkirtDepth() |
LandscapeProxy.h | ||
const FGuid & GetOriginalLandscapeGuid () |
Return the original landscape guid, before it was modified by instancing. | LandscapeProxy.h | |
int32 GetOudatedPhysicalMaterialComponentsCount() |
LandscapeProxy.h | ||
virtual UE::Landscape::EOutdatedDataFlags GetOutdatedDataFlags() |
LandscapeProxy.h | ||
int32 GetOutdatedGrassMapCount() |
LandscapeProxy.h | ||
const TArray< FLandscapePerLODMaterialOverride > & GetPerLODOverrideMaterials() |
LandscapeProxy.h | ||
UPhysicalMaterial * GetPhysicalMaterialAtLocation
(
FVector Location, |
LandscapeProxy.h | ||
FBox GetProxyBounds() |
Differs from GetActorBounds as it only considers LandscapeComponents/CollisionComponents bounds | LandscapeProxy.h | |
| LandscapeProxy.h | |||
FIntPoint GetSectionBase() |
Get landscape position in section space | LandscapeProxy.h | |
FIntPoint GetSectionBaseOffset() |
LandscapeProxy.h | ||
const TMap< FName, FLandscapeTargetLayerSettings > & GetTargetLayers() |
All the Target layers. | LandscapeProxy.h | |
TSet< ULandscapeLayerInfoObject * > GetValidTargetLayerObjects() |
LandscapeProxy.h | ||
bool HasEditLayersDataOnLoad() |
LandscapeProxy.h | ||
virtual bool HasLayersContent() |
LandscapeProxy.h | ||
bool HasNaniteComponents() |
LandscapeProxy.h | ||
bool HasTargetLayer
(
const FLandscapeTargetLayerSettings& TargetLayerSettings |
LandscapeProxy.h | ||
bool HasTargetLayer
(
const ULandscapeLayerInfoObject* LayerInfoObject |
LandscapeProxy.h | ||
bool HasTargetLayer
(
const FName& Name |
Query if a TargetLayer exists by Name or by checking the ULandscapeLayerInfoObject in TargetLayerSettings. | LandscapeProxy.h | |
void Import
(
const FGuid& InGuid, |
Import the given Height/Weight data into this landscape | LandscapeProxy.h | |
void InitializeProxyLayersWeightmapUsage() |
LandscapeProxy.h | ||
void InvalidateGeneratedComponentData
(
bool bInvalidateLightingCache |
Invalidate the precomputed grass and baked texture data on all components | LandscapeProxy.h | |
void InvalidateGrassTypeSummary() |
LandscapeProxy.h | ||
void InvalidateNaniteRepresentation
(
bool bInCheckContentId |
Invalidate and disable Nanite representation until a subsequent rebuild occurs | LandscapeProxy.h | |
void InvalidateOrUpdateNaniteRepresentation
(
bool bInCheckContentId, |
Invalidate Nanite representation or rebuild it in case live update is active : | LandscapeProxy.h | |
void InvalidatePhysicalMaterial() |
LandscapeProxy.h | ||
bool IsGrassTypeSummaryValid() |
LandscapeProxy.h | ||
virtual bool IsLevelBoundsRelevant() |
LandscapeProxy.h | ||
virtual bool IsNaniteEnabled() |
LandscapeProxy.h | ||
bool IsNaniteMeshUpToDate() |
Returns true if the Nanite representation is missing or outdated | LandscapeProxy.h | |
virtual bool IsNaniteSkirtEnabled() |
LandscapeProxy.h | ||
bool IsPropertyInherited
(
const FProperty* InProperty |
Returns true if the property is inherited. | LandscapeProxy.h | |
bool IsPropertyOverridable
(
const FProperty* InProperty |
Returns true if the property is overridable. | LandscapeProxy.h | |
bool IsSharedProperty
(
const FName& InPropertyName |
Returns true if the property is shared. | LandscapeProxy.h | |
bool IsSharedProperty
(
const FProperty* InProperty |
Returns true if the property is shared. | LandscapeProxy.h | |
virtual bool IsSharedPropertyOverridden
(
const FName& InPropertyName |
Returns true if the shared property is overridden by the object. | LandscapeProxy.h | |
virtual bool IsSplineOwnerValid() |
LandscapeProxy.h | ||
bool LandscapeExportHeightmapToRenderTarget
(
UTextureRenderTarget2D* InRenderTarget, |
Output a landscape heightmap to a render target | LandscapeProxy.h |
|
bool LandscapeExportWeightmapToRenderTarget
(
UTextureRenderTarget2D* InRenderTarget, |
LandscapeProxy.h | ||
bool LandscapeImportHeightmapFromRenderTarget
(
UTextureRenderTarget2D* InRenderTarget, |
Overwrites a landscape heightmap with render target data | LandscapeProxy.h |
|
bool LandscapeImportWeightmapFromRenderTarget
(
UTextureRenderTarget2D* InRenderTarget, |
Overwrites a landscape weightmap with render target data Only works in the editor | LandscapeProxy.h |
|
TSharedRef< UE::Landscape::Nanite::FAsyncBuildData > MakeAsyncNaniteBuildData
(
int32 InLODToExport, |
LandscapeProxy.h | ||
int32 NumNaniteRequiredComponents() |
LandscapeProxy.h | ||
virtual void OnCookEvent
(
UE::Cook::ECookEvent CookEvent, |
LandscapeProxy.h | ||
void OnFeatureLevelChanged
(
ERHIFeatureLevel::Type NewFeatureLevel |
Editor notification when changing feature level | LandscapeProxy.h | |
virtual void OnLoadedActorRemovedFromLevel() |
LandscapeProxy.h | ||
FLandscapeMaterialChangedDelegate & OnMaterialChangedDelegate() |
LandscapeProxy.h | ||
virtual void PostDuplicate
(
bool bDuplicateForPIE |
LandscapeProxy.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
LandscapeProxy.h | ||
virtual void PostEditImport() |
LandscapeProxy.h | ||
virtual void PostEditMove
(
bool bFinished |
LandscapeProxy.h | ||
virtual void PostEditUndo() |
LandscapeProxy.h | ||
virtual void PostLoad() |
LandscapeProxy.h | ||
virtual void PostRegisterAllComponents() |
LandscapeProxy.h | ||
virtual void PostTransacted
(
const FTransactionObjectEvent& InTransactionEvent |
LandscapeProxy.h | ||
virtual void PreEditUndo() |
LandscapeProxy.h | ||
virtual void PreSave
(
FObjectPreSaveContext ObjectSaveContext |
LandscapeProxy.h | ||
void ProcessAsyncGrassInstanceTasks
(
bool bWaitAsyncTasks, |
LandscapeProxy.h | ||
void RecreateCollisionComponents() |
Recreate all collision components based on render component | LandscapeProxy.h | |
void RecreateComponentsRenderState
(
TFunctionRef< void(ULandscapeComponent*)> Fn |
Recreate all component rendering states after applying a given function to each | LandscapeProxy.h | |
void RecreateComponentsState() |
Recreate all components rendering and collision states | LandscapeProxy.h | |
void RemoveInvalidWeightmaps() |
Remove Invalid weightmaps. | LandscapeProxy.h | |
void RemoveNaniteComponents() |
LandscapeProxy.h | ||
void RemoveOverlappingComponent
(
ULandscapeComponent* Component |
Remove an overlapping component. Called from MapCheck. | LandscapeProxy.h | |
bool RemoveTargetLayer
(
const FName& Name, |
Remove Named TargetLayer, Returns true if a layer has been removed. | LandscapeProxy.h | |
void RemoveXYOffsets() |
Remove all XYOffset values | LandscapeProxy.h | |
void RepairInvalidTextures() |
Repair invalid texture data that might have been introduced by a faulty version : | LandscapeProxy.h | |
void RequestProxyLayersWeightmapUsageUpdate() |
LandscapeProxy.h | ||
virtual void RerunConstructionScripts() |
LandscapeProxy.h | ||
TMap< FName, ULandscapeLayerInfoObject * > RetrieveTargetLayerInfosFromAllocations() |
Query all the LandscapeLayerInfo Objects from the weight layers allocated on this proxy. | LandscapeProxy.h | |
| Get all Layer names used by the materials assigned the proxy and components (Proxy Material, Component, Component LOD Material and Hole Material) | LandscapeProxy.h | ||
virtual void Serialize
(
FArchive& Ar |
LandscapeProxy.h | ||
void SerializeStateHashes
(
FArchive& Ar |
Serialize all hashes/guids that record the current state of this proxy | LandscapeProxy.h | |
void SetAbsoluteSectionBase
(
FIntPoint SectionOffset |
LandscapeProxy.h | ||
void SetDisableRuntimeGrassMapGenerationProxyOnly
(
bool bInDisableRuntimeGrassMapGeneration |
LandscapeProxy.h | ||
void SetLandscapeGuid
(
const FGuid& Guid, |
LandscapeProxy.h | ||
void SetLandscapeMaterialScalarParameterValue
(
FName ParameterName, |
Set a MID scalar (float) parameter value for all landscape components. | LandscapeProxy.h |
|
void SetLandscapeMaterialTextureParameterValue
(
FName ParameterName, |
Set an MID texture parameter value for all landscape components. | LandscapeProxy.h |
|
void SetLandscapeMaterialVectorParameterValue
(
FName ParameterName, |
Set an MID vector parameter value for all landscape components. | LandscapeProxy.h |
|
void SetLODGroupKeyInternal
(
uint32 InLODGroupKey |
LandscapeProxy.h | ||
void SetPerLODOverrideMaterials
(
const TArray< FLandscapePerLODMaterialOverride >& InValue |
LandscapeProxy.h | ||
void SetSectionBase
(
FIntPoint SectionOffset |
Set landscape location in section space | LandscapeProxy.h | |
virtual void SetSharedPropertyOverride
(
const FName& InPropertyName, |
Modifies the override state of the property given as argument. | LandscapeProxy.h | |
void SetSplinesComponent
(
ULandscapeSplinesComponent* InSplineComponent |
LandscapeProxy.h | ||
void SetVirtualTextureRenderPassType
(
ERuntimeVirtualTextureMainPassType InType |
LandscapeProxy.h |
|
|
bool ShouldTickGrass() |
Determine whether we should update dynamic grass instances this update tick | LandscapeProxy.h | |
TArray< FName > SynchronizeSharedProperties
(
ALandscapeProxy* InLandscape |
Enforce property sharing and requirements related to the parent Landscape actor | LandscapeProxy.h | |
virtual void UnregisterAllComponents
(
bool bForReregister |
LandscapeProxy.h | ||
void UpdateAllComponentMaterialInstances
(
bool bInInvalidateCombinationMaterials |
Update the material instances for all the landscape components | LandscapeProxy.h | |
void UpdateAllComponentMaterialInstances
(
FMaterialUpdateContext& InOutMaterialContext, |
LandscapeProxy.h | ||
virtual void UpdateCachedHasLayersContent
(
bool InCheckComponentDataIntegrity |
LandscapeProxy.h | ||
void UpdateGrass
(
const TArray< FVector >& Cameras, |
LandscapeProxy.h | ||
void UpdateGrass
(
const TArray< FVector >& Cameras, |
Update Grass Builds grass instances given the camera locations | LandscapeProxy.h | |
void UpdateGrassTypeSummary() |
LandscapeProxy.h | ||
void UpdateNaniteMaterials() |
Ensure the Update the Materials on the Nanite Static Meshes from the source ULandscapeComponent | LandscapeProxy.h | |
void UpdateNaniteRepresentation
(
const ITargetPlatform* InTargetPlatform |
Update Nanite representation if it's missing or outdated. | LandscapeProxy.h | |
FGraphEventRef UpdateNaniteRepresentationAsync
(
const ITargetPlatform* InTargetPlatform |
Update Nanite representation if it's missing or outdated Async | LandscapeProxy.h | |
void UpdateNaniteSharedPropertiesFromActor() |
LandscapeProxy.h | ||
bool UpdatePhysicalMaterialTasks
(
bool bInShouldMarkDirty |
Update the landscape physical material render tasks | LandscapeProxy.h | |
void UpdatePhysicalMaterialTasksStatus
(
TSet< ULandscapeComponent* >* OutdatedComponents, |
LandscapeProxy.h | ||
void UpdateProxyLayersWeightmapUsage() |
LandscapeProxy.h | ||
void UpdateRenderingMethod() |
LandscapeProxy.h | ||
virtual void UpdateSharedProperties
(
ULandscapeInfo* InLandscapeInfo |
LandscapeProxy.h | ||
bool UpdateTargetLayer
(
const FName& Name, |
Update a existing Target Layer. | LandscapeProxy.h | |
void UpgradeSharedProperties
(
ALandscape* InParentLandscape |
Converts shared properties overridden before explicit override, asking the user how to proceed. | LandscapeProxy.h | |
void ValidateProxyLayersWeightmapUsage() |
LandscapeProxy.h |
Overridden from ILandscapeSplineInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FGuid GetLandscapeGuid () |
Return the landscape guid, used to identify landscape proxies (and splines) that belong to the same landscape, even across world partitions. | LandscapeProxy.h | |
virtual ULandscapeInfo * GetLandscapeInfo() |
LandscapeProxy.h | ||
virtual ULandscapeSplinesComponent * GetSplinesComponent() |
LandscapeProxy.h | ||
virtual FTransform LandscapeActorToWorld() |
Get the LandcapeActor-to-world transform with respect to landscape section offset | LandscapeProxy.h | |
virtual bool SupportsForeignSplineMesh() |
LandscapeProxy.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool AddLayer
(
const FGuid& InLayerGuid |
Add Layer if it doesn't exist yet. | LandscapeProxy.h | |
void DeleteLayer
(
const FGuid& InLayerGuid |
Delete Layer. | LandscapeProxy.h | |
virtual void FixupOverriddenSharedProperties () |
Fixup any internal representation for shared properties. | LandscapeProxy.h | |
| Returns a map of this Proxy's LandscapeComponents obsolete edit layers Guids to Debug Names. | LandscapeProxy.h | ||
void InitializeLayerWithEmptyContent
(
const FGuid& InLayerGuid |
Initialize Layer with empty content if it hasn't been initialized yet. | LandscapeProxy.h | |
bool RemoveObsoleteEditLayers
(
bool bShowMapCheckWarning |
Removes Obsolete Edit layer data from all landscape components | LandscapeProxy.h | |
bool RemoveObsoleteLayers
(
const TSet< FGuid >& InExistingLayers |
LandscapeProxy.h | ||
virtual TArray< FName > SynchronizeUnmarkedSharedProperties
(
ALandscapeProxy* InLandscape |
Synchronizes all shared properties that cannot be marked by regular meta tags. | LandscapeProxy.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AddExclusionBox
(
FWeakObjectPtr Owner, |
TODO [jonathan.bard] : Rename to "AddGrassExclusionBox" + no reason for any of this to be static. | LandscapeProxy.h | |
static void AddReferencedObjects
(
UObject* InThis, |
LandscapeProxy.h | ||
static uint32 ComputeLandscapeKey
(
const UWorld* World, |
LandscapeProxy.h | ||
static ULandscapeLayerInfoObject * CreateLayerInfo
(
const TCHAR* InLayerName, |
LandscapeProxy.h | ||
static ULandscapeLayerInfoObject * CreateLayerInfo
(
const TCHAR* InLayerName, |
LandscapeProxy.h | ||
static void DebugDrawExclusionBoxes
(
const UWorld* World |
LandscapeProxy.h | ||
static const TArray< ALandscapeProxy * > & GetLandscapeProxies() |
LandscapeProxy.h | ||
static const TArray< FName > GetLayersFromMaterial
(
UMaterialInterface* Material |
LandscapeProxy.h | ||
static ULandscapeMaterialInstanceConstant * GetLayerThumbnailMIC
(
UMaterialInterface* LandscapeMaterial, |
Create a thumbnail material for a given layer | LandscapeProxy.h | |
static void InvalidateGeneratedComponentData
(
const TArray< ULandscapeComponent* >& Components, |
LandscapeProxy.h | ||
static void InvalidateGeneratedComponentData
(
const TSet< ULandscapeComponent* >& Components, |
Invalidate the precomputed grass and baked texture data for the specified components | LandscapeProxy.h | |
static FOnLandscapeProxyFixupSharedDataDelegate::RegistrationType & OnLandscapeProxyFixupSharedData() |
Delegate that will be called whenever FixupSharedData is called, to inject some custom logic | LandscapeProxy.h | |
static void RemoveAllExclusionBoxes() |
Unregisters all existing exclusion boxes. | LandscapeProxy.h | |
static void RemoveExclusionBox
(
FWeakObjectPtr Owner |
Unregisters a previously-registered exclusion box. | LandscapeProxy.h | |
static void RemoveInvalidExclusionBoxes() |
LandscapeProxy.h | ||
static TArray< FLinearColor > SampleRTData
(
UTextureRenderTarget2D* InRenderTarget, |
Samples an array of values from a Texture Render Target 2D. Only works in the editor | LandscapeProxy.h | |
static void SetGrassUpdateInterval
(
int32 Interval |
LandscapeProxy.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bHasLayersContent_DEPRECATED | bool | LandscapeProxy.h | ||
| bIsPerformingInteractiveActionOnLandscapeMaterialOverride_DEPRECATED | bool | LandscapeProxy.h |
|
|
| bUseCompressedHeightmapStorage_DEPRECATED | bool | LandscapeProxy.h | ||
| EditorCachedLayerInfos_DEPRECATED | TArray< TObjectPtr< ULandscapeLayerInfoObject > > | LandscapeProxy.h | ||
| EditorLayerSettings_DEPRECATED | PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FLandscapeEditorLayerSettings > | LandscapeProxy.h | ||
| LandscapeMaterialsOverride_DEPRECATED | PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FLandscapeProxyMaterialOverride > | LandscapeProxy.h | ||
| LODDistanceFactor_DEPRECATED | float | LandscapeProxy.h | ||
| LODFalloff_DEPRECATED | TEnumAsByte< ELandscapeLODFalloff::Type > | LandscapeProxy.h | ||
| NaniteComponent_DEPRECATED | TObjectPtr< ULandscapeNaniteComponent > | LandscapeProxy.h | ||
| PreEditLandscapeHoleMaterial_DEPRECATED | TObjectPtr< UMaterialInterface > | LandscapeProxy.h |
|
|
| PreEditLandscapeMaterial_DEPRECATED | TObjectPtr< UMaterialInterface > | LandscapeProxy.h |
|
|
| PreEditPerLODOverrideMaterials_DEPRECATED | TArray< FLandscapePerLODMaterialOverride > | LandscapeProxy.h |
|