blob: 6cd56477ba81cb53ec9ec0d7c6da7e0e7352c0ee [file] [log] [blame]
// Copyright (c) 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/* eslint-disable rulesdir/no_underscored_properties */
import * as Common from '../../core/common/common.js';
import * as i18n from '../../core/i18n/i18n.js';
import * as Platform from '../../core/platform/platform.js';
import * as InlineEditor from '../../inline_editor/inline_editor.js';
import type * as SDK from '../../core/sdk/sdk.js';
import * as UI from '../../ui/legacy/legacy.js';
import type {AnimationImpl, KeyframeStyle} from './AnimationModel.js';
import type {AnimationTimeline} from './AnimationTimeline.js';
import {StepTimingFunction} from './AnimationTimeline.js';
const UIStrings = {
/**
*@description Title of the first and last points of an animation
*/
animationEndpointSlider: 'Animation Endpoint slider',
/**
*@description Title of an Animation Keyframe point
*/
animationKeyframeSlider: 'Animation Keyframe slider',
/**
*@description Title of an animation keyframe group
*@example {anilogo} PH1
*/
sSlider: '{PH1} slider',
};
const str_ = i18n.i18n.registerUIStrings('panels/animation/AnimationUI.ts', UIStrings);
const i18nString = i18n.i18n.getLocalizedString.bind(undefined, str_);
type CachedElement = {
group: HTMLElement|null,
animationLine: HTMLElement|null,
keyframePoints: {[x: number]: HTMLElement},
keyframeRender: {[x: number]: HTMLElement},
};
export class AnimationUI {
_animation: AnimationImpl;
_timeline: AnimationTimeline;
_parentElement: Element;
_keyframes?: KeyframeStyle[];
_nameElement: HTMLElement;
_svg: Element;
_activeIntervalGroup: Element;
_cachedElements: CachedElement[];
_movementInMs: number;
_keyboardMovementRateMs: number;
_color: string;
_node?: SDK.DOMModel.DOMNode|null;
_delayLine?: Element;
_endDelayLine?: Element;
_tailGroup?: Element;
_mouseEventType?: Events;
_keyframeMoved?: number|null;
_downMouseX?: number;
constructor(animation: AnimationImpl, timeline: AnimationTimeline, parentElement: Element) {
this._animation = animation;
this._timeline = timeline;
this._parentElement = parentElement;
const keyframesRule = this._animation.source().keyframesRule();
if (keyframesRule) {
this._keyframes = keyframesRule.keyframes();
}
this._nameElement = (parentElement.createChild('div', 'animation-name') as HTMLElement);
this._nameElement.textContent = this._animation.name();
this._svg = UI.UIUtils.createSVGChild(parentElement, 'svg', 'animation-ui');
this._svg.setAttribute('height', Options.AnimationSVGHeight.toString());
(this._svg as HTMLElement).style.marginLeft = '-' + Options.AnimationMargin + 'px';
this._svg.addEventListener('contextmenu', this._onContextMenu.bind(this));
this._activeIntervalGroup = UI.UIUtils.createSVGChild(this._svg, 'g');
UI.UIUtils.installDragHandle(
this._activeIntervalGroup, this._mouseDown.bind(this, Events.AnimationDrag, null), this._mouseMove.bind(this),
this._mouseUp.bind(this), '-webkit-grabbing', '-webkit-grab');
AnimationUI.installDragHandleKeyboard(
this._activeIntervalGroup, this._keydownMove.bind(this, Events.AnimationDrag, null));
this._cachedElements = [];
this._movementInMs = 0;
this._keyboardMovementRateMs = 50;
this._color = AnimationUI.colorForAnimation(this._animation);
}
static colorForAnimation(animation: AnimationImpl): string {
const names = Array.from(Colors.keys());
const hashCode = Platform.StringUtilities.hashCode(animation.name() || animation.id());
const cappedHashCode = hashCode % names.length;
const colorName = names[cappedHashCode];
const color = Colors.get(colorName);
if (!color) {
throw new Error('Unable to locate color');
}
return color.asString(Common.Color.Format.RGB) || '';
}
static installDragHandleKeyboard(element: Element, elementDrag: (arg0: Event) => void): void {
element.addEventListener('keydown', elementDrag, false);
}
animation(): AnimationImpl {
return this._animation;
}
setNode(node: SDK.DOMModel.DOMNode|null): void {
this._node = node;
}
_createLine(parentElement: HTMLElement, className: string): Element {
const line = UI.UIUtils.createSVGChild(parentElement, 'line', className);
line.setAttribute('x1', Options.AnimationMargin.toString());
line.setAttribute('y1', Options.AnimationHeight.toString());
line.setAttribute('y2', Options.AnimationHeight.toString());
(line as HTMLElement).style.stroke = this._color;
return line;
}
_drawAnimationLine(iteration: number, parentElement: HTMLElement): void {
const cache = this._cachedElements[iteration];
if (!cache.animationLine) {
cache.animationLine = (this._createLine(parentElement, 'animation-line') as HTMLElement);
}
if (!cache.animationLine) {
return;
}
cache.animationLine.setAttribute(
'x2', (this._duration() * this._timeline.pixelMsRatio() + Options.AnimationMargin).toFixed(2));
}
_drawDelayLine(parentElement: HTMLElement): void {
if (!this._delayLine || !this._endDelayLine) {
this._delayLine = this._createLine(parentElement, 'animation-delay-line');
this._endDelayLine = this._createLine(parentElement, 'animation-delay-line');
}
const fill = this._animation.source().fill();
this._delayLine.classList.toggle('animation-fill', fill === 'backwards' || fill === 'both');
const margin = Options.AnimationMargin;
this._delayLine.setAttribute('x1', margin.toString());
this._delayLine.setAttribute('x2', (this._delay() * this._timeline.pixelMsRatio() + margin).toFixed(2));
const forwardsFill = fill === 'forwards' || fill === 'both';
this._endDelayLine.classList.toggle('animation-fill', forwardsFill);
const leftMargin = Math.min(
this._timeline.width(),
(this._delay() + this._duration() * this._animation.source().iterations()) * this._timeline.pixelMsRatio());
(this._endDelayLine as HTMLElement).style.transform = 'translateX(' + leftMargin.toFixed(2) + 'px)';
this._endDelayLine.setAttribute('x1', margin.toString());
this._endDelayLine.setAttribute(
'x2',
forwardsFill ? (this._timeline.width() - leftMargin + margin).toFixed(2) :
(this._animation.source().endDelay() * this._timeline.pixelMsRatio() + margin).toFixed(2));
}
_drawPoint(iteration: number, parentElement: Element, x: number, keyframeIndex: number, attachEvents: boolean): void {
if (this._cachedElements[iteration].keyframePoints[keyframeIndex]) {
this._cachedElements[iteration].keyframePoints[keyframeIndex].setAttribute('cx', x.toFixed(2));
return;
}
const circle =
(UI.UIUtils.createSVGChild(
parentElement, 'circle', keyframeIndex <= 0 ? 'animation-endpoint' : 'animation-keyframe-point') as
HTMLElement);
circle.setAttribute('cx', x.toFixed(2));
circle.setAttribute('cy', Options.AnimationHeight.toString());
circle.style.stroke = this._color;
circle.setAttribute('r', (Options.AnimationMargin / 2).toString());
circle.tabIndex = 0;
UI.ARIAUtils.setAccessibleName(
circle,
keyframeIndex <= 0 ? i18nString(UIStrings.animationEndpointSlider) :
i18nString(UIStrings.animationKeyframeSlider));
if (keyframeIndex <= 0) {
circle.style.fill = this._color;
}
this._cachedElements[iteration].keyframePoints[keyframeIndex] = (circle as HTMLElement);
if (!attachEvents) {
return;
}
let eventType: Events;
if (keyframeIndex === 0) {
eventType = Events.StartEndpointMove;
} else if (keyframeIndex === -1) {
eventType = Events.FinishEndpointMove;
} else {
eventType = Events.KeyframeMove;
}
UI.UIUtils.installDragHandle(
circle, this._mouseDown.bind(this, eventType, keyframeIndex), this._mouseMove.bind(this),
this._mouseUp.bind(this), 'ew-resize');
AnimationUI.installDragHandleKeyboard(circle, this._keydownMove.bind(this, eventType, keyframeIndex));
}
_renderKeyframe(
iteration: number, keyframeIndex: number, parentElement: HTMLElement, leftDistance: number, width: number,
easing: string): void {
function createStepLine(parentElement: HTMLElement, x: number, strokeColor: string): void {
const line = (UI.UIUtils.createSVGChild(parentElement, 'line') as HTMLElement);
line.setAttribute('x1', x.toString());
line.setAttribute('x2', x.toString());
line.setAttribute('y1', Options.AnimationMargin.toString());
line.setAttribute('y2', Options.AnimationHeight.toString());
line.style.stroke = strokeColor;
}
const bezier = UI.Geometry.CubicBezier.parse(easing);
const cache = this._cachedElements[iteration].keyframeRender;
if (!cache[keyframeIndex]) {
const svg = bezier ? UI.UIUtils.createSVGChild(parentElement, 'path', 'animation-keyframe') :
UI.UIUtils.createSVGChild(parentElement, 'g', 'animation-keyframe-step');
cache[keyframeIndex] = (svg as HTMLElement);
}
const group = cache[keyframeIndex];
group.tabIndex = 0;
UI.ARIAUtils.setAccessibleName(group, i18nString(UIStrings.sSlider, {PH1: this._animation.name()}));
group.style.transform = 'translateX(' + leftDistance.toFixed(2) + 'px)';
if (easing === 'linear') {
group.style.fill = this._color;
const height = InlineEditor.BezierUI.Height;
group.setAttribute(
'd', ['M', 0, height, 'L', 0, 5, 'L', width.toFixed(2), 5, 'L', width.toFixed(2), height, 'Z'].join(' '));
} else if (bezier) {
group.style.fill = this._color;
InlineEditor.BezierUI.BezierUI.drawVelocityChart(bezier, group, width);
} else {
const stepFunction = StepTimingFunction.parse(easing);
group.removeChildren();
const offsetMap: {[x: string]: number} = {'start': 0, 'middle': 0.5, 'end': 1};
if (stepFunction) {
const offsetWeight = offsetMap[stepFunction.stepAtPosition];
for (let i = 0; i < stepFunction.steps; i++) {
createStepLine(group, (i + offsetWeight) * width / stepFunction.steps, this._color);
}
}
}
}
redraw(): void {
const maxWidth = this._timeline.width() - Options.AnimationMargin;
this._svg.setAttribute('width', (maxWidth + 2 * Options.AnimationMargin).toFixed(2));
(this._activeIntervalGroup as HTMLElement).style.transform =
'translateX(' + (this._delay() * this._timeline.pixelMsRatio()).toFixed(2) + 'px)';
this._nameElement.style.transform =
'translateX(' + (this._delay() * this._timeline.pixelMsRatio() + Options.AnimationMargin).toFixed(2) + 'px)';
this._nameElement.style.width = (this._duration() * this._timeline.pixelMsRatio()).toFixed(2) + 'px';
this._drawDelayLine((this._svg as HTMLElement));
if (this._animation.type() === 'CSSTransition') {
this._renderTransition();
return;
}
this._renderIteration(this._activeIntervalGroup, 0);
if (!this._tailGroup) {
this._tailGroup = UI.UIUtils.createSVGChild(this._activeIntervalGroup, 'g', 'animation-tail-iterations');
}
const iterationWidth = this._duration() * this._timeline.pixelMsRatio();
let iteration;
for (iteration = 1;
iteration < this._animation.source().iterations() && iterationWidth * (iteration - 1) < this._timeline.width();
iteration++) {
this._renderIteration(this._tailGroup, iteration);
}
while (iteration < this._cachedElements.length) {
const poppedElement = this._cachedElements.pop();
if (poppedElement && poppedElement.group) {
poppedElement.group.remove();
}
}
}
_renderTransition(): void {
const activeIntervalGroup = (this._activeIntervalGroup as HTMLElement);
if (!this._cachedElements[0]) {
this._cachedElements[0] = {animationLine: null, keyframePoints: {}, keyframeRender: {}, group: null};
}
this._drawAnimationLine(0, activeIntervalGroup);
this._renderKeyframe(
0, 0, activeIntervalGroup, Options.AnimationMargin, this._duration() * this._timeline.pixelMsRatio(),
this._animation.source().easing());
this._drawPoint(0, activeIntervalGroup, Options.AnimationMargin, 0, true);
this._drawPoint(
0, activeIntervalGroup, this._duration() * this._timeline.pixelMsRatio() + Options.AnimationMargin, -1, true);
}
_renderIteration(parentElement: Element, iteration: number): void {
if (!this._cachedElements[iteration]) {
this._cachedElements[iteration] = {
animationLine: null,
keyframePoints: {},
keyframeRender: {},
group: (UI.UIUtils.createSVGChild(parentElement, 'g') as HTMLElement),
};
}
const group = this._cachedElements[iteration].group;
if (!group) {
return;
}
group.style.transform =
'translateX(' + (iteration * this._duration() * this._timeline.pixelMsRatio()).toFixed(2) + 'px)';
this._drawAnimationLine(iteration, group);
if (this._keyframes && this._keyframes.length > 1) {
for (let i = 0; i < this._keyframes.length - 1; i++) {
const leftDistance =
this._offset(i) * this._duration() * this._timeline.pixelMsRatio() + Options.AnimationMargin;
const width = this._duration() * (this._offset(i + 1) - this._offset(i)) * this._timeline.pixelMsRatio();
this._renderKeyframe(iteration, i, group, leftDistance, width, this._keyframes[i].easing());
if (i || (!i && iteration === 0)) {
this._drawPoint(iteration, group, leftDistance, i, iteration === 0);
}
}
}
this._drawPoint(
iteration, group, this._duration() * this._timeline.pixelMsRatio() + Options.AnimationMargin, -1,
iteration === 0);
}
_delay(): number {
let delay = this._animation.source().delay();
if (this._mouseEventType === Events.AnimationDrag || this._mouseEventType === Events.StartEndpointMove) {
delay += this._movementInMs;
}
// FIXME: add support for negative start delay
return Math.max(0, delay);
}
_duration(): number {
let duration = this._animation.source().duration();
if (this._mouseEventType === Events.FinishEndpointMove) {
duration += this._movementInMs;
} else if (this._mouseEventType === Events.StartEndpointMove) {
duration -= Math.max(this._movementInMs, -this._animation.source().delay());
// Cannot have negative delay
}
return Math.max(0, duration);
}
_offset(i: number): number {
if (!this._keyframes) {
throw new Error('Unable to calculate offset; keyframes do not exist');
}
let offset = this._keyframes[i].offsetAsNumber();
if (this._mouseEventType === Events.KeyframeMove && i === this._keyframeMoved) {
console.assert(i > 0 && i < this._keyframes.length - 1, 'First and last keyframe cannot be moved');
offset += this._movementInMs / this._animation.source().duration();
offset = Math.max(offset, this._keyframes[i - 1].offsetAsNumber());
offset = Math.min(offset, this._keyframes[i + 1].offsetAsNumber());
}
return offset;
}
_mouseDown(mouseEventType: Events, keyframeIndex: number|null, event: Event): boolean {
const mouseEvent = (event as MouseEvent);
if (mouseEvent.buttons === 2) {
return false;
}
if (this._svg.enclosingNodeOrSelfWithClass('animation-node-removed')) {
return false;
}
this._mouseEventType = mouseEventType;
this._keyframeMoved = keyframeIndex;
this._downMouseX = mouseEvent.clientX;
event.consume(true);
if (this._node) {
Common.Revealer.reveal(this._node);
}
return true;
}
_mouseMove(event: Event): void {
const mouseEvent = (event as MouseEvent);
this._setMovementAndRedraw((mouseEvent.clientX - (this._downMouseX || 0)) / this._timeline.pixelMsRatio());
}
_setMovementAndRedraw(movement: number): void {
this._movementInMs = movement;
if (this._delay() + this._duration() > this._timeline.duration() * 0.8) {
this._timeline.setDuration(this._timeline.duration() * 1.2);
}
this.redraw();
}
_mouseUp(event: Event): void {
const mouseEvent = (event as MouseEvent);
this._movementInMs = (mouseEvent.clientX - (this._downMouseX || 0)) / this._timeline.pixelMsRatio();
// Commit changes
if (this._mouseEventType === Events.KeyframeMove) {
if (this._keyframes && this._keyframeMoved !== null && typeof this._keyframeMoved !== 'undefined') {
this._keyframes[this._keyframeMoved].setOffset(this._offset(this._keyframeMoved));
}
} else {
this._animation.setTiming(this._duration(), this._delay());
}
this._movementInMs = 0;
this.redraw();
delete this._mouseEventType;
delete this._downMouseX;
delete this._keyframeMoved;
}
_keydownMove(mouseEventType: Events, keyframeIndex: number|null, event: Event): void {
const keyboardEvent = (event as KeyboardEvent);
this._mouseEventType = mouseEventType;
this._keyframeMoved = keyframeIndex;
switch (keyboardEvent.key) {
case 'ArrowLeft':
case 'ArrowUp':
this._movementInMs = -this._keyboardMovementRateMs;
break;
case 'ArrowRight':
case 'ArrowDown':
this._movementInMs = this._keyboardMovementRateMs;
break;
default:
return;
}
if (this._mouseEventType === Events.KeyframeMove) {
if (this._keyframes && this._keyframeMoved !== null) {
this._keyframes[this._keyframeMoved].setOffset(this._offset(this._keyframeMoved));
}
} else {
this._animation.setTiming(this._duration(), this._delay());
}
this._setMovementAndRedraw(0);
delete this._mouseEventType;
delete this._keyframeMoved;
event.consume(true);
}
_onContextMenu(event: Event): void {
function showContextMenu(remoteObject: SDK.RemoteObject.RemoteObject|null): void {
if (!remoteObject) {
return;
}
const contextMenu = new UI.ContextMenu.ContextMenu(event);
contextMenu.appendApplicableItems(remoteObject);
contextMenu.show();
}
this._animation.remoteObjectPromise().then(showContextMenu);
event.consume(true);
}
}
export const enum Events {
AnimationDrag = 'AnimationDrag',
KeyframeMove = 'KeyframeMove',
StartEndpointMove = 'StartEndpointMove',
FinishEndpointMove = 'FinishEndpointMove',
}
export const Options = {
AnimationHeight: 26,
AnimationSVGHeight: 50,
AnimationMargin: 7,
EndpointsClickRegionSize: 10,
GridCanvasHeight: 40,
};
export const Colors = new Map<string, Common.Color.Color|null>([
['Purple', Common.Color.Color.parse('#9C27B0')],
['Light Blue', Common.Color.Color.parse('#03A9F4')],
['Deep Orange', Common.Color.Color.parse('#FF5722')],
['Blue', Common.Color.Color.parse('#5677FC')],
['Lime', Common.Color.Color.parse('#CDDC39')],
['Blue Grey', Common.Color.Color.parse('#607D8B')],
['Pink', Common.Color.Color.parse('#E91E63')],
['Green', Common.Color.Color.parse('#0F9D58')],
['Brown', Common.Color.Color.parse('#795548')],
['Cyan', Common.Color.Color.parse('#00BCD4')],
]);