7041786814

Committed 30 Nov 2023 03:53AM UTC coverage: 82.638% (-0.001%) from 82.639%

Build # 7041786814

Build Type

Pull #842

github

Committed by

web-flow

Commit Message

Merge 044b72582 into 346c43abe

Pull Request Pull Request #842: fix: strict movetype moving wrong panel on circular flicking

Run Details

4533 of 7309 branches covered (0.0%)

Branch coverage included in aggregate %.

11 of 11 new or added lines in 3 files covered. (100.0%)

1 existing line in 1 file now uncovered.

11388 of 11957 relevant lines covered (95.24%)

259.32 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

81.45

/src/control/Control.ts

/*
 * Copyright (c) 2015 NAVER Corp.
 * egjs projects are licensed under the MIT license
 */
import { OnRelease } from "@egjs/axes";
import { ComponentEvent } from "@egjs/component";

import Flicking from "../Flicking";
import FlickingError from "../core/FlickingError";
import Panel from "../core/panel/Panel";
import AxesController from "../control/AxesController";
import { DIRECTION, EVENTS } from "../const/external";
import * as ERROR from "../const/error";
import { getDirection, getFlickingAttached } from "../utils";
import { ValueOf } from "../type/internal";

/**
 * A component that manages inputs and animation of Flicking
 * @ko Flicking의 입력 장치 & 애니메이션을 담당하는 컴포넌트
 */
abstract class Control {
  // Internal States
  protected _flicking: Flicking | null;
  protected _controller: AxesController;
  protected _activePanel: Panel | null;
  protected _nextPanel: Panel | null;

  /**
   * A controller that handles the {@link https://naver.github.io/egjs-axes/ @egjs/axes} events
   * @ko {@link https://naver.github.io/egjs-axes/ @egjs/axes}의 이벤트를 처리하는 컨트롤러 컴포넌트
   * @type {AxesController}
   * @readonly
   */
  public get controller() { return this._controller; }
  /**
   * Index number of the {@link Flicking#currentPanel currentPanel}
   * @ko {@link Flicking#currentPanel currentPanel}의 인덱스 번호
   * @type {number}
   * @default 0
   * @readonly
   */
  public get activeIndex() { return this._activePanel?.index ?? -1; }
  /**
   * An active panel
   * @ko 현재 선택된 패널
   * @type {Panel | null}
   * @readonly
   */
  public get activePanel() { return this._activePanel; }
  /**
   * Whether Flicking's animating
   * @ko 현재 애니메이션 동작 여부
   * @type {boolean}
   * @readonly
   */
  public get animating() { return this._controller.state.animating; }
  /**
   * Whether user is clicking or touching
   * @ko 현재 사용자가 클릭/터치중인지 여부
   * @type {boolean}
   * @readonly
   */
  public get holding() { return this._controller.state.holding; }

  /** */
  public constructor() {
    this._flicking = null;
    this._controller = new AxesController();
    this._activePanel = null;
  }

  /**
   * Move {@link Camera} to the given position
   * @ko {@link Camera}를 주어진 좌표로 이동합니다
   * @method
   * @abstract
   * @memberof Control
   * @instance
   * @name moveToPosition
   * @param {number} position The target position to move<ko>이동할 좌표</ko>
   * @param {number} duration Duration of the panel movement animation (unit: ms).<ko>패널 이동 애니메이션 진행 시간 (단위: ms)</ko>
   * @param {object} [axesEvent] {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} event of {@link https://naver.github.io/egjs-axes/ Axes}
   * <ko>{@link https://naver.github.io/egjs-axes/ Axes}의 {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} 이벤트</ko>
   * @fires Flicking#moveStart
   * @fires Flicking#move
   * @fires Flicking#moveEnd
   * @fires Flicking#willChange
   * @fires Flicking#changed
   * @fires Flicking#willRestore
   * @fires Flicking#restored
   * @fires Flicking#needPanel
   * @fires Flicking#visibleChange
   * @fires Flicking#reachEdge
   * @throws {FlickingError}
   * |code|condition|
   * |---|---|
   * |{@link ERROR_CODE POSITION_NOT_REACHABLE}|When the given panel is already removed or not in the Camera's {@link Camera#range range}|
   * |{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}|When {@link Control#init init} is not called before|
   * |{@link ERROR_CODE ANIMATION_INTERRUPTED}|When the animation is interrupted by user input|
   * |{@link ERROR_CODE STOP_CALLED_BY_USER}|When the animation is interrupted by user input|
   * <ko>
   *
   * |code|condition|
   * |---|---|
   * |{@link ERROR_CODE POSITION_NOT_REACHABLE}|주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우|
   * |{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}|{@link Control#init init}이 이전에 호출되지 않은 경우|
   * |{@link ERROR_CODE ANIMATION_INTERRUPTED}|사용자 입력에 의해 애니메이션이 중단된 경우|
   * |{@link ERROR_CODE STOP_CALLED_BY_USER}|발생된 이벤트들 중 하나라도 `stop()`이 호출된 경우|
   *
   * </ko>
   * @return {Promise<void>} A Promise which will be resolved after reaching the target position<ko>해당 좌표 도달시에 resolve되는 Promise</ko>
   */
  public abstract moveToPosition(position: number, duration: number, axesEvent?: OnRelease): Promise<void>;

