Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Water > UWaterMeshComponent

Light Theme

Dark Theme

UWaterMeshComponent

Water Mesh Component responsible for generating and rendering a continuous water mesh on top of all the existing water body actors in the world The component contains a quadtree which defines where there are water tiles.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UMeshComponent

UWaterMeshComponent

References

Module	Water
Header	/Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterMeshComponent.h
Include	#include "WaterMeshComponent.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=(Rendering, Water),
HideCategories=(Object, Activation, "Components|Activation"), EditInlineNew)
class UWaterMeshComponent : public UMeshComponent

Remarks

Water Mesh Component responsible for generating and rendering a continuous water mesh on top of all the existing water body actors in the world The component contains a quadtree which defines where there are water tiles. A function for traversing the quadtree and outputing a list of instance data for each tile to be rendered from a point of view is included

Variables

	Name	Description
FIntPoint	ExtentInTiles	The extent of the system in number of tiles.
UMaterialInterf...	FarDistanceMaterial
float	FarDistanceMeshExtent
int32	ForceCollapseDensityLevel	At above what density level a tile is allowed to force collapse even if not all leaf nodes in the subtree are present.
FVector	RTWorldLocation
FVector	RTWorldSizeVector
float	TileSize	World size of the water tiles at LOD0.

Constructors

	Name	Description
	UWaterMeshComponent()

Functions

	Name	Description
FWaterTileIn...	GetFarDistanceInstanceData()
float	GetLODScale()
int32	GetTessellationFactor()
const TSet< ...	GetUsedMaterialsSet()
FMaterialRel...	GetWaterMaterialRelevance ( ERHIFeatureLevel::Type InFeatureLev... )	Use this instead of GetMaterialRelevance, since this one will go over all materials from all tiles
const FWater...	GetWaterQuadTree()
bool	IsEnabled()
void	MarkWaterMeshGridDirty()
void	SetLandscapeInfo ( const FVector& InRTWorldLocation, const FVector& InRTWorldSizeVector )	HACK [jonathan.bard] (start) : This is to make sure that the RTWorldLocation / RTWorldSizeVector MPC params can be serialized and set at runtime on the Water MPC.
void	Update()

Overridden from UPrimitiveComponent

	Name	Description
FPrimitiveSc...	CreateSceneProxy()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
int32	GetNumMaterials()	Return number of material elements in this primitive
void	GetUsedMaterials ( TArray< UMaterialInterface* > ..., bool bGetDebugMaterials )	Retrieves the materials used in this component
bool	ShouldRenderSelected()	Return true if the owner is selected and this component is selectable

Overridden from UObject

		Name	Description
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss