1. Epic GamesDeveloper
  3. ULandscapeTexturePatch

ULandscapeTexturePatch

API > API/Plugins > API/Plugins/LandscapePatch

   
Name ULandscapeTexturePatch
Type class
Header File /Engine/Plugins/Experimental/LandscapePatch/Source/LandscapePatch/Public/LandscapeTexturePatch.h
Include Path #include "LandscapeTexturePatch.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, BlueprintType, ClassGroup=Landscape,  
       Meta=(BlueprintSpawnableComponent))  
class ULandscapeTexturePatch : public ULandscapePatchComponent

Inheritance Hierarchy

Implements Interfaces

Typedefs

Name Type Remarks Include Path
FEditLayerRenderItem UE::Landscape::EditLayers::FEditLayerRenderItem   LandscapeTexturePatch.h
FEditLayerTargetTypeState UE::Landscape::EditLayers::FEditLayerTargetTypeState   LandscapeTexturePatch.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
HeightRenderTargetFormat TEnumAsByte< ETextureRenderTargetFormat >   LandscapeTexturePatch.h
  • EditDefaultsOnly
  • Category=Settings

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddWeightPatch ( const FName& InWeightmapLayerName,
ELandscapeTexturePatchSourceMode SourceMode,
bool bUseAlphaChannel
)

 By default, the layer is added with source mode set to be a texture-backed render target. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void ClearWeightPatchBlendModeOverride ( const FName& InWeightmapLayerName
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void DisableAllWeightPatches()

 Sets the source mode of all weight patches to "None". LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

TArray< FName > GetAllWeightPatchLayerNames()

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual FVector2D GetFullUnscaledWorldSize ()

 When using an internal texture, gives size in unscaled world coordinates of the patch in the world, based off of UnscaledCoverage and texture resolution (i.e., adds a half-pixel around UnscaledCoverage). LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual UTextureRenderTarget2D * GetHeightRenderTarget ( bool bMarkDirty
)

 Gets the internal height render target, if source mode is set to Texture Backed Render Target. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual ELandscapeTexturePatchSourceMode GetHeightSourceMode()

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual bool GetInitResolutionFromLandscape ( float ResolutionMultiplier,
FVector2D& ResolutionOut
) const

 Given the landscape resolution, current patch coverage, and a landscape resolution multiplier, gives the needed resolution of the landscape patch. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch
  • Meta=(ResolutionMultiplier="1.0")

virtual FTransform GetPatchToWorldTransform ()

 Gets the transform from patch to world. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual FVector2D GetResolution ()

 Gets the size (in pixels) of the internal textures used by the patch. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual FVector2D GetUnscaledCoverage ()

 Gives size in unscaled world coordinates (ie before applying patch transform) of the patch as measured between the centers of the outermost pixels. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual UTextureRenderTarget2D * GetWeightPatchRenderTarget ( const FName& InWeightmapLayerName,
bool bMarkDirty
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual ELandscapeTexturePatchSourceMode GetWeightPatchSourceMode ( const FName& InWeightmapLayerName
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual UTexture * GetWeightPatchTextureAsset ( const FName& InWeightmapLayerName
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void RemoveAllWeightPatches()

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void RemoveWeightPatch ( const FName& InWeightmapLayerName
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void ResetHeightEncodingMode ( ELandscapeTextureHeightPatchEncoding EncodingMode
)

 Just like SetSourceEncodingMode, but resets ZeroInEncoding, WorldSpaceEncodingScale, and height render target format to mode-specific defaults. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetBlendMode ( ELandscapeTexturePatchBlendMode BlendModeIn
)

 Determines how the height patch is blended into the existing terrain. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void SetEditVisibilityLayer ( const FName& InWeightmapLayerName,
const bool bEditVisibilityLayer
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetFalloff ( float FalloffIn
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetFalloffMode ( ELandscapeTexturePatchFalloffMode FalloffModeIn
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetHeightEncodingMode ( ELandscapeTextureHeightPatchEncoding EncodingMode
)

 Set the height encoding mode for the patch, which determines how stored values in the patch are translated into heights when applying to landscape. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch
Set settings that determine how values in the patch are translated into heights. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetHeightRenderTargetFormat ( ETextureRenderTargetFormat Format
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch
  • Meta=(ETextureRenderTargetFormat="ETextureRenderTargetFormat::RTF_R32f")
Changes source mode. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetHeightTextureAsset ( UTexture* TextureIn
)

 Sets the texture used for height when the height source mode is set to texture asset. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void SetResolution ( FVector2D ResolutionIn
)

 Sets the resolution of the currently used internal texture or render target. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void SetUnscaledCoverage ( FVector2D Coverage
)

 Set the patch coverage (see GetUnscaledCoverage for description). LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetUseAlphaChannelForHeight ( bool bUse
)

 Determines whether the height patch alpha channel is used for blending into the existing values. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category="LandscapePatch"

virtual void SetUseAlphaChannelForWeightPatch ( const FName& InWeightmapLayerName,
bool bUseAlphaChannel
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void SetWeightPatchBlendModeOverride ( const FName& InWeightmapLayerName,
ELandscapeTexturePatchBlendMode BlendMode
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

virtual void SetWeightPatchSourceMode ( const FName& InWeightmapLayerName,
ELandscapeTexturePatchSourceMode NewMode
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetWeightPatchTextureAsset ( const FName& InWeightmapLayerName,
UTexture* TextureIn
)

   LandscapeTexturePatch.h
  • BlueprintCallable
  • Category=LandscapePatch

void SetZeroHeightMeaning ( ELandscapeTextureHeightPatchZeroHeightMeaning ZeroHeightMeaningIn
)

 Set how zero height is interpreted, see comments in ELandscapeTextureHeightPatchZeroHeightMeaning. LandscapeTexturePatch.h
  • BlueprintCallable
  • Category="LandscapePatch"

Overridden from ULandscapePatchComponent

Name Remarks Include Path Unreal Specifiers

virtual bool CanAffectHeightmap()

 ILandscapeEditLayerRenderer Subclasses are expected to implement GetEditLayerRendererDebugName, GetRendererStateInfo, GetRenderItems, and RenderLayer These determine whether the patch is configured correctly to affect height/weightmaps, ignoring whether it is currently enabled or not. LandscapeTexturePatch.h  

virtual bool CanAffectVisibilityLayer()

   LandscapeTexturePatch.h  

virtual bool CanAffectWeightmap()

   LandscapeTexturePatch.h  

virtual bool CanAffectWeightmapLayer ( const FName& InLayerName
) const

   LandscapeTexturePatch.h  

virtual void GetRenderDependencies ( TSet< UObject* >& OutDependencies
) const

 Allows the patch to specify textures that need to be ready/compiled before applying the patch. LandscapeTexturePatch.h  

virtual UTextureRenderTarget2D * RenderLayer_Native ( const FLandscapeBrushParameters& InParameters,
const FTransform& HeightmapToWorld
)

 ULandscapePatchComponent. LandscapeTexturePatch.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CheckForErrors()

 UActorComponent. LandscapeTexturePatch.h  

virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData()

 UActorComponent. LandscapeTexturePatch.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 UObject. LandscapeTexturePatch.h  

virtual void Serialize ( FArchive& Ar
)

   LandscapeTexturePatch.h  

Overridden from ILandscapeEditLayerRenderer

Name Remarks Include Path Unreal Specifiers

virtual void BlendLayer ( UE::Landscape::EditLayers::FRenderParams& RenderParams,
UE::Landscape::FRDGBuilderRecorder& RDGBuilderRecorder
)

   LandscapeTexturePatch.h  

virtual bool CanGroupRenderLayerWith ( TScriptInterface< ILandscapeEditLayerRenderer > InOtherRenderer
) const

   LandscapeTexturePatch.h  

virtual FString GetEditLayerRendererDebugName()

   LandscapeTexturePatch.h  

virtual void GetRendererStateInfo ( const UE::Landscape::EditLayers::FMergeContext* InMergeContext,
FEditLayerTargetTypeState& OutSupportedTargetTypeState,
FEditLayerTargetTypeState& OutEnabledTargetTypeState,
TArray< TBitArray<> >& OutTargetLayerGroups
) const

 ILandscapeEditLayerRenderer, via ULandscapePatchComponent. LandscapeTexturePatch.h  

virtual UE::Landscape::EditLayers::ERenderFlags GetRenderFlags ( const UE::Landscape::EditLayers::FMergeContext* InMergeContext
) const

   LandscapeTexturePatch.h  

virtual TArray< FEditLayerRenderItem > GetRenderItems ( const UE::Landscape::EditLayers::FMergeContext* InMergeContext
) const

   LandscapeTexturePatch.h  

virtual bool RenderLayer ( UE::Landscape::EditLayers::FRenderParams& RenderParams,
UE::Landscape::FRDGBuilderRecorder& RDGBuilderRecorder
)

   LandscapeTexturePatch.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RequestReinitializeHeight()

 Given the current initialization settings, reinitialize the height patch. LandscapeTexturePatch.h
  • CallInEditor
  • Category=HeightPatch
  • Meta=(DisplayName="Reinitialize Height")

void RequestReinitializeWeights()

   LandscapeTexturePatch.h
  • CallInEditor
  • Category=WeightPatches
  • Meta=(DisplayName="Reinitialize Weights")

void SnapToLandscape ()

 Adjusts patch rotation to be aligned to a 90 degree increment relative to the landscape, adjusts UnscaledPatchCoverage such that it becomes a multiple of landscape quad size, and adjusts patch location so that the boundaries of the covered area lie on the nearest landscape vertices. LandscapeTexturePatch.h
  • BlueprintCallable
  • CallInEditor
  • Category=Initialization

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page