1. Epic GamesDeveloper
  3. ULandscapeTexturePatch

ULandscapeTexturePatch

API > API/Plugins > API/Plugins/LandscapePatch

Inheritance Hierarchy

References

   
Module LandscapePatch
Header /Engine/Plugins/Experimental/LandscapePatch/Source/LandscapePatch/Public/LandscapeTexturePatch.h
Include #include "LandscapeTexturePatch.h"

Syntax

UCLASS&40;Blueprintable, BlueprintType, ClassGroup&61;Landscape, Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class ULandscapeTexturePatch : public ULandscapePatchComponent

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta bool bApplyComponentZScale Whether to apply the patch Z scale to the height stored in the patch.
Protected variable UProperty Category, EditAnywhere bool bBaseResolutionOffLandscape When initializing from landscape, set resolution based off of the landscape (and a multiplier).
Protected variable UProperty Category, EditAnywhere ELandscapeTexturePatchBlendMode BlendMode  
Protected variable bool bReinitializeHeightOnNextRender  
Protected variable UProperty Category, EditAnywhere bool bUseTextureAlphaForHeight When true, texture alpha channel will be used when applying the patch.
Protected variable UProperty Category, EditAnywhere, Meta   ClampMin Texture width to use when reinitializing, if not basing resolution off landscape.
Protected variable UProperty Category, Meta editinstanceonly ELandscapeTexturePatchSourceMode DetailPanelHeightSourceMode How the heightmap of the patch is stored.
Protected variable UProperty Category, EditAnywhere, Meta   DisallowedAssetDataTags  
Protected variable UProperty Category, EditAnywhere, Meta   EditCondition Texture used when source mode is set to a texture asset.
Protected variable UProperty Category, EditAnywhere, Meta float Falloff Distance (in unscaled world coordinates) across which to smoothly fall off the patch effects.
Protected variable UProperty Category, EditAnywhere ELandscapeTexturePatchFalloffMode FalloffMode  
Protected variable UProperty Category instanced, visibleanywhere TObjectPtr< ULandscapeHeightTextureBackedRenderTarget > HeightInternalData Not directly settable via detail panel- for display/debugging purposes only.
Protected variable UProperty Category, EditAnywhere, Meta ELandscapeTexturePatchSourceMode HeightSourceMode How the heightmap of the patch is stored.
Protected variable UProperty int32 NumWeightPatches Used to detect changes to the number of weight patches via the detail panel, so that we can initialize the "owner" pointer when patches are added or trigger update when patches are removed.
Protected variable UProperty int32 ResolutionX  
Protected variable UProperty int32 ResolutionY  
Protected variable UProperty Category, EditAnywhere, Meta FVector2D UnscaledPatchCoverage At scale 1.0, the X and Y of the region affected by the height patch.
Protected variable UProperty Category editinstanceonly, instanced TArray< TObjectPtr< ULandscapeWeightPatchTextureInfo > > WeightPatches Weight patches.
Protected variable UProperty Category, EditAnywhere ELandscapeTextureHeightPatchZeroHeightMeaning ZeroHeightMeaning How 0 height is interpreted.

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category 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.
Public function Virtual UFunction BlueprintCallable, Category void

ClearWeightPatchBlendModeOverride ( const FName& InWeightmapLayerName
)

  
Public function Virtual UFunction BlueprintCallable, Category void Sets the soure mode of all weight patches to "None".
Public function UFunction BlueprintCallable, Category TArray< FName >  
Public function Virtual Const UFunction BlueprintCallable, Category FVector2D 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).
Public function UTexture2D * These need to be public so that we can take the internal textures and write them to external ones, but unclear whether we want to expose them to blueprints, since this is a fairly internal thing.
Public function Virtual UFunction BlueprintCallable, Category UTextureRenderTarget2D *

GetHeightRenderTarget ( bool bMarkDirty
)

 Gets the internal height render target, if source mode is set to Texture Backed Render Target.
Public function Virtual Const UFunction BlueprintCallable, Category ELandscapeTexturePatchSourceMode  
Public function Virtual Const UFunction BlueprintCallable, Category, Meta bool

GetInitResolutionFromLandscape ( float ResolutionMultiplier,
FVector2D& ResolutionOut
)

 Given the landscape resolution, current patch coverage, and a landscape resolution multiplier, gives the needed resolution of the landscape patch.
