Version: 4.1.0
IdleState
⚠️ This class is for internal use only.
A default state when there's no user input and no animation's playing
#
Properties#
holdingWhether user is clicking or touching
Type: false
#
animatingWhether Flicking's animating
Type: false
#
Methods#
onHoldAn event handler for Axes's hold event
Returns: void
PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
---|---|---|---|---|
ctx | object | yes | Event context | |
ctx.flicking | Flicking | yes | An instance of Flicking | |
ctx.axesEvent | object | yes | A hold event of Axes | |
ctx.transitTo | function | yes | A function for changing current state to other state |
#
onChangeAn event handler for Axes's change event
Returns: void
PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
---|---|---|---|---|
ctx | object | yes | Event context | |
ctx.flicking | Flicking | yes | An instance of Flicking | |
ctx.axesEvent | object | yes | A change event of Axes | |
ctx.transitTo | function | yes | A function for changing current state to other state |
#
onReleaseAn event handler for Axes's release event
Returns: void
PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
---|---|---|---|---|
ctx | object | yes | Event context | |
ctx.flicking | Flicking | yes | An instance of Flicking | |
ctx.axesEvent | object | yes | A release event of Axes | |
ctx.transitTo | function | yes | A function for changing current state to other state |
#
onAnimationEndAn event handler for Axes's animationEnd event
Returns: void
PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
---|---|---|---|---|
ctx | object | yes | Event context | |
ctx.flicking | Flicking | yes | An instance of Flicking | |
ctx.axesEvent | object | yes | A animationEnd event of Axes | |
ctx.transitTo | function | yes | A function for changing current state to other state |
#
onFinishAn event handler for Axes's finish event
Returns: void
PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
---|---|---|---|---|
ctx | object | yes | Event context | |
ctx.flicking | Flicking | yes | An instance of Flicking | |
ctx.axesEvent | object | yes | A finish event of Axes | |
ctx.transitTo | function | yes | A function for changing current state to other state |