Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nailuj05/FusionWater
A simple way to add buoyancy / water physics in Unity, built on the existing physics engine
https://github.com/nailuj05/FusionWater
buoyancy game physics water
Last synced: 3 months ago
JSON representation
A simple way to add buoyancy / water physics in Unity, built on the existing physics engine
- Host: GitHub
- URL: https://github.com/nailuj05/FusionWater
- Owner: nailuj05
- License: mit
- Created: 2021-09-05T12:36:35.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-12T16:45:28.000Z (over 2 years ago)
- Last Synced: 2024-04-22T08:36:17.464Z (7 months ago)
- Topics: buoyancy, game, physics, water
- Language: C#
- Homepage:
- Size: 31.7 MB
- Stars: 268
- Watchers: 8
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# FusionWater
A simple way to add buoyancy / water physics in Unity, built on the existing physics engine.
This package can be downloaded from the releases section and dragged into any Unity Project to install.
There are Shaders/Materials provided for both URP and Standard RP.
## Setup Guide
Add the ```Fluid.cs``` to your water (or any fluids) plane, be sure to have a collider for the volume setup, add a ```FluidInteractor``` to all your objects, that you want to be affected.
### The Base Fluid Interactor
This class can and should NOT be used as a component, as it has no actual code, that gets executed and is only internal.
```BaseFluidInteractor.cs```, not to be confused with ```BasicFluidInteractor.cs```, is the base class all FluidInteractors should derive from the BaseFluidInteractor, as it handles entering/exiting a fluid and calls the ```FluidUpdate()``` function. Global Functions, that are needed on all FluidInteractors, like the Turbulence Functions, are also defined here.
The BaseFluidInteractor also defines the basic settings all Interactors inherit. Those are
```
- Custom Volume: Used to set a custom volume. 0 means the volume will be calculated using the colliders
- Dampening Factor: The dampening applied to the object
- Simulate Water Turbulence: Adds random disturbence forces generated from perlin noise
- Turbulence Strength: The strength of the applied forces
- Float Strength: Use this for changing the buoyant force without changing the mass
```
### The Basic Fluid Interactor
```BasicFluidInteractor.cs``` this is the simplest and easiest FluidInteractor. It calculates everything from the center of the objects, this can cause weird behaviours with more streched out objects, like a wooden plank for example. There for it is great for smaller objects, backgroud props, cuboids and spheres. Using the simulated turbulence you can easily add some slight movement, so your objects float, rotate and move a bit and aren't just staying "frozen" after a while.
### The Complex Fluid Interactor
```ComplexFluidInteractor.cs``` this a more complex FluidInteractor to get a more realistic/belivable result, especially with larger, more complex objects. This is great for boats, ships, large debris or long wooden planks ;). Instead of calulating the buoyant forces for the center of an object, the ComplexFluidInteractor calculates it for multiple points, that can be placed on your object. Those "floaters" calculate their buoyant forces based on their own submergance and then apply it on the main objects rigidbody at the according position.
This allows one to place floaters on the edges of a longer object or along the hull of a ship to better model its submerged volume and buoyancy.
In the Unity Editor the floaters can be automatically placed at the corners of the colliders bounding box or placed manually. A floater is nothing more than an empty gameobject, that is added to the ComplexFluidInteractors ```Floaters``` List. The floaters are drawn as spheres in the scene view, green if in air, red if submerged.