Public function Virtual Const UFunction BlueprintCallable, Category FTransform Gets the transform from patch to world.
Public function Virtual Const UFunction BlueprintCallable, Category FVector2D Gets the size (in pixels) of the internal textures used by the patch.
Public function Virtual Const UFunction BlueprintCallable, Category FVector2D Gives size in unscaled world coordinates (ie before applying patch transform) of the patch as measured between the centers of the outermost pixels.
Public function UTexture2D *

GetWeightPatchInternalTexture ( const FName& InWeightmapLayerName
)

  
Public function Virtual UFunction BlueprintCallable, Category UTextureRenderTarget2D *

GetWeightPatchRenderTarget ( const FName& InWeightmapLayerName
)

  
Public function Virtual UFunction BlueprintCallable, Category ELandscapeTexturePatchSourceMode

GetWeightPatchSourceMode ( const FName& InWeightmapLayerName
)

  
Protected function UFunction Category callineditor void Given the current initialization settings, reinitialize the height patch.
Protected function UFunction Category callineditor void  
Public function Virtual UFunction BlueprintCallable, Category void  
Public function Virtual UFunction BlueprintCallable, Category void

RemoveWeightPatch ( const FName& InWeightmapLayerName
)

  
Public function UFunction BlueprintCallable, Category void Just like SetSourceEncodingMode, but resets ZeroInEncoding, WorldSpaceEncodingScale, and height render target format to mode-specific defaults.
Public function UFunction BlueprintCallable, Category void Determines how the height patch is blended into the existing terrain.
Public function Virtual UFunction BlueprintCallable, Category void

SetEditVisibilityLayer ( const FName& InWeightmapLayerName,
const bool bEditVisibilityLayer
)

  
Public function UFunction BlueprintCallable, Category void

SetFalloff ( float FalloffIn
)

  
Public function UFunction BlueprintCallable, Category void Set the height encoding mode for the patch, which determines how stored values in the patch are translated into heights when applying to landscape.
Public function UFunction BlueprintCallable, Category void Set settings that determine how values in the patch are translated into heights.
Public function UFunction BlueprintCallable, Category, Meta void

SetHeightRenderTargetFormat ( ETextureRenderTargetFormat Format
)

  
Public function Virtual UFunction BlueprintCallable, Category void Changes source mode.
Public function UFunction BlueprintCallable, Category void Sets the texture used for height when the height source mode is set to texture asset.
Public function Virtual UFunction BlueprintCallable, Category void

SetResolution ( FVector2D ResolutionIn
)

 Sets the resolution of the currently used internal texture or render target.
Public function Virtual UFunction BlueprintCallable, Category void

SetUnscaledCoverage ( FVector2D Coverage
)

 Set the patch coverage (see GetUnscaledCoverage for description).
Public function UFunction BlueprintCallable, Category void Determines whether the height patch alpha channel is used for blending into the existing values.
Public function Virtual UFunction BlueprintCallable, Category void

SetUseAlphaChannelForWeightPatch ( const FName& InWeightmapLayerName,
bool bUseAlphaChannel
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetWeightPatchBlendModeOverride ( const FName& InWeightmapLayerName,
ELandscapeTexturePatchBlendMode BlendMode
)

  
Public function Virtual UFunction BlueprintCallable, Category void

SetWeightPatchSourceMode ( const FName& InWeightmapLayerName,
ELandscapeTexturePatchSourceMode NewMode
)

  
Public function UFunction BlueprintCallable, Category void

SetWeightPatchTextureAsset ( const FName& InWeightmapLayerName,
UTexture* TextureIn
)

  
Public function UFunction BlueprintCallable, Category void Set how zero height is interpreted, see comments in ELandscapeTextureHeightPatchZeroHeightMeaning.
Protected function UFunction BlueprintCallable, Category callineditor void 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.

Overridden from ULandscapePatchComponent

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool

AffectsWeightmapLayer ( const FName& InLayerName
)

  
Public function Virtual Const bool  
Public function Virtual UTextureRenderTarget2D *  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 UObject.

Deprecated Functions

  Type Name Description
Public function Virtual Const bool

IsAffectingWeightmapLayer ( const FName& InLayerName
)

 Use AffectsWeightmapLayer

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page