Hector Dearman | 3d26fdb | 2018-07-09 13:54:06 +0100 | [diff] [blame] | 1 | // Copyright (C) 2018 The Android Open Source Project |
| 2 | // |
| 3 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | // you may not use this file except in compliance with the License. |
| 5 | // You may obtain a copy of the License at |
| 6 | // |
| 7 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | // |
| 9 | // Unless required by applicable law or agreed to in writing, software |
| 10 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | // See the License for the specific language governing permissions and |
| 13 | // limitations under the License. |
Micha Schwab | 01b3568 | 2018-06-28 13:56:49 +0100 | [diff] [blame] | 14 | |
Deepanjan Roy | 75b46a9 | 2018-07-24 09:11:29 -0400 | [diff] [blame] | 15 | import {TrackState} from '../common/state'; |
Deepanjan Roy | 56fa86b | 2018-08-02 10:25:56 -0400 | [diff] [blame] | 16 | |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 17 | import {TimeScale} from './time_scale'; |
Micha Schwab | 01b3568 | 2018-06-28 13:56:49 +0100 | [diff] [blame] | 18 | |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 19 | /** |
Deepanjan Roy | 56fa86b | 2018-08-02 10:25:56 -0400 | [diff] [blame] | 20 | * This interface forces track implementations to have some static properties. |
| 21 | * Typescript does not have abstract static members, which is why this needs to |
| 22 | * be in a seperate interface. |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 23 | */ |
| 24 | export interface TrackCreator { |
Hector Dearman | c62a5e3 | 2018-07-27 12:54:44 +0100 | [diff] [blame] | 25 | // Store the kind explicitly as a string as opposed to using class.kind in |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 26 | // case we ever minify our code. |
Hector Dearman | c62a5e3 | 2018-07-27 12:54:44 +0100 | [diff] [blame] | 27 | readonly kind: string; |
Deepanjan Roy | 75b46a9 | 2018-07-24 09:11:29 -0400 | [diff] [blame] | 28 | |
Deepanjan Roy | 56fa86b | 2018-08-02 10:25:56 -0400 | [diff] [blame] | 29 | // We need the |create| method because the stored value in the registry is an |
| 30 | // abstract class, and we cannot call 'new' on an abstract class. |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 31 | create(TrackState: TrackState): Track; |
| 32 | } |
Michail Schwab | beb3452 | 2018-07-20 08:15:17 -0400 | [diff] [blame] | 33 | |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 34 | /** |
| 35 | * The abstract class that needs to be implemented by all tracks. |
| 36 | */ |
| 37 | export abstract class Track { |
Deepanjan Roy | 56fa86b | 2018-08-02 10:25:56 -0400 | [diff] [blame] | 38 | // TODO: Typecheck that arg of consumeData and published data for a Track has |
| 39 | // the same type. |
| 40 | /** |
| 41 | * Receive data published by the TrackController of this track. |
| 42 | */ |
| 43 | abstract consumeData(trackData: {}): void; |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 44 | constructor(protected trackState: TrackState) {} |
| 45 | abstract renderCanvas( |
Deepanjan Roy | 62dbe56 | 2018-08-03 11:12:45 -0400 | [diff] [blame^] | 46 | ctx: CanvasRenderingContext2D, timeScale: TimeScale, |
Deepanjan Roy | 4bc80b1 | 2018-08-02 10:26:45 -0400 | [diff] [blame] | 47 | visibleWindowMs: {start: number, end: number}): void; |
Deepanjan Roy | 424485b | 2018-07-26 08:37:35 -0400 | [diff] [blame] | 48 | } |