UWaterModifier

Base MegaMeshModifierComponent for all Water-MegaMesh interactions.

API > API/Plugins > API/Plugins/MeshPartitionWater

Base MegaMeshModifierComponent for all Water-MegaMesh interactions.

   
Name UWaterModifier
Type class
Header File /Engine/Plugins/Experimental/MeshPartitionWater/Source/MeshPartitionWater/Public/MeshPartitionWaterModifier.h
Include Path #include "MeshPartitionWaterModifier.h"

Syntax

UCLASS (MinimalAPI, Abstract, Meta=(BlueprintSpawnableComponent))  
class UWaterModifier : public UE::MeshPartition::UModifierComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UWaterModifier()

   MeshPartitionWaterModifier.h  

Constants

Name Type Remarks Include Path
InternalWaterWeightChannelName FName Name of the weight channel used to pass height blend info between overlapping water modifiers MeshPartitionWaterModifier.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsEnabled()

   MeshPartitionWaterModifier.h  

void SetMaxZDistance ( const double InMaxZDistance
)

   MeshPartitionWaterModifier.h  

Public Virtual

Overridden from UModifierComponent

Name Remarks Include Path Unreal Specifiers

virtual TArray< FBox > ComputeBounds()

 Begin MeshPartition::UModifierComponent Implementation. MeshPartitionWaterModifier.h  

virtual void PostProcessSection ( AActor* InSection
)

   MeshPartitionWaterModifier.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CheckForErrors()

   MeshPartitionWaterModifier.h  

virtual void OnRegister()

 USceneComponent Implementation. MeshPartitionWaterModifier.h  

virtual void OnUnregister()

   MeshPartitionWaterModifier.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

 UObject. MeshPartitionWaterModifier.h  

Protected

Name Remarks Include Path Unreal Specifiers

AWaterBody * GetWaterBodyActor()

 Utilities functions to retrieve water components from the parent water body actor MeshPartitionWaterModifier.h  

UWaterBodyComponent * GetWaterBodyComponent()

   MeshPartitionWaterModifier.h  

UWaterSplineComponent * GetWaterSpline()

   MeshPartitionWaterModifier.h  

void OnWaterBodyChanged ( const IWaterBrushActorInterface::FWaterBrushActorChangedEventParams& OnBrushActorChanged
)

   MeshPartitionWaterModifier.h  

Static

Name Remarks Include Path Unreal Specifiers

static float CalculateVertexFalloffHeight ( float& InOutInternalBlendWeight,
bool bIsInside,
float WaterHeight,
float DistanceFromSpline,
float TargetHeight,
float MeshZ,
const FWaterBodyHeightmapSettings& HeightmapSettings,
const FWaterCurveSettings& CurveSettings
)

   MeshPartitionWaterModifier.h  

static float CalculateVertexWeight ( bool bIsInside,
float DistanceFromSpline,
const FWaterBodyWeightmapSettings& WeightmapSettings
)

 Helper to calculate basic weightmap alpha (not accounting for ModulationTexture) MeshPartitionWaterModifier.h  

static void RegisterWaterWeightmaps ( const TMap< FName, FWaterBodyWeightmapSettings >& WeightMaps,
FInstanceInfo& Instance
)

 Helper to register water weightmaps MeshPartitionWaterModifier.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page