  /**
   * Initialize Control
   * @ko Control을 초기화합니다
   * @param {Flicking} flicking An instance of {@link Flicking}<ko>Flicking의 인스턴스</ko>
   * @chainable
   * @return {this}
   */
  public init(flicking: Flicking): this {
    this._flicking = flicking;
    this._controller.init(flicking);

    return this;
  }

  /**
   * Destroy Control and return to initial state
   * @ko Control을 초기 상태로 되돌립니다
   * @return {void}
   */
  public destroy(): void {
    this._controller.destroy();

    this._flicking = null;
    this._activePanel = null;
  }

  /**
   * Enable input from the user (mouse/touch)
   * @ko 사용자의 입력(마우스/터치)를 활성화합니다
   * @chainable
   * @return {this}
   */
  public enable(): this {
    this._controller.enable();

    return this;
  }

  /**
   * Disable input from the user (mouse/touch)
   * @ko 사용자의 입력(마우스/터치)를 막습니다
   * @chainable
   * @return {this}
   */
  public disable(): this {
    this._controller.disable();

    return this;
  }

  /**
   * Releases ongoing user input (mouse/touch)
   * @ko 사용자의 현재 입력(마우스/터치)를 중단시킵니다
   * @chainable
   * @return {this}
   */
  public release(): this {
    this._controller.release();

    return this;
  }

  /**
   * Change the destination and duration of the animation currently playing
   * @ko 재생 중인 애니메이션의 목적지와 재생 시간을 변경합니다
   * @param {Panel} panel The target panel to move<ko>이동할 패널</ko>
   * @param {number} duration Duration of the animation (unit: ms)<ko>애니메이션 진행 시간 (단위: ms)</ko>
   * @param {DIRECTION} direction Direction to move, only available in the {@link Flicking#circular circular} mode<ko>이동할 방향. {@link Flicking#circular circular} 옵션 활성화시에만 사용 가능합니다</ko>
   * @chainable
   * @throws {FlickingError}
   * {@link ERROR_CODE POSITION_NOT_REACHABLE} When the given panel is already removed or not in the Camera's {@link Camera#range range}
   * <ko>{@link ERROR_CODE POSITION_NOT_REACHABLE} 주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우</ko>
   * @return {this}
   */
  public updateAnimation(panel: Panel, duration?: number, direction?: ValueOf<typeof DIRECTION>): this {
    const state = this._controller.state;
    const position = this._getPosition(panel, direction ?? DIRECTION.NONE);

    state.targetPanel = panel;
    this._controller.updateAnimation(position, duration);

    return this;
  }

  /**
   * Stops the animation currently playing
   * @ko 재생 중인 애니메이션을 중단시킵니다
   * @chainable
   * @return {this}
   */
  public stopAnimation(): this {
    const state = this._controller.state;

    state.targetPanel = null;
    this._controller.stopAnimation();

    return this;
  }

  /**
   * Update position after resizing
   * @ko resize 이후에 position을 업데이트합니다
   * @param {number} progressInPanel Previous camera's progress in active panel before resize<ko>Resize 이전 현재 선택된 패널 내에서의 카메라 progress 값</ko>
   * @throws {FlickingError}
   * {@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} When {@link Camera#init init} is not called before
   * <ko>{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} {@link Camera#init init}이 이전에 호출되지 않은 경우</ko>
   * @chainable
   * @return {Promise<void>}
   */
  public updatePosition(progressInPanel: number): void { // eslint-disable-line @typescript-eslint/no-unused-vars
    const flicking = getFlickingAttached(this._flicking);
    const camera = flicking.camera;
    const activePanel = this._activePanel;

    if (activePanel) {
      camera.lookAt(camera.clampToReachablePosition(activePanel.position));
    }
  }

