Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Crest Water
Light Logo Dark Logo

About

  • Introduction
  • Integrations
  • Known Issues
  • Release Notes

Manual

  • Getting Started
    • Requirements
    • Installation
    • Migration
    • Samples
    • Usage Guide
    • Quick Start
  • Basics
    • Underwater
    • Water Inputs
    • Water Exclusion
    • Water Bodies
    • Floating Objects
    • Events
  • Appearance
    • Albedo
    • Bioluminescence
    • Color
    • Foam
    • Lighting
    • Reflections
    • Shadows
    • Stylization
  • Simulation
    • Animated Waves
    • Dynamic Waves
    • Water Level
    • Shorelines & Shallows
    • Flow
  • Advanced
    • Level of Detail
    • Local Overrides
    • Queries
    • Multiplayer
    • Time Control
    • Open Worlds
    • Rendering
    • Scripting
    • Integrations
  • Guides
    • Platforms
    • Performance Guide
    • Rendering Notes
    • System Notes
  • Frequently Asked Questions

Packages

  • CPU Queries
    • Introduction
    • Release Notes
    • CPU Queries
  • Paint
    • Introduction
    • Release Notes
    • Paint
  • Portals
    • Introduction
    • Release Notes
    • Portals & Volumes
  • Shallow Water
    • Introduction
    • Release Notes
    • Shallow Water Simulation
    • Shoreline Simulation
    • Stream Simulation
  • Shifting Origin
    • Introduction
    • Release Notes
    • Shifting Origin
  • Splines
    • Introduction
    • Release Notes
    • Splines
  • Whirlpool
    • Introduction
    • Release Notes
    • Whirlpool

Components

  • Inputs
    • Absorption Input
    • Albedo Input
    • Animated Waves Input
    • Clip Input
    • Depth Probe
    • Dynamic Waves Input
    • Flow Input
    • Foam Input
    • Scattering Input
    • Shadow Input
    • Shallow Water Simulation
    • Shape FFT
    • Shape Gerstner
    • Sphere Water Interaction
    • Water Depth Input
    • Water Level Input
    • Watertight Hull
    • Whirlpool
  • Physics
    • Floating Object
    • Watercraft Control (Constant)
    • Watercraft Controller
  • Spline
    • Absorption Spline Point Data
    • Flow Spline Point Data
    • Foam Spline Point Data
    • Scattering Spline Point Data
    • Spline
    • Spline Point
    • Waves Spline Point Data
  • System
    • Local Override
    • Query Events
    • Shifting Origin
    • Water Camera
    • Water Renderer
  • Time
    • Custom Time Provider
    • Cutscene Time Provider
    • Networked Time Provider

Assets

  • Data
    • Wave Spectrum
  • Simulation Settings
    • Dynamic Waves Settings
    • Foam Settings

