Spring
Defined in: packages/core/src/utils/spring.ts:13
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Spring(currentPosition?): Spring;Defined in: packages/core/src/utils/spring.ts:32
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
currentPosition | number | 0 |
Returns
Section titled “Returns”Spring
Methods
Section titled “Methods”arrived()
Section titled “arrived()”arrived(): boolean;Defined in: packages/core/src/utils/spring.ts:52
Returns
Section titled “Returns”boolean
getCurrentPosition()
Section titled “getCurrentPosition()”getCurrentPosition(): number;Defined in: packages/core/src/utils/spring.ts:118
Returns
Section titled “Returns”number
setPosition()
Section titled “setPosition()”setPosition(targetPosition): void;Defined in: packages/core/src/utils/spring.ts:61
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
targetPosition | number |
Returns
Section titled “Returns”void
setTargetPosition()
Section titled “setTargetPosition()”setTargetPosition(targetPosition, delay?): void;Defined in: packages/core/src/utils/spring.ts:105
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
targetPosition | number | undefined |
delay | number | 0 |
Returns
Section titled “Returns”void
update()
Section titled “update()”update(delta?): void;Defined in: packages/core/src/utils/spring.ts:68
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
delta | number | 0 |
Returns
Section titled “Returns”void
updateParams()
Section titled “updateParams()”updateParams(params, delay?): void;Defined in: packages/core/src/utils/spring.ts:89
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
params | Partial<SpringParams> | undefined |
delay | number | 0 |
Returns
Section titled “Returns”void