1. Epic GamesDeveloper
  3. UWaterMeshComponent

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.

Unreal Engine C++ API Reference > Plugins > Water

Inheritance Hierarchy

References

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

Syntax

UCLASS (ClassGroup=(Rendering, Water),  
       HideCategories=(Object, Activation, "Components|Activation", Collision, Lighting, HLOD, Navigation, Replication, Input, MaterialParameters, TextureStreaming),  
       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

  Type Name Description
Public variable UProperty Category, EditAnywhere TObjectPtr< UMaterialInterface > FarDistanceMaterial  
Public variable UProperty Category, EditAnywhere, Meta float FarDistanceMeshExtent  
Public variable UProperty Category, EditAnywhere, Meta 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.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const FVector2D  
Public function Const FIntPoint  
Public function Const float  
Public function Const int32  
Public function Const float  
Public function Const const TSet< TObjectPtr< UMaterialInterface > > &  
Public function Const FMaterialRelevance Use this instead of GetMaterialRelevance, since this one will go over all materials from all tiles
Public function Const const FWaterQuadTree &  
Public function Const UFunction BlueprintPure, Category bool  
Public function void  
Public function void

SetDynamicWaterMeshCenter ( const FVector2D& NewCenter
)

  
Public function void

SetExtentInTiles ( FIntPoint NewExtentInTiles
)

  
Public function void

SetTileSize ( float NewTileSize
)

  
Public function void

Update ()

  

Overridden from UPrimitiveComponent

  Type Name Description
Public function Virtual void Collect all the data required for PSO precaching
Public function Virtual FPrimitiveSceneProxy * Creates a proxy to represent the primitive to the scene manager in the rendering thread.
Public function Virtual Const int32 Return number of material elements in this primitive
Public function Virtual Const void

GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials,
bool bGetDebugMaterials
)

 Retrieves the materials used in this component
Public function Virtual void

SetMaterial ( int32 ElementIndex,
UMaterialInterface* Material
)

 Changes the material applied to an element of the mesh.
Public function Virtual Const bool Return true if the owner is selected and this component is selectable

Overridden from UActorComponent

  Type Name Description
Public function Virtual Const bool Override to specify that a component is relevant to the navigation system

Overridden from UObject

  Type Name Description
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page