Scripting

  • Crest
    • AbsorptionLod
    • AbsorptionLodInput
    • AbsorptionRendererLodInputData
    • AbsorptionTextureLodInputData
    • AlbedoLod
    • AlbedoLodInput
    • AlbedoRendererLodInputData
    • AnimatedWavesLod
    • AnimatedWavesLodInput
    • AnimatedWavesRendererLodInputData
    • ClipLod
    • ClipLodInput
    • ClipRendererLodInputData
    • ClipTextureLodInputData
    • CollisionLayer
    • CollisionLayers
    • CollisionSource
    • ColorLod
    • Control
    • Controller
    • CustomTimeProvider
    • CutsceneTimeProvider
    • DefaultClippingState
    • DepthGeometryLodInputData
    • DepthLod
    • DepthLodInput
    • DepthProbe
    • DepthProbeMode
    • DepthProbeRefreshMode
    • DepthRendererLodInputData
    • DepthTextureLodInputData
    • DirectionalTextureLodInputData
    • DisplacementPass
    • DynamicWavesLod
    • DynamicWavesLodInput
    • DynamicWavesLodSettings
    • DynamicWavesRendererLodInputData
    • FixedControl
    • FloatingObject
    • FloatingObjectModel
    • FloatingObjectProbe
    • FlowLod
    • FlowLodInput
    • FlowRendererLodInputData
    • FlowTextureLodInputData
    • FoamLod
    • FoamLodInput
    • FoamLodSettings
    • FoamRendererLodInputData
    • FoamTextureLodInputData
    • GeometryLodInputData
    • ICollisionProvider
    • IDepthProvider
    • IFlowProvider
    • IQueryProvider
    • ITimeProvider
    • LevelGeometryLodInputData
    • LevelLod
    • LevelLodInput
    • LevelRendererLodInputData
    • LevelTextureLodInputData
    • Lod
    • Lod<T>
    • LodInput
    • LodInputBlend
    • LodInputData
    • LodInputMode
    • LodInputPrimitive
    • LodQuerySource
    • LodSettings
    • LodTextureFormatMode
    • Meniscus
    • NetworkedTimeProvider
    • PersistentLod
    • Placement
    • PortalMode
    • PortalRenderer
    • QualitySettingsOverride
    • QueryEvents
    • QuerySource
    • RayCastHelper
    • RendererLodInputData
    • SampleCollisionHelper
    • SampleDepthHelper
    • SampleFlowHelper
    • ScatteringLod
    • ScatteringLodInput
    • ScatteringRendererLodInputData
    • ScatteringTextureLodInputData
    • ShadowLod
    • ShadowLodInput
    • ShadowRendererLodInputData
    • ShapeFFT
    • ShapeGerstner
    • ShapeWaves
    • ShapeWavesRendererLodInputData
    • ShapeWavesTextureLodInputData
    • ShorelineVolumeColorSource
    • SphereWaterInteraction
    • SurfaceRenderer
    • TextureLodInputData
    • TimeProvider
    • UnderwaterRenderer
    • WaterBody
    • WaterBodyAffects
    • WaterBodyExclusion
    • WaterCamera
    • WaterCameraExclusion
    • WaterDataBackgroundMode
    • WaterInjectionPoint
    • WaterReflectionSide
    • WaterReflections
    • WaterRenderer
    • WatertightHull
    • WatertightHullMode
    • WaveSampling
    • WaveSpectrum
  • Crest.Whirlpool
    • Whirlpool
  • Crest.Splines
    • AbsorptionSplineLodInputData
    • AbsorptionSplinePointData
    • FlowSplineLodInputData
    • FlowSplinePointData
    • FoamSplineLodInputData
    • FoamSplinePointData
    • LevelSplineLodInputData
    • ScatteringSplineLodInputData
    • ScatteringSplinePointData
    • ShapeWavesSplineLodInputData
    • Spline
    • SplineLodInputData
    • SplineOffset
    • SplinePoint
    • SplinePointData
    • WavesSplinePointData
  • Crest.ShiftingOrigin
    • ShiftingOrigin
  • Crest.ShallowWater
    • ShallowWaterSimulation
    • ShallowWaterSimulationInjection
    • ShallowWaterSimulationMode
    • ShallowWaterSimulationPreset
  • Crest.Scripting
    • Extensions
Back to top

WatertightHull¶

Class in WaveHarmonic.Crest, WaveHarmonic.Crest

Switch To Manual

Removes water from a provided hull using the clip simulation.

Members¶

Properties¶

ClipScale

Scales the clip input.

Inverted

Inverts the effect to remove clipping (ie add water).

Mesh

The convex hull to keep water out.

Mode

Which mode to use.

Queue

Order this input will render.

UseClipWithDisplacement

Whether to also to clip the surface when using displacement mode.

Next
WatertightHullMode
Previous
WaterRenderer
On this page
  • WatertightHull
    • Members
      • Properties
Copyright © 2024, Wave Harmonic