Spring
This content is not available in your language yet.
Defined in: packages/core/src/utils/spring.ts:14
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Spring(currentPosition?): Spring;Defined in: packages/core/src/utils/spring.ts:33
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:53
Returns
Section titled “Returns”boolean
getCurrentPosition()
Section titled “getCurrentPosition()”getCurrentPosition(): number;Defined in: packages/core/src/utils/spring.ts:136
Returns
Section titled “Returns”number
setPosition()
Section titled “setPosition()”setPosition(targetPosition): void;Defined in: packages/core/src/utils/spring.ts:62
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:111
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
targetPosition |
number |
undefined |
delay |
Duration |
Duration.ZERO |
Returns
Section titled “Returns”void
update()
Section titled “update()”update(delta?): void;Defined in: packages/core/src/utils/spring.ts:69
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
delta |
Duration |
Duration.ZERO |
Returns
Section titled “Returns”void
updateParams()
Section titled “updateParams()”updateParams(params, delay?): void;Defined in: packages/core/src/utils/spring.ts:91
Parameters
Section titled “Parameters”| Parameter | Type | Default value |
|---|---|---|
params |
Partial<SpringParams> |
undefined |
delay |
Duration |
Duration.ZERO |
Returns
Section titled “Returns”void