nape.dynamics.FluidArbiter

Fluid interaction subtype for Arbiter.

Constructor

`new()`

@private

Variables

`overlap:Float`

Overlap area of Shapes in fluid interaction.

This value is strictly positive, and represents the amount of overlap between the Shapes used in buoyancy computations.

This value can be modified during a related PreListener handler.

`position:Vec2`

Centre of buoyancy for fluid interaction.

This value can be modified during a related PreListener handler.

Methods

`@:value({ body : null })buoyancyImpulse(?body:Body):Vec3`

Determine impulse on a given body due to buoyancy.

If the body is null, then the buoyancy impulse will be returned without consideration to any specific body involved, and no angular impulses can be derived.

Parameters:

`body`	The body to query impulse for. (default null)

Returns:

The buoyancy impulse for given body.

Throws:

`#`	If body is non-null, and unrelated to this Arbiter.

`@:value({ body : null })dragImpulse(?body:Body):Vec3`

Determine impulse on a given body due to fluid drag.

If the body is null, then the drag impulse will be returned without consideration to any specific body involved.

Parameters:

`body`	The body to query impulse for. (default null)

Returns:

The drag impulse for given body.

Throws:

`#`	If body is non-null, and unrelated to this Arbiter.

`@:value({ freshOnly : false, body : null })totalImpulse(?body:Body, freshOnly:Bool = false):Vec3`

Determine total impulse on a given body due to fluid interaction.

If the body is null, then the total impulse will be computed without consideration to any specific body involved, and no angular impulses can be derived for the linear portion of the impulses.

Parameters:

`body`	The body to query impulse for. (default null)
`freshOnly`	This parameter is unused for FluidArbiters. (default false)

Returns:

The total impulse for given body.

Throws:

`#`	If body is non-null, and unrelated to this Arbiter.

final class FluidArbiter

package nape.dynamics

extends Arbiter

Constructor

`new()`

Variables

`overlap:Float`

`position:Vec2`

Methods

`@:value({ body : null })buoyancyImpulse(?body:Body):Vec3`

`@:value({ body : null })dragImpulse(?body:Body):Vec3`

`@:value({ freshOnly : false, body : null })totalImpulse(?body:Body, freshOnly:Bool = false):Vec3`

Inherited Variables

Defined by Arbiter

`read onlybody1:Body`

`read onlybody2:Body`

`read onlycollisionArbiter:Null<CollisionArbiter>`

`read onlyfluidArbiter:Null<FluidArbiter>`

`read onlyisSleeping:Bool`

`read onlyshape1:Shape`

`read onlyshape2:Shape`

`read onlystate:PreFlag`

`read onlytype:ArbiterType`

`@:value(null)zpp_inner:ZPP_Arbiter = null`

Inherited Methods

Defined by Arbiter

`inlineisCollisionArbiter():Bool`

`inlineisFluidArbiter():Bool`

`inlineisSensorArbiter():Bool`

`@:keeptoString():String`