Version: Unity 6.6 Alpha (6000.6)
LanguageEnglish
  • C#

PhysicsWorld.ApplyBuoyancy

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void ApplyBuoyancy(PhysicsAABB aabb, BuoyancyInput input, float deltaTime);

Parameters

Parameter Description
aabb The world-space axis-aligned box describing the fluid volume. Only shapes whose broadphase AABB overlaps this box are processed.
input The fluid and force configuration. See BuoyancyInput.
deltaTime The simulation step duration in seconds. Used to clamp damping so it cannot overshoot in a single step.

Description

Apply buoyancy, flow and damping forces to every dynamic body shape that overlaps in this world. The same BuoyancyInput is applied to all overlapping shapes. Shapes whose body is not PhysicsBody.BodyType.Dynamic are silently skipped. Forces and torques are continuous (not impulses), so this is expected to be called every simulation step.