Constructor
new Box2dDistanceJoint(objectA, objectB, anchorA, anchorB, collideopt)
Create a distance joint
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
objectA | Box2dObject | |||
objectB | Box2dObject | |||
anchorA | Vector2 | |||
anchorB | Vector2 | |||
collide | boolean | <optional> | false |
- Source
Extends
- Box2dJoint
Methods
getDampingRatio() → {number}
Get the damping ratio
- Source
Returns:
- Type:
- number
getFrequency() → {number}
Get the frequency in Hertz
- Source
Returns:
- Type:
- number
getLength() → {number}
Get the length of the joint
- Source
Returns:
- Type:
- number
getLocalAnchorA() → {Vector2}
Get the local anchor point relative to objectA's origin
- Source
Returns:
- Type:
- Vector2
getLocalAnchorB() → {Vector2}
Get the local anchor point relative to objectB's origin
- Source
Returns:
- Type:
- Vector2
setDampingRatio(ratio)
Set the damping ratio
Parameters:
| Name | Type | Description |
|---|---|---|
ratio | number |
- Source
setFrequency(hz)
Set the frequency in Hertz
Parameters:
| Name | Type | Description |
|---|---|---|
hz | number |
- Source
setLength(length)
Set the length of the joint
Parameters:
| Name | Type | Description |
|---|---|---|
length | number |
- Source