Navigation
API > API/Plugins > API/Plugins/LandscapePatch
Special edit layer used only for landscape patches. Patches point to the layer via a guid and determine their ordering by their Priority values.
| Name | ULandscapePatchEditLayer |
| Type | class |
| Header File | /Engine/Plugins/Editor/LandscapePatch/Source/LandscapePatch/Public/LandscapePatchEditLayer.h |
| Include Path | #include "LandscapePatchEditLayer.h" |
Syntax
UCLASS (MinimalAPI, Meta=(ShortTooltip="Special edit layer for landscape patches"))
class ULandscapePatchEditLayer : public ULandscapeEditLayerProcedural
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → ULandscapeEditLayerBase → ULandscapeEditLayerProcedural → ULandscapePatchEditLayer
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FEditLayerRendererState | UE::Landscape::EditLayers::FEditLayerRendererState | LandscapePatchEditLayer.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PATCH_PRIORITY_BASE | const double | LandscapePatchEditLayer.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bPatchListDirty | bool | When true, the entire patch list needs filtering and sorting. | LandscapePatchEditLayer.h | |
| HighestKnownPriority | double | A tracker of the highest priority we've seen. | LandscapePatchEditLayer.h | |
| PatchToIndex | TMap< TSoftObjectPtr< ULandscapePatchComponent >, int32 > | A helper structure for quick containment queries and updates. | LandscapePatchEditLayer.h |
|
| RegisteredPatches | TArray< TSoftObjectPtr< ULandscapePatchComponent > > | This is the transient list of patches that are bound to this edit layer, usually sorted by priority. | LandscapePatchEditLayer.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual double GetHighestPatchPriority() |
Returns the highest known patch priority, or PATCH_PRIORITY_BASE if none are higher. | LandscapePatchEditLayer.h | |
virtual void NotifyOfPatchRemoval
(
ULandscapePatchComponent* Patch |
Should be called to notify the edit layer when a patch is destroyed or changes its edit layer guid away from this layer. | LandscapePatchEditLayer.h | |
virtual void NotifyOfPriorityChange
(
ULandscapePatchComponent* Patch |
Should be called to notify the edit layer when a patch priority changes. | LandscapePatchEditLayer.h | |
virtual void RegisterPatchForEditLayer
(
ULandscapePatchComponent* Patch |
Must be called by patches on this layer to let the layer know that the patch is pointing to it via its layer guid. | LandscapePatchEditLayer.h | |
void RequestLandscapeUpdate
(
bool bInUserTriggered |
LandscapePatchEditLayer.h |
Overridden from ULandscapeEditLayerBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FString GetDefaultName() |
LandscapePatchEditLayer.h | ||
virtual void GetRenderDependencies
(
TSet< UObject* >& OutDependencies |
LandscapePatchEditLayer.h | ||
virtual bool NeedsPersistentTextures() |
LandscapePatchEditLayer.h | ||
virtual void OnLayerRemoved() |
LandscapePatchEditLayer.h | ||
virtual bool SupportsMultiple() |
LandscapePatchEditLayer.h | ||
virtual bool SupportsTargetType
(
ELandscapeToolTargetType InType |
ULandscapeEditLayerBase. | LandscapePatchEditLayer.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditUndo() |
UObject. | LandscapePatchEditLayer.h |
Overridden from IEditLayerRendererProvider
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FEditLayerRendererState > GetEditLayerRendererStates
(
const UE::Landscape::EditLayers::FMergeContext* InMergeContext |
IEditLayerRendererProvider. | LandscapePatchEditLayer.h |