2021-05-11 18:30:36 -07:00

230 lines
4.7 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[Planck.js API Doc](../README.md) › [Globals](../globals.md) › [Sweep](sweep.md)
# Class: Sweep
This describes the motion of a body/shape for TOI computation. Shapes are
defined with respect to the body origin, which may not coincide with the
center of mass. However, to support dynamics we must interpolate the center
of mass position.
## Hierarchy
* **Sweep**
## Index
### Constructors
* [constructor](sweep.md#constructor)
### Properties
* [a](sweep.md#a)
* [a0](sweep.md#a0)
* [alpha0](sweep.md#alpha0)
* [c](sweep.md#c)
* [c0](sweep.md#c0)
* [localCenter](sweep.md#localcenter)
### Methods
* [advance](sweep.md#advance)
* [clone](sweep.md#clone)
* [forward](sweep.md#forward)
* [getTransform](sweep.md#gettransform)
* [normalize](sweep.md#normalize)
* [set](sweep.md#set)
* [setLocalCenter](sweep.md#setlocalcenter)
* [setTransform](sweep.md#settransform)
## Constructors
### constructor
\+ **new Sweep**(`c?`: [Vec2](vec2.md), `a?`: number): *[Sweep](sweep.md)*
*Defined in [src/common/Sweep.ts:55](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L55)*
**Parameters:**
Name | Type |
------ | ------ |
`c?` | [Vec2](vec2.md) |
`a?` | number |
**Returns:** *[Sweep](sweep.md)*
## Properties
### a
• **a**: *number*
*Defined in [src/common/Sweep.ts:49](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L49)*
World angle
___
### a0
• **a0**: *number*
*Defined in [src/common/Sweep.ts:55](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L55)*
___
### alpha0
• **alpha0**: *number*
*Defined in [src/common/Sweep.ts:52](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L52)*
Fraction of the current time step in the range [0,1], c0 and a0 are c and a at alpha0.
___
### c
• **c**: *[Vec2](vec2.md)*
*Defined in [src/common/Sweep.ts:46](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L46)*
World center position
___
### c0
• **c0**: *[Vec2](vec2.md)*
*Defined in [src/common/Sweep.ts:54](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L54)*
___
### localCenter
• **localCenter**: *[Vec2](vec2.md)*
*Defined in [src/common/Sweep.ts:43](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L43)*
Local center of mass position
## Methods
### advance
▸ **advance**(`alpha`: number): *void*
*Defined in [src/common/Sweep.ts:105](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L105)*
Advance the sweep forward, yielding a new initial state.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`alpha` | number | The new initial time |
**Returns:** *void*
___
### clone
▸ **clone**(): *[Sweep](sweep.md)*
*Defined in [src/common/Sweep.ts:127](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L127)*
**Returns:** *[Sweep](sweep.md)*
___
### forward
▸ **forward**(): *void*
*Defined in [src/common/Sweep.ts:113](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L113)*
**Returns:** *void*
___
### getTransform
▸ **getTransform**(`xf`: [Transform](transform.md), `beta`: number): *void*
*Defined in [src/common/Sweep.ts:91](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L91)*
Get the interpolated transform at a specific time.
**Parameters:**
Name | Type | Description |
------ | ------ | ------ |
`xf` | [Transform](transform.md) | - |
`beta` | number | A factor in [0,1], where 0 indicates alpha0 |
**Returns:** *void*
___
### normalize
▸ **normalize**(): *void*
*Defined in [src/common/Sweep.ts:121](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L121)*
normalize the angles in radians to be between -pi and pi.
**Returns:** *void*
___
### set
▸ **set**(`that`: [Sweep](sweep.md)): *void*
*Defined in [src/common/Sweep.ts:138](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L138)*
**Parameters:**
Name | Type |
------ | ------ |
`that` | [Sweep](sweep.md) |
**Returns:** *void*
___
### setLocalCenter
▸ **setLocalCenter**(`localCenter`: [Vec2](vec2.md), `xf`: [Transform](transform.md)): *void*
*Defined in [src/common/Sweep.ts:77](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L77)*
**Parameters:**
Name | Type |
------ | ------ |
`localCenter` | [Vec2](vec2.md) |
`xf` | [Transform](transform.md) |
**Returns:** *void*
___
### setTransform
▸ **setTransform**(`xf`: [Transform](transform.md)): *void*
*Defined in [src/common/Sweep.ts:68](https://github.com/shakiba/planck.js/blob/acc3bd8/src/common/Sweep.ts#L68)*
**Parameters:**
Name | Type |
------ | ------ |
`xf` | [Transform](transform.md) |
**Returns:** *void*