  /**
   * Update {@link Control#controller controller}'s state
   * @ko {@link Control#controller controller}의 내부 상태를 갱신합니다
   * @chainable
   * @return {this}
   */
  public updateInput(): this {
    const flicking = getFlickingAttached(this._flicking);
    const camera = flicking.camera;

    this._controller.update(camera.controlParams);

    return this;
  }

  /**
   * Reset {@link Control#activePanel activePanel} to `null`
   * @ko {@link Control#activePanel activePanel}을 `null`로 초기화합니다
   * @chainable
   * @return {this}
   */
  public resetActive(): this {
    this._activePanel = null;

    return this;
  }

  /**
   * Move {@link Camera} to the given panel
   * @ko {@link Camera}를 해당 패널 위로 이동합니다
   * @param {Panel} panel The target panel to move<ko>이동할 패널</ko>
   * @param {object} options An options object<ko>옵션 오브젝트</ko>
   * @param {number} duration Duration of the animation (unit: ms)<ko>애니메이션 진행 시간 (단위: ms)</ko>
   * @param {object} [axesEvent] {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} event of {@link https://naver.github.io/egjs-axes/ Axes}
   * <ko>{@link https://naver.github.io/egjs-axes/ Axes}의 {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} 이벤트</ko>
   * @param {DIRECTION} [direction=DIRECTION.NONE] Direction to move, only available in the {@link Flicking#circular circular} mode<ko>이동할 방향. {@link Flicking#circular circular} 옵션 활성화시에만 사용 가능합니다</ko>
   * @fires Flicking#moveStart
   * @fires Flicking#move
   * @fires Flicking#moveEnd
   * @fires Flicking#willChange
   * @fires Flicking#changed
   * @fires Flicking#willRestore
   * @fires Flicking#restored
   * @fires Flicking#needPanel
   * @fires Flicking#visibleChange
   * @fires Flicking#reachEdge
   * @throws {FlickingError}
   * |code|condition|
   * |---|---|
   * |{@link ERROR_CODE POSITION_NOT_REACHABLE}|When the given panel is already removed or not in the Camera's {@link Camera#range range}|
   * |{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}|When {@link Control#init init} is not called before|
   * |{@link ERROR_CODE ANIMATION_INTERRUPTED}|When the animation is interrupted by user input|
   * |{@link ERROR_CODE STOP_CALLED_BY_USER}|When the animation is interrupted by user input|
   * <ko>
   *
   * |code|condition|
   * |---|---|
   * |{@link ERROR_CODE POSITION_NOT_REACHABLE}|주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우|
   * |{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}|{@link Control#init init}이 이전에 호출되지 않은 경우|
   * |{@link ERROR_CODE ANIMATION_INTERRUPTED}|사용자 입력에 의해 애니메이션이 중단된 경우|
   * |{@link ERROR_CODE STOP_CALLED_BY_USER}|발생된 이벤트들 중 하나라도 `stop()`이 호출된 경우|
   *
   * </ko>
   * @return {Promise<void>} A Promise which will be resolved after reaching the target panel<ko>해당 패널 도달시에 resolve되는 Promise</ko>
   */
  public async moveToPanel(panel: Panel, {
    duration,
    direction = DIRECTION.NONE,
    axesEvent
  }: {
    duration: number;
    direction?: ValueOf<typeof DIRECTION>;
    axesEvent?: OnRelease;
  }) {
    const position = this._getPosition(panel, direction);
    this._triggerIndexChangeEvent(panel, panel.position, axesEvent);

    return this._animateToPosition({ position, duration, newActivePanel: panel, axesEvent });
  }

  /**
   * @internal
   */
  public setActive(newActivePanel: Panel, prevActivePanel: Panel | null, isTrusted: boolean) {
    const flicking = getFlickingAttached(this._flicking);

    this._activePanel = newActivePanel;
    this._nextPanel = null;

    flicking.camera.updateAdaptiveHeight();

    if (newActivePanel !== prevActivePanel) {
      flicking.trigger(new ComponentEvent(EVENTS.CHANGED, {
        index: newActivePanel.index,
        panel: newActivePanel,
        prevIndex: prevActivePanel?.index ?? -1,
        prevPanel: prevActivePanel,
        isTrusted,
        direction: prevActivePanel ? getDirection(prevActivePanel.position, newActivePanel.position) : DIRECTION.NONE
      }));
    } else {
      flicking.trigger(new ComponentEvent(EVENTS.RESTORED, {
        isTrusted
      }));
    }
  }

  /**
   * @internal
   */
  public copy(control: Control) {
    this._flicking = control._flicking;
    this._activePanel = control._activePanel;
    this._controller = control._controller;
  }

  protected _triggerIndexChangeEvent(panel: Panel, position: number, axesEvent?: OnRelease) {
    const flicking = getFlickingAttached(this._flicking);
    const triggeringEvent = panel !== this._activePanel ? EVENTS.WILL_CHANGE : EVENTS.WILL_RESTORE;
    const camera = flicking.camera;
    const activePanel = this._activePanel;

    const event = new ComponentEvent(triggeringEvent, {
      index: panel.index,
      panel,
      isTrusted: axesEvent?.isTrusted || false,
      direction: getDirection(activePanel?.position ?? camera.position, position)
    });

    this._nextPanel = panel;
    flicking.trigger(event);

    if (event.isCanceled()) {
      throw new FlickingError(ERROR.MESSAGE.STOP_CALLED_BY_USER, ERROR.CODE.STOP_CALLED_BY_USER);
    }
  }

  protected async _animateToPosition({
    position,
    duration,
    newActivePanel,
    axesEvent
  }: {
    position: number;
    duration: number;
    newActivePanel: Panel;
    axesEvent?: OnRelease;
  }) {
    const flicking = getFlickingAttached(this._flicking);
    const animate = () => this._controller.animateTo(position, duration, axesEvent);
    const state = this._controller.state;

    state.targetPanel = newActivePanel;

    if (duration <= 0) {
      return animate();
    } else {
      return animate().then(async () => {
        await flicking.renderer.render();
      }).catch(err => {
        if (axesEvent && err instanceof FlickingError && err.code === ERROR.CODE.ANIMATION_INTERRUPTED) return;
        throw err;
      });
    }
  }

  private _getPosition(panel: Panel, direction: ValueOf<typeof DIRECTION> = DIRECTION.NONE) {
    const flicking = getFlickingAttached(this._flicking);
    const camera = flicking.camera;

    let position = panel.position;
    const nearestAnchor = camera.findNearestAnchor(position);

    if (panel.removed || !nearestAnchor) {
      throw new FlickingError(ERROR.MESSAGE.POSITION_NOT_REACHABLE(panel.position), ERROR.CODE.POSITION_NOT_REACHABLE);
    }
    if (!camera.canReach(panel)) {
      // Override position & panel if that panel is not reachable
      position = nearestAnchor.position;
      panel = nearestAnchor.panel;
    } else if (flicking.circularEnabled) {
      // Circular mode is enabled, find nearest distance to panel
      const camPos = this._controller.position; // Actual position of the Axes
      const camRangeDiff = camera.rangeDiff;
      const possiblePositions = [position, position + camRangeDiff, position - camRangeDiff]
        .filter(pos => {
          if (direction === DIRECTION.NONE) return true;

          return direction === DIRECTION.PREV
            ? pos <= camPos
            : pos >= camPos;
        });

      position = possiblePositions.reduce((nearestPosition, pos) => {
        if (Math.abs(camPos - pos) < Math.abs(camPos - nearestPosition)) {
          return pos;
        } else {
          return nearestPosition;
        }
      }, Infinity);
    }

    return position;
  }
}

export default Control;

1	/*	1✔
2	* Copyright (c) 2015 NAVER Corp.	1!
3	* egjs projects are licensed under the MIT license	×
4	*/
5	import { OnRelease } from "@egjs/axes";
6	import { ComponentEvent } from "@egjs/component";	5!
7
8	import Flicking from "../Flicking";
9	import FlickingError from "../core/FlickingError";	6!
10	import Panel from "../core/panel/Panel";
11	import AxesController from "../control/AxesController";	5✔
12	import { DIRECTION, EVENTS } from "../const/external";	5✔
13	import * as ERROR from "../const/error";	5✔
14	import { getDirection, getFlickingAttached } from "../utils";	6✔
15	import { ValueOf } from "../type/internal";	1!
16
17	/**	×
18	* A component that manages inputs and animation of Flicking
19	* @ko Flicking의 입력 장치 & 애니메이션을 담당하는 컴포넌트
20	*/
21	abstract class Control {	6✔
22	// Internal States	74!
23	protected _flicking: Flicking \| null;	308✔
24	protected _controller: AxesController;	74✔
25	protected _activePanel: Panel \| null;
26	protected _nextPanel: Panel \| null;	378✔
27		308✔
28	/**
29	* A controller that handles the {@link https://naver.github.io/egjs-axes/ @egjs/axes} events
30	* @ko {@link https://naver.github.io/egjs-axes/ @egjs/axes}의 이벤트를 처리하는 컨트롤러 컴포넌트	1✔
31	* @type {AxesController}	308!
32	* @readonly	308✔
33	*/	924✔
34	public get controller() { return this._controller; }	18✔
35	/**	382!
36	* Index number of the {@link Flicking#currentPanel currentPanel}	764✔
37	* @ko {@link Flicking#currentPanel currentPanel}의 인덱스 번호	764!
38	* @type {number}	764!
39	* @default 0	764!
40	* @readonly	382✔
41	*/	74✔
42	public get activeIndex() { return this._activePanel?.index ?? -1; }	6!
43	/**
44	* An active panel
45	* @ko 현재 선택된 패널	308!
46	* @type {Panel \| null}	×
47	* @readonly	×
48	*/	×
49	public get activePanel() { return this._activePanel; }	20!
50	/**
51	* Whether Flicking's animating
52	* @ko 현재 애니메이션 동작 여부	382✔
53	* @type {boolean}	764✔
54	* @readonly	308!
55	*/
56	public get animating() { return this._controller.state.animating; }	13✔
57	/**	1✔
58	* Whether user is clicking or touching	2!
59	* @ko 현재 사용자가 클릭/터치중인지 여부
60	* @type {boolean}	1✔
61	* @readonly	1✔
62	*/	1✔
63	public get holding() { return this._controller.state.holding; }	7✔
64		1✔
65	/** */	1✔
66	public constructor() {	1✔
67	this._flicking = null;	14✔
68	this._controller = new AxesController();	14✔
69	this._activePanel = null;	14✔
70	}
71		1✔
72	/**
73	* Move {@link Camera} to the given position
74	* @ko {@link Camera}를 주어진 좌표로 이동합니다	485✔
75	* @method	485✔
76	* @abstract	485✔
77	* @memberof Control
78	* @instance	1✔
79	* @name moveToPosition
80	* @param {number} position The target position to move<ko>이동할 좌표</ko>
81	* @param {number} duration Duration of the panel movement animation (unit: ms).<ko>패널 이동 애니메이션 진행 시간 (단위: ms)</ko>
82	* @param {object} [axesEvent] {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} event of {@link https://naver.github.io/egjs-axes/ Axes}
83	* <ko>{@link https://naver.github.io/egjs-axes/ Axes}의 {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} 이벤트</ko>
84	* @fires Flicking#moveStart
85	* @fires Flicking#move	690✔
86	* @fires Flicking#moveEnd
87	* @fires Flicking#willChange
88	* @fires Flicking#changed
89	* @fires Flicking#willRestore	1✔
90	* @fires Flicking#restored
91	* @fires Flicking#needPanel
92	* @fires Flicking#visibleChange
93	* @fires Flicking#reachEdge
94	* @throws {FlickingError}
95	* \|code\|condition\|
96	* \|---\|---\|
97	* \|{@link ERROR_CODE POSITION_NOT_REACHABLE}\|When the given panel is already removed or not in the Camera's {@link Camera#range range}\|	113✔
98	* \|{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}\|When {@link Control#init init} is not called before\|
99	* \|{@link ERROR_CODE ANIMATION_INTERRUPTED}\|When the animation is interrupted by user input\|
100	* \|{@link ERROR_CODE STOP_CALLED_BY_USER}\|When the animation is interrupted by user input\|
101	* <ko>	1✔
102	*
103	* \|code\|condition\|
104	* \|---\|---\|
105	* \|{@link ERROR_CODE POSITION_NOT_REACHABLE}\|주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우\|
106	* \|{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}\|{@link Control#init init}이 이전에 호출되지 않은 경우\|
107	* \|{@link ERROR_CODE ANIMATION_INTERRUPTED}\|사용자 입력에 의해 애니메이션이 중단된 경우\|
108	* \|{@link ERROR_CODE STOP_CALLED_BY_USER}\|발생된 이벤트들 중 하나라도 `stop()`이 호출된 경우\|	790✔
109	*
110	* </ko>
111	* @return {Promise<void>} A Promise which will be resolved after reaching the target position<ko>해당 좌표 도달시에 resolve되는 Promise</ko>
112	*/	1✔
113	public abstract moveToPosition(position: number, duration: number, axesEvent?: OnRelease): Promise<void>;
114
115	/**
116	* Initialize Control
117	* @ko Control을 초기화합니다
118	* @param {Flicking} flicking An instance of {@link Flicking}<ko>Flicking의 인스턴스</ko>
119	* @chainable	172✔
120	* @return {this}
121	*/
122	public init(flicking: Flicking): this {	5✔
123	this._flicking = flicking;	15✔
124	this._controller.init(flicking);	14✔
125
126	return this;	14✔
127	}
128
129	/**
130	* Destroy Control and return to initial state	61✔
131	* @ko Control을 초기 상태로 되돌립니다
132	* @return {void}
133	*/
134	public destroy(): void {	5✔
135	this._controller.destroy();
136
137	this._flicking = null;
138	this._activePanel = null;
139	}
140
141	/**	1✔
142	* Enable input from the user (mouse/touch)	460✔
143	* @ko 사용자의 입력(마우스/터치)를 활성화합니다	460✔
144	* @chainable	460✔
145	* @return {this}
146	*/
147	public enable(): this {	5✔
148	this._controller.enable();
149
150	return this;
151	}	1✔
152		466✔
153	/**	466✔
154	* Disable input from the user (mouse/touch)	466✔
155	* @ko 사용자의 입력(마우스/터치)를 막습니다
156	* @chainable
157	* @return {this}
158	*/
159	public disable(): this {	5✔
160	this._controller.disable();
161
162	return this;	1✔
163	}	3✔
164		3✔
165	/**
166	* Releases ongoing user input (mouse/touch)
167	* @ko 사용자의 현재 입력(마우스/터치)를 중단시킵니다
168	* @chainable
169	* @return {this}
170	*/
171	public release(): this {	5✔
172	this._controller.release();	1✔
173		6✔
174	return this;	6✔
175	}
176
177	/**
178	* Change the destination and duration of the animation currently playing
179	* @ko 재생 중인 애니메이션의 목적지와 재생 시간을 변경합니다
180	* @param {Panel} panel The target panel to move<ko>이동할 패널</ko>
181	* @param {number} duration Duration of the animation (unit: ms)<ko>애니메이션 진행 시간 (단위: ms)</ko>
182	* @param {DIRECTION} direction Direction to move, only available in the {@link Flicking#circular circular} mode<ko>이동할 방향. {@link Flicking#circular circular} 옵션 활성화시에만 사용 가능합니다</ko>	1✔
183	* @chainable	1✔
184	* @throws {FlickingError}	1✔
185	* {@link ERROR_CODE POSITION_NOT_REACHABLE} When the given panel is already removed or not in the Camera's {@link Camera#range range}
186	* <ko>{@link ERROR_CODE POSITION_NOT_REACHABLE} 주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우</ko>
187	* @return {this}
188	*/
189	public updateAnimation(panel: Panel, duration?: number, direction?: ValueOf<typeof DIRECTION>): this {	5✔
190	const state = this._controller.state;
191	const position = this._getPosition(panel, direction ?? DIRECTION.NONE);	×
192
193	state.targetPanel = panel;
194	this._controller.updateAnimation(position, duration);
195
196	return this;
197	}
198		1✔
199	/**	1✔
200	* Stops the animation currently playing	1!
201	* @ko 재생 중인 애니메이션을 중단시킵니다	1✔
202	* @chainable	1✔
203	* @return {this}	1✔
204	*/
205	public stopAnimation(): this {	5✔
206	const state = this._controller.state;
207
208	state.targetPanel = null;
209	this._controller.stopAnimation();
210
211	return this;	1✔
212	}	1✔
213		1✔
214	/**	1✔
215	* Update position after resizing	1✔
216	* @ko resize 이후에 position을 업데이트합니다
217	* @param {number} progressInPanel Previous camera's progress in active panel before resize<ko>Resize 이전 현재 선택된 패널 내에서의 카메라 progress 값</ko>
218	* @throws {FlickingError}
219	* {@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} When {@link Camera#init init} is not called before
220	* <ko>{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING} {@link Camera#init init}이 이전에 호출되지 않은 경우</ko>
221	* @chainable
222	* @return {Promise<void>}
223	*/
224	public updatePosition(progressInPanel: number): void { // eslint-disable-line @typescript-eslint/no-unused-vars	5✔
225	const flicking = getFlickingAttached(this._flicking);
226	const camera = flicking.camera;
227	const activePanel = this._activePanel;	1✔
228		32✔
229	if (activePanel) {	32!
230	camera.lookAt(camera.clampToReachablePosition(activePanel.position));	32✔
231	}	32✔
232	}	27✔
233
234	/**
235	* Update {@link Control#controller controller}'s state
236	* @ko {@link Control#controller controller}의 내부 상태를 갱신합니다
237	* @chainable
238	* @return {this}
239	*/
240	public updateInput(): this {	5✔
241	const flicking = getFlickingAttached(this._flicking);	29✔
242	const camera = flicking.camera;	872✔
243		843✔
244	this._controller.update(camera.controlParams);	871✔
245		843✔
246	return this;	28✔
247	}
248
249	/**
250	* Reset {@link Control#activePanel activePanel} to `null`
251	* @ko {@link Control#activePanel activePanel}을 `null`로 초기화합니다
252	* @chainable
253	* @return {this}	1✔
254	*/	7✔
255	public resetActive(): this {	12✔
256	this._activePanel = null;
257
258	return this;
259	}
260
261	/**
262	* Move {@link Camera} to the given panel
263	* @ko {@link Camera}를 해당 패널 위로 이동합니다
264	* @param {Panel} panel The target panel to move<ko>이동할 패널</ko>
265	* @param {object} options An options object<ko>옵션 오브젝트</ko>
266	* @param {number} duration Duration of the animation (unit: ms)<ko>애니메이션 진행 시간 (단위: ms)</ko>
267	* @param {object} [axesEvent] {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} event of {@link https://naver.github.io/egjs-axes/ Axes}
268	* <ko>{@link https://naver.github.io/egjs-axes/ Axes}의 {@link https://naver.github.io/egjs-axes/release/latest/doc/eg.Axes.html#event:release release} 이벤트</ko>
269	* @param {DIRECTION} [direction=DIRECTION.NONE] Direction to move, only available in the {@link Flicking#circular circular} mode<ko>이동할 방향. {@link Flicking#circular circular} 옵션 활성화시에만 사용 가능합니다</ko>
270	* @fires Flicking#moveStart
271	* @fires Flicking#move
272	* @fires Flicking#moveEnd
273	* @fires Flicking#willChange
274	* @fires Flicking#changed
275	* @fires Flicking#willRestore
276	* @fires Flicking#restored
277	* @fires Flicking#needPanel
278	* @fires Flicking#visibleChange
279	* @fires Flicking#reachEdge
280	* @throws {FlickingError}
281	* \|code\|condition\|
282	* \|---\|---\|
283	* \|{@link ERROR_CODE POSITION_NOT_REACHABLE}\|When the given panel is already removed or not in the Camera's {@link Camera#range range}\|
284	* \|{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}\|When {@link Control#init init} is not called before\|
285	* \|{@link ERROR_CODE ANIMATION_INTERRUPTED}\|When the animation is interrupted by user input\|
286	* \|{@link ERROR_CODE STOP_CALLED_BY_USER}\|When the animation is interrupted by user input\|
287	* <ko>
288	*
289	* \|code\|condition\|
290	* \|---\|---\|
291	* \|{@link ERROR_CODE POSITION_NOT_REACHABLE}\|주어진 패널이 제거되었거나, Camera의 {@link Camera#range range} 밖에 있을 경우\|
292	* \|{@link ERROR_CODE NOT_ATTACHED_TO_FLICKING}\|{@link Control#init init}이 이전에 호출되지 않은 경우\|
293	* \|{@link ERROR_CODE ANIMATION_INTERRUPTED}\|사용자 입력에 의해 애니메이션이 중단된 경우\|
294	* \|{@link ERROR_CODE STOP_CALLED_BY_USER}\|발생된 이벤트들 중 하나라도 `stop()`이 호출된 경우\|
295	*	1✔
296	* </ko>	93✔
297	* @return {Promise<void>} A Promise which will be resolved after reaching the target panel<ko>해당 패널 도달시에 resolve되는 Promise</ko>	93✔
298	*/
299	public async moveToPanel(panel: Panel, {	98✔
300	duration,	96✔
301	direction = DIRECTION.NONE,	95✔
302	axesEvent	92✔
303	}: {
304	duration: number;
305	direction?: ValueOf<typeof DIRECTION>;
306	axesEvent?: OnRelease;
307	}) {
308	const position = this._getPosition(panel, direction);	3✔
309	this._triggerIndexChangeEvent(panel, panel.position, axesEvent);	4✔
310
311	return this._animateToPosition({ position, duration, newActivePanel: panel, axesEvent });	494✔
312	}	491✔
313		491✔
314	/**	491✔
315	* @internal	491✔
316	*/	451✔
317	public setActive(newActivePanel: Panel, prevActivePanel: Panel \| null, isTrusted: boolean) {	5✔
318	const flicking = getFlickingAttached(this._flicking);	16✔
319		2,340✔
320	this._activePanel = newActivePanel;	16✔
321	this._nextPanel = null;	16✔
322		451✔
323	flicking.camera.updateAdaptiveHeight();	16✔
324
325	if (newActivePanel !== prevActivePanel) {	16✔
326	flicking.trigger(new ComponentEvent(EVENTS.CHANGED, {	55✔
327	index: newActivePanel.index,
328	panel: newActivePanel,
329	prevIndex: prevActivePanel?.index ?? -1,	76✔
330	prevPanel: prevActivePanel,
331	isTrusted,
332	direction: prevActivePanel ? getDirection(prevActivePanel.position, newActivePanel.position) : DIRECTION.NONE	15✔
333	}));
334	} else {	1✔
335	flicking.trigger(new ComponentEvent(EVENTS.RESTORED, {	3✔
336	isTrusted	2✔
337	}));	2✔
338	}
339	}	1✔
340
341	/**	143✔
342	* @internal	143✔
343	*/	143✔
344	public copy(control: Control) {	148✔
345	this._flicking = control._flicking;	143✔
346	this._activePanel = control._activePanel;
347	this._controller = control._controller;
348	}	664✔
349		846✔
350	protected _triggerIndexChangeEvent(panel: Panel, position: number, axesEvent?: OnRelease) {	5✔
351	const flicking = getFlickingAttached(this._flicking);	147✔
352	const triggeringEvent = panel !== this._activePanel ? EVENTS.WILL_CHANGE : EVENTS.WILL_RESTORE;	147✔
353	const camera = flicking.camera;	147✔
354	const activePanel = this._activePanel;	8✔
355
356	const event = new ComponentEvent(triggeringEvent, {	4✔
357	index: panel.index,	1✔
358	panel,	141✔
359	isTrusted: axesEvent?.isTrusted \|\| false,	141✔
360	direction: getDirection(activePanel?.position ?? camera.position, position)	24!
361	});	141✔
362		141✔
363	this._nextPanel = panel;	145✔
364	flicking.trigger(event);	145✔
365		141✔
366	if (event.isCanceled()) {	145!
367	throw new FlickingError(ERROR.MESSAGE.STOP_CALLED_BY_USER, ERROR.CODE.STOP_CALLED_BY_USER);	141✔
368	}	56✔
369	}
370
371	protected async _animateToPosition({	90✔
372	position,	78✔
373	duration,	152✔
374	newActivePanel,	78✔
375	axesEvent	4✔
376	}: {	74✔
377	position: number;	74✔
378	duration: number;
379	newActivePanel: Panel;
380	axesEvent?: OnRelease;
381	}) {	8✔
382	const flicking = getFlickingAttached(this._flicking);	8✔
383	const animate = () => this._controller.animateTo(position, duration, axesEvent);	8✔
384	const state = this._controller.state;	4✔
385
386	state.targetPanel = newActivePanel;	4✔
387
388	if (duration <= 0) {	4!
389	return animate();
390	} else {	1✔
391	return animate().then(async () => {	98!
392	await flicking.renderer.render();	98✔
393	}).catch(err => {	93✔
394	if (axesEvent && err instanceof FlickingError && err.code === ERROR.CODE.ANIMATION_INTERRUPTED) return;	93!
395	throw err;	93✔
396	});	93!
397	}
398	}
399		93!
400	private _getPosition(panel: Panel, direction: ValueOf<typeof DIRECTION> = DIRECTION.NONE) {	5!
401	const flicking = getFlickingAttached(this._flicking);	3✔
402	const camera = flicking.camera;	3✔
403
404	let position = panel.position;	96✔
405	const nearestAnchor = camera.findNearestAnchor(position);	3✔
406		3✔
407	if (panel.removed \|\| !nearestAnchor) {	6!
408	throw new FlickingError(ERROR.MESSAGE.POSITION_NOT_REACHABLE(panel.position), ERROR.CODE.POSITION_NOT_REACHABLE);	3✔
409	}
410	if (!camera.canReach(panel)) {	12!
411	// Override position & panel if that panel is not reachable	9✔
UNCOV 412	position = nearestAnchor.position;	×
413	panel = nearestAnchor.panel;
414	} else if (flicking.circularEnabled) {	3!
415	// Circular mode is enabled, find nearest distance to panel
416	const camPos = this._controller.position; // Actual position of the Axes	3✔
417	const camRangeDiff = camera.rangeDiff;	9✔
418	const possiblePositions = [position, position + camRangeDiff, position - camRangeDiff]	5✔
419	.filter(pos => {
420	if (direction === DIRECTION.NONE) return true;	×
421		4✔
422	return direction === DIRECTION.PREV	×
423	? pos <= camPos
424	: pos >= camPos;
425	});	93✔
426
427	position = possiblePositions.reduce((nearestPosition, pos) => {	1✔
428	if (Math.abs(camPos - pos) < Math.abs(camPos - nearestPosition)) {	×
429	return pos;	1✔
430	} else {
431	return nearestPosition;
432	}
433	}, Infinity);
434	}
435
436	return position;	3✔
437	}
438	}	5✔
439
440	export default Control;	5✔

naver / egjs-flicking / 7041786814

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous