AxesController
class AxesController
@egjs/axes의 이벤트를 처리하는 컨트롤러 컴포넌트
Properties
axes
Axes의 인스턴스
Type: Axes | null
See:
panInput
PanInput의 인스턴스
Type: PanInput | null
See:
stateMachine
state
현재 활성화된 State 인스턴스로 사용자 입력 또는 애니메이션 상태를 나타냅니다
Type: State
animatingContext
현재 재생중인 애니메이션 정보
Type: object
| PROPERTY | TYPE | DESCRIPTION |
|---|---|---|
| start | number | 애니메이션 시작 지점 |
| end | number | 애니메이션 끝 지점 |
| offset | number | 카메라 오프셋 |
controlParams
활성화된 현재 Axes 패러미터들
Type: ControlParams
Returns: ControlParams
enabled
현재 사용자 입력이 활성화되었는지를 나타내는 값
Type: boolean
position
Axes 인스턴스 내부의 현재 좌표 값
Type: number
range
Axes 인스턴스 내부의 현재 이동 범위 값
Type: Array<number>
bounce
적용된 bounce 크기(px 단위)
Type: Array<number>
Methods
init
AxesController를 초기화합니다
Returns: this
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| flicking | Flicking | An instance of Flicking |
destroy
AxesController를 초기 상태로 되돌립니다
Returns: void
enable
사용자의 입력(마우스/터치)를 활성화합니다
Returns: this
disable
사용자의 입력(마우스/터치)를 막습니다
Returns: this
release
사용자의 현재 입력(마우스/터치)를 중단시킵니다
Returns: this
updateAnimation
재생 중인 애니메이션의 목적지와 재생 시간을 변경합니다
Returns: this
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| position | number | 이동할 좌표 | ||
| duration | number | ✔️ | 애니메이션 진행 시간 (단위: ms) |
stopAnimation
재생 중인 애니메이션을 중단시킵니다
Returns: this
update
@egjs/axes의 상태를 갱신합니다
Returns: this
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| controlParams | ControlParams |
Throws: FlickingError
init이 이전에 호출되지 않은 경우
addPreventClickHandler
카메라 엘리먼트에 애니메이션 도중에 클릭 이벤트를 방지하는 핸들러를 부착합니다
Returns: this
removePreventClickHandler
카메라 엘리먼트에 애니메이션 도중에 클릭 이벤트를 방지하는 핸들러를 탈착합니다
Returns: this
animateTo
Axes의 setTo 메소드를 주어진 좌표를 이용하여 수행합니다
Returns: Promise<void>
- 해당 좌표 도달시에 resolve되는 Promise
| PARAMETER | TYPE | OPTIONAL | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| position | number | 이동할 좌표 | ||
| duration | number | 애니메이션 진행 시간 (단위: ms) | ||
| axesEvent | number | ✔️ | 이 값이 주어졌을 경우, 해당 이벤트의 setTo 메소드를 대신해서 사용합니다. |
Throws: FlickingError
|code|condition|
|---|---|
|[NOT_ATTACHED_TO_FLICKING](ERROR_CODE)|[init](Control#init)이 이전에 호출되지 않은 경우|
|[ANIMATION_INTERRUPTED](ERROR_CODE)|사용자 입력에 의해 애니메이션이 중단된 경우|