Navigation
API > API/Plugins > API/Plugins/Water
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&40;ClassGroup&61;&40;Rendering, Water&41;,
HideCategories&61;&40;Object, Activation, "Components&124;Activation", Collision, Lighting, HLOD, Navigation, Replication, Input, MaterialParameters, TextureStreaming&41;,
EditInlineNew&41;
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 | |
|---|---|---|---|
| TObjectPtr< UMaterialInterface > | 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. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| FIntPoint | |||
| float | GetLODScale () |
||
| int32 | |||
| float | GetTileSize () |
||
| const TSet< TObjectPtr< UMaterialInterface > > & | |||
| FMaterialRelevance | GetWaterMaterialRelevance
(
ERHIFeatureLevel::Type InFeatureLevel |
Use this instead of GetMaterialRelevance, since this one will go over all materials from all tiles | |
| const FWaterQuadTree & | |||
| bool | IsEnabled () |
||
| void | |||
| void | PushTessellatedWaterMeshBoundsToPoxy
(
const FBox2D& TessellatedWaterMeshBounds |
||
| void | SetExtentInTiles
(
FIntPoint NewExtentInTiles |
||
| void | SetTileSize
(
float NewTileSize |
||
| void | Update () |
Overridden from UPrimitiveComponent
| Type | Name | Description | |
|---|---|---|---|
| void | CollectPSOPrecacheData
(
const FPSOPrecacheParams& BasePrecachePSOParams, |
||
| FPrimitiveSceneProxy * | Creates a proxy to represent the primitive to the scene manager in the rendering thread. | ||
| int32 | Return number of material elements in this primitive | ||
| void | GetUsedMaterials
(
TArray< UMaterialInterface* >& OutMaterials, |
Retrieves the materials used in this component | |
| void | SetMaterial
(
int32 ElementIndex, |
Changes the material applied to an element of the mesh. | |
| bool | Return true if the owner is selected and this component is selectable |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | 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. |
Overridden from INavRelevantInterface
| Type | Name | Description | |
|---|---|---|---|
| bool | Are modifiers active? |