API Docs for: GoblinPhysics
Show:

DragForce Class

Extends ForceGenerator
Defined in: src\classes\ForceGenerators\DragForce.js:1
Module: Goblin

adds a drag force to associated objects

Constructor

Methods

affect

(
  • object
)

Inherited from ForceGenerator: src\classes\ForceGenerator.js:68

adds an object to be affected by the generator

Parameters:

  • object Mixed

    object to be affected, must have applyForce method

applyForce

()

Inherited from ForceGenerator but overwritten in src\classes\ForceGenerators\DragForce.js:50

applies force to the associated objects

disable

()

Inherited from ForceGenerator: src\classes\ForceGenerator.js:60

disables the force generator

enable

()

Inherited from ForceGenerator: src\classes\ForceGenerator.js:52

enables the force generator

unaffect

(
  • object
)

Inherited from ForceGenerator: src\classes\ForceGenerator.js:85

removes an object from being affected by the generator

Parameters:

  • object Mixed

    object to be affected, must have applyForce method

Properties

affected

Array private

Inherited from ForceGenerator but overwritten in src\classes\ForceGenerators\DragForce.js:36

array of objects affected by the generator

Default: []

drag_coefficient

Number

Defined in src\classes\ForceGenerators\DragForce.js:9

drag coefficient

Default: 0

drag_coefficient

Number

Defined in src\classes\ForceGenerators\DragForce.js:18

drag coefficient

Default: 0

enabled

Boolean

Inherited from ForceGenerator but overwritten in src\classes\ForceGenerators\DragForce.js:27

whether or not the force generator is enabled

Default: true

force

Vec3

Inherited from ForceGenerator: src\classes\ForceGenerator.js:9

force which will be applied to affected objects

Default: [ 0, 0, 0 ]