Navigation
API > API/Plugins > API/Plugins/Water
References
| Module | Water |
| Header | /Engine/Plugins/Experimental/Water/Source/Runtime/Public/WaterBodyTypes.h |
| Include | #include "WaterBodyTypes.h" |
Syntax
enum EWaterBodyQueryFlags
{
None = 0,
ComputeLocation = (1 << 0),
ComputeNormal = (1 << 1),
ComputeVelocity = (1 << 2),
ComputeDepth = (1 << 3),
ComputeImmersionDepth = (1 << 4),
IncludeWaves = (1 << 5),
SimpleWaves = (1 << 6),
IgnoreExclusionVolumes = (1 << 7),
}
Values
| Name | Description |
|---|---|
| None | |
| ComputeLocation | Computes the location on the water plane (+ optionally the location on the water surface if IncludeWaves is passed) |
| ComputeNormal | Computes the normal on the water plane (+ optionally the normal on the water surface if IncludeWaves is passed) |
| ComputeVelocity | Computes the water velocity |
| ComputeDepth | Compute the water depth |
| ComputeImmersionDepth | Computes the how much under the water surface the point is (implies ComputeLocation) : > 0 if underwater |
| IncludeWaves | Includes waves in water depth computation (requires ComputeLocation or ComputeNormal or ComputeDepth or ComputeImmersionDepth) |
| SimpleWaves | Use simple version of waves computation (requires IncludeWaves) |
| IgnoreExclusionVolumes | Ignore the water exclusion volumes (it is expected to check for IsInExclusionVolume() when not using this flag as the returned information will be invalid) |