excalibur 0.25.1 → 0.25.2

package/build/esm/index.d.ts

@@ -31,7 +31,6 @@ export * from './Collision/Index';
 import * as legacyDrawing from './Drawing/Index';
 export { legacyDrawing as LegacyDrawing };
 export * from './Interfaces/Index';
-export * from './PostProcessing/Index';
 export * from './Resources/Index';
 export * from './EntityComponentSystem/index';
 export * from './Color';
@@ -40,11 +39,12 @@ import * as events from './Events';
 export { events as Events };
 import * as input from './Input/Index';
 export { input as Input };
+export { PointerComponent } from './Input/Index';
+export { PointerSystem } from './Input/PointerSystem';
 import * as traits from './Traits/Index';
 export { traits as Traits };
 import * as util from './Util/Index';
 export { util as Util };
-export { clamp, range, toDegrees, toRadians, randomInRange, randomIntInRange, canonicalizeAngle } from './Util/Index';
 export * from './Util/Browser';
 export * from './Util/Decorators';
 export * from './Util/Detector';
@@ -54,4 +54,7 @@ export * from './Util/Observable';
 export * from './Util/Log';
 export * from './Util/SortedList';
 export * from './Util/Pool';
+export * from './Util/Fps';
+export * from './Util/Clock';
+export * from './Util/WebAudio';
 export * from './Promises';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "excalibur",
   "sideEffects": false,
-  "version": "0.25.1",
+  "version": "0.25.2",
   "exNextVersion": "0.26.0",
   "description": "Excalibur.js is a simple JavaScript game engine with TypeScript bindings for making 2D games in HTML5 Canvas. Our mission is to make web game development as simple as possible.",
   "author": "https://github.com/excaliburjs/Excalibur/graphs/contributors",
@@ -30,6 +30,7 @@
     "clean": "rimraf .tsbuildinfo ./build/dist ./build ./src/spec/*.js ./src/spec/*.map",
     "linux:ci": "npm run clean && npm run all && npm run coveralls && npm run apidocs",
     "appveyor": "npm run all && npm run nuget 0.0.1",
+    "browserstack": "karma start karma.conf.browsers.js",
     "nuget": ".\\src\\tools\\NuGet.exe pack Excalibur.nuspec -OutputDirectory .\\build\\dist -version",
     "start": "npm run core:watch",
     "build": "npm run core",
@@ -58,58 +59,61 @@
     "release": "node scripts/release.js"
   },
   "devDependencies": {
-    "@babel/core": "7.16.0",
+    "@babel/core": "7.16.7",
     "@fortawesome/fontawesome-free": "5.15.4",
     "@octokit/rest": "18.12.0",
-    "@storybook/addon-actions": "6.3.12",
-    "@storybook/addon-essentials": "6.3.12",
-    "@storybook/addon-links": "6.3.12",
-    "@storybook/builder-webpack5": "6.4.0-beta.23",
-    "@storybook/html": "6.3.12",
-    "@storybook/manager-webpack5": "6.4.0-beta.23",
-    "@types/jasmine": "3.10.1",
-    "@types/node": "14.17.32",
+    "@storybook/addon-actions": "6.4.9",
+    "@storybook/addon-essentials": "6.4.9",
+    "@storybook/addon-links": "6.4.9",
+    "@storybook/builder-webpack5": "6.4.9",
+    "@storybook/html": "6.4.9",
+    "@storybook/manager-webpack5": "6.4.9",
+    "@types/jasmine": "3.10.3",
+    "@types/node": "16.11.20",
     "@types/react-color": "3.0.6",
     "@types/webpack-env": "1.16.3",
-    "@typescript-eslint/eslint-plugin": "4.32.0",
-    "@typescript-eslint/parser": "4.32.0",
+    "@typescript-eslint/eslint-plugin": "5.9.0",
+    "@typescript-eslint/parser": "5.9.0",
     "babel-loader": "8.2.3",
-    "copy-webpack-plugin": "9.0.1",
+    "copy-webpack-plugin": "10.2.0",
     "copyfiles": "2.4.1",
     "coveralls": "3.1.1",
-    "css-loader": "6.5.0",
-    "eslint": "7.32.0",
+    "css-loader": "6.5.1",
+    "eslint": "8.6.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jsdoc": "36.1.1",
+    "eslint-plugin-jsdoc": "37.6.1",
     "excalibur-jasmine": "0.2.0",
     "istanbul": "0.4.5",
     "istanbul-instrumenter-loader": "3.0.1",
-    "jasmine": "3.9.0",
-    "jasmine-core": "3.9.0",
-    "karma": "6.3.7",
+    "jasmine": "4.0.2",
+    "jasmine-core": "4.0.0",
+    "karma": "6.3.11",
+    "karma-browserstack-launcher": "1.6.0",
     "karma-chrome-launcher": "3.1.0",
-    "karma-coverage": "2.0.3",
+    "karma-coverage": "2.1.0",
     "karma-coverage-istanbul-reporter": "3.0.3",
     "karma-jasmine": "4.0.1",
+    "karma-summary-reporter": "3.0.0",
     "karma-webpack": "5.0.0",
     "puppeteer": "10.4.0",
-    "replace-in-file": "6.3.2",
     "react": "17.0.2",
     "react-dom": "17.0.2",
+    "replace-in-file": "6.3.2",
     "rimraf": "3.0.2",
     "semver": "7.3.5",
-    "serve": "12.0.1",
-    "source-map-support": "0.5.20",
+    "serve": "13.0.2",
+    "source-map-support": "0.5.21",
     "sync-request": "6.1.0",
+    "terser-webpack-plugin": "5.3.0",
     "ts-loader": "9.2.6",
-    "typedoc": "0.22.7",
-    "typescript": "4.4.4",
+    "typedoc": "0.22.10",
+    "typescript": "4.5.4",
     "url-loader": "4.1.1",
     "wallaby-webpack": "3.9.16",
-    "webpack": "5.61.0",
+    "webpack": "5.66.0",
     "webpack-cli": "4.9.1"
   },
   "dependencies": {
-    "core-js": "3.19.0"
+    "core-js": "3.20.2"
   }
 }

package/build/dist/Graphics/Context/batch.d.ts

@@ -1,11 +0,0 @@
-import { Pool, Poolable } from '../../Util/Pool';
-export declare class BatchCommand<T> implements Poolable {
-    max: number;
-    _pool: Pool<this>;
-    commands: T[];
-    constructor(max: number);
-    isFull(): boolean;
-    canAdd(): boolean;
-    add(cmd: T): void;
-    dispose(): this;
-}

package/build/dist/Graphics/Context/draw-image-command.d.ts

@@ -1,47 +0,0 @@
-import { Matrix } from '../../Math/matrix';
-import { BoundingBox } from '../../Collision/Index';
-import { Color } from '../../Color';
-import { Pool, Poolable } from '../../Util/Pool';
-import { HTMLImageSource } from './ExcaliburGraphicsContext';
-import { Vector } from '../../Math/vector';
-export declare enum DrawCommandType {
-    Image = "image",
-    Line = "line",
-    Rectangle = "rectangle",
-    Circle = "circle"
-}
-export declare class DrawImageCommand implements Poolable {
-    _pool: Pool<this>;
-    snapToPixel: boolean;
-    image: HTMLImageSource;
-    color: Color;
-    type: DrawCommandType;
-    opacity: number;
-    width: number;
-    height: number;
-    dest: [number, number];
-    view: [number, number, number, number];
-    private _geom;
-    constructor();
-    constructor(image: HTMLImageSource, x: number, y: number);
-    constructor(image: HTMLImageSource, x: number, y: number, width?: number, height?: number);
-    constructor(image: HTMLImageSource, sx: number, sy: number, swidth?: number, sheight?: number, dx?: number, dy?: number, dwidth?: number, dheight?: number);
-    init(image?: HTMLImageSource, sx?: number, sy?: number, swidth?: number, sheight?: number, dx?: number, dy?: number, dwidth?: number, dheight?: number): this;
-    initRect(color: Color, start: Vector, width: number, height: number): this;
-    initLine(color: Color, start: Vector, end: Vector, thickness: number): this;
-    initCircle(pos: Vector, radius: number, color: Color): this;
-    dispose(): this;
-    applyTransform(transform: Matrix, opacity: number): void;
-    get geometry(): [number, number][];
-}
-export declare class DrawRectCommand {
-    dest: [number, number];
-    width: number;
-    height: number;
-    constructor(x: number, y: number, width: number, height: number);
-}
-export declare class DrawDebugRectCommand {
-    bounds: BoundingBox;
-    color: Color;
-    constructor(bounds: BoundingBox, color: Color);
-}

package/build/dist/Graphics/Context/image-renderer.d.ts

@@ -1,39 +0,0 @@
-import { Shader } from './shader';
-import { BatchCommand } from './batch';
-import { DrawImageCommand } from './draw-image-command';
-import { BatchRenderer } from './renderer';
-import { WebGLGraphicsContextInfo } from './ExcaliburGraphicsContextWebGL';
-import { HTMLImageSource } from './ExcaliburGraphicsContext';
-import { Color } from '../../Color';
-import { Vector } from '../..';
-export declare class BatchImage extends BatchCommand<DrawImageCommand> {
-    maxDraws: number;
-    maxTextures: number;
-    textures: WebGLTexture[];
-    commands: DrawImageCommand[];
-    private _graphicMap;
-    constructor(maxDraws: number, maxTextures: number);
-    isFull(): boolean;
-    canAdd(): boolean;
-    private _isCommandFull;
-    private _isTextureFull;
-    private _wouldAddTexture;
-    maybeAdd(command: DrawImageCommand): boolean;
-    add(command: DrawImageCommand): void;
-    bindTextures(gl: WebGLRenderingContext): void;
-    getBatchTextureId(command: DrawImageCommand): number;
-    dispose(): this;
-    clear(): void;
-}
-export declare class ImageRenderer extends BatchRenderer<DrawImageCommand> {
-    private _contextInfo;
-    constructor(gl: WebGLRenderingContext, _contextInfo: WebGLGraphicsContextInfo);
-    buildShader(gl: WebGLRenderingContext): Shader;
-    private _transformFragmentSource;
-    addCircle(pos: Vector, radius: number, color: Color): void;
-    addRectangle(color: Color, pos: Vector, width: number, height: number): void;
-    addLine(color: Color, start: Vector, end: Vector, thickness?: number): void;
-    addImage(graphic: HTMLImageSource, sx: number, sy: number, swidth?: number, sheight?: number, dx?: number, dy?: number, dwidth?: number, dheight?: number): void;
-    renderBatch(gl: WebGLRenderingContext, batch: BatchImage, vertexCount: number): void;
-    buildBatchVertices(vertexBuffer: Float32Array, batch: BatchImage): number;
-}

package/build/dist/Graphics/Context/line-renderer.d.ts

@@ -1,22 +0,0 @@
-import { Vector } from '../../Math/vector';
-import { Color } from '../../Color';
-import { Shader } from './shader';
-import { BatchRenderer } from './renderer';
-import { BatchCommand } from './batch';
-import { WebGLGraphicsContextInfo } from './ExcaliburGraphicsContextWebGL';
-import { Pool, Poolable } from '../../Util/Pool';
-export declare class DrawLine implements Poolable {
-    _pool?: Pool<this>;
-    color: Color;
-    start: Vector;
-    end: Vector;
-    dispose(): this;
-}
-export declare class LineRenderer extends BatchRenderer<DrawLine> {
-    private _contextInfo;
-    constructor(gl: WebGLRenderingContext, _contextInfo: WebGLGraphicsContextInfo);
-    buildShader(gl: WebGLRenderingContext): Shader;
-    addLine(start: Vector, end: Vector, color: Color): void;
-    buildBatchVertices(vertexBuffer: Float32Array, batch: BatchCommand<DrawLine>): number;
-    renderBatch(gl: WebGLRenderingContext, _batch: BatchCommand<DrawLine>, vertexCount: number): void;
-}

package/build/dist/Graphics/Context/point-renderer.d.ts

@@ -1,22 +0,0 @@
-import { Shader } from './shader';
-import { Vector } from '../../Math/vector';
-import { Color } from '../../Color';
-import { BatchRenderer } from './renderer';
-import { BatchCommand } from './batch';
-import { WebGLGraphicsContextInfo } from './ExcaliburGraphicsContextWebGL';
-import { Pool, Poolable } from '../../Util/Pool';
-export declare class DrawPoint implements Poolable {
-    _pool?: Pool<this>;
-    point: Vector;
-    color: Color;
-    size: number;
-    dispose(): this;
-}
-export declare class PointRenderer extends BatchRenderer<DrawPoint> {
-    private _contextInfo;
-    constructor(gl: WebGLRenderingContext, _contextInfo: WebGLGraphicsContextInfo);
-    buildShader(gl: WebGLRenderingContext): Shader;
-    addPoint(point: Vector, color: Color, size: number): void;
-    buildBatchVertices(vertexBuffer: Float32Array, batch: BatchCommand<DrawPoint>): number;
-    renderBatch(gl: WebGLRenderingContext, _batch: BatchCommand<DrawPoint>, vertexCount: number): void;
-}

package/build/dist/Graphics/Context/shaders/image-fragment.glsl

@@ -1,48 +0,0 @@
-#ifdef GL_OES_standard_derivatives
-#extension GL_OES_standard_derivatives : enable
-#endif
-precision mediump float;
-
-// UV coord
-varying vec2 v_texcoord;
-
-// Texture index
-varying lowp float v_textureIndex;
-
-// Color coord to blend with image
-varying lowp vec4 v_color;
-
-// Opacity
-varying float v_opacity;
-
-uniform sampler2D u_textures[%%count%%];
-
-float circle(in vec2 st, in float radius) {
-  vec2 dist = st - vec2(0.5);
-  float r = dot(dist, dist) * 4.0;
-  float delta = fwidth(r);
-  return 1.0 - smoothstep(radius - delta, radius + delta, r);
-}
-
-void main() {
-  float r = 0.0, delta = 0.0, alpha = 1.0;
-   // In order to support the most efficient sprite batching, we have multiple
-   // textures loaded into the gpu (usually 8) this picker logic skips over textures
-   // that do not apply to a particular sprite.
-
-   vec4 color;
-   // -1 If there is no texture to sample we are drawing a solid geometry (rectangles)
-   if (v_textureIndex == -1.0) {
-     color = v_color;
-     color.w = color.w * v_opacity;
-   // -2 If there is no texture we are drawing a circle
-   } else if (v_textureIndex == -2.0) {
-     color = v_color;
-     color.a = color.a * circle(v_texcoord, .95);
-   } else {
-     // GLSL is templated out to pick the right texture and set the vec4 color
-      %%texture_picker%%
-   }
-   color.w = color.w * v_opacity;
-   gl_FragColor = color;
-}

package/build/dist/Input/Pointer.d.ts

@@ -1,134 +0,0 @@
-import { Actor } from '../Actor';
-import { Vector } from '../Math/vector';
-import { Class } from '../Class';
-import { PointerMoveEvent, PointerDownEvent, PointerUpEvent, WheelEvent } from './PointerEvents';
-export interface ActorsUnderPointer {
-    [ActorId: number]: Actor;
-    length: number;
-}
-/**
- * The type of pointer for a [[PointerEvent]].
- */
-export declare enum PointerType {
-    Touch = "Touch",
-    Mouse = "Mouse",
-    Pen = "Pen",
-    Unknown = "Unknown"
-}
-/**
- * Determines the scope of handling mouse/touch events. See [[Pointers]] for more information.
- */
-export declare enum PointerScope {
-    /**
-     * Handle events on the `canvas` element only. Events originating outside the
-     * `canvas` will not be handled.
-     */
-    Canvas = "Canvas",
-    /**
-     * Handles events on the entire document. All events will be handled by Excalibur.
-     */
-    Document = "Document"
-}
-/**
- * Captures and dispatches PointerEvents
- */
-export declare class Pointer extends Class {
-    private static _MAX_ID;
-    readonly id: number;
-    private _isDown;
-    private _wasDown;
-    private _actorsUnderPointer;
-    private _actors;
-    private _actorsLastFrame;
-    private _actorsNoLongerUnderPointer;
-    private _actorSortingFcn;
-    /**
-     * Whether the Pointer is currently dragging.
-     */
-    get isDragging(): boolean;
-    /**
-     * Whether the Pointer just started dragging.
-     */
-    get isDragStart(): boolean;
-    /**
-     * Whether the Pointer just ended dragging.
-     */
-    get isDragEnd(): boolean;
-    /**
-     * Returns true if pointer has any actors under
-     */
-    get hasActorsUnderPointer(): boolean;
-    /**
-     * The last position on the document this pointer was at. Can be `null` if pointer was never active.
-     */
-    lastPagePos: Vector;
-    /**
-     * The last position on the screen this pointer was at. Can be `null` if pointer was never active.
-     */
-    lastScreenPos: Vector;
-    /**
-     * The last position in the game world coordinates this pointer was at. Can be `null` if pointer was never active.
-     */
-    lastWorldPos: Vector;
-    /**
-     * Returns the currently dragging target or null if it isn't exist
-     */
-    dragTarget: Actor;
-    constructor();
-    on(event: 'move', handler: (event: PointerMoveEvent) => void): void;
-    on(event: 'down', handler: (event: PointerDownEvent) => void): void;
-    on(event: 'up', handler: (event: PointerUpEvent) => void): void;
-    on(event: 'wheel', handler: (event: WheelEvent) => void): void;
-    once(event: 'move', handler: (event: PointerMoveEvent) => void): void;
-    once(event: 'down', handler: (event: PointerDownEvent) => void): void;
-    once(event: 'up', handler: (event: PointerUpEvent) => void): void;
-    once(event: 'wheel', handler: (event: WheelEvent) => void): void;
-    off(event: 'move', handler?: (event: PointerMoveEvent) => void): void;
-    off(event: 'down', handler?: (event: PointerDownEvent) => void): void;
-    off(event: 'up', handler?: (event: PointerUpEvent) => void): void;
-    off(event: 'wheel', handler?: (event: WheelEvent) => void): void;
-    /**
-     * Update the state of current pointer, meant to be called a the end of frame
-     */
-    update(): void;
-    /**
-     * Adds an Actor to actorsUnderPointer object.
-     * @param actor An Actor to be added;
-     */
-    addActorUnderPointer(actor: Actor): void;
-    /**
-     * Removes an Actor from actorsUnderPointer object.
-     * @param actor An Actor to be removed;
-     */
-    removeActorUnderPointer(actor: Actor): void;
-    /**
-     * Returns all actors under this pointer this frame
-     */
-    getActorsUnderPointer(): Actor[];
-    /**
-     * Returns all actors that are no longer under the pointer this frame
-     */
-    getActorsUnderPointerLastFrame(): Actor[];
-    /**
-     * Returns all actors relevant for events to pointer this frame
-     */
-    getActorsForEvents(): Actor[];
-    /**
-     * Checks if Pointer location has a specific Actor bounds contained underneath.
-     * @param actor An Actor for check;
-     */
-    checkActorUnderPointer(actor: Actor): boolean;
-    /**
-     * Checks if an actor was under the pointer last frame
-     * @param actor
-     */
-    wasActorUnderPointer(actor: Actor): boolean;
-    /**
-     * Checks if Pointer has a specific Actor in ActorsUnderPointer list.
-     * @param actor An Actor for check;
-     */
-    isActorAliveUnderPointer(actor: Actor): boolean;
-    private _onPointerMove;
-    private _onPointerDown;
-    private _onPointerUp;
-}

package/build/dist/Input/PointerEvents.d.ts

@@ -1,170 +0,0 @@
-import { Actor } from '../Actor';
-import { GlobalCoordinates } from '../Math/global-coordinates';
-import { Vector } from '../Math/vector';
-import { Pointer, PointerType } from './Pointer';
-import { GameEvent } from '../Events';
-/**
- * Native browser button enumeration
- */
-export declare enum NativePointerButton {
-    NoButton = -1,
-    Left = 0,
-    Middle = 1,
-    Right = 2,
-    Unknown = 3
-}
-/**
- * The mouse button being pressed.
- */
-export declare enum PointerButton {
-    Left = "Left",
-    Middle = "Middle",
-    Right = "Right",
-    Unknown = "Unknown",
-    NoButton = "NoButton"
-}
-export declare enum WheelDeltaMode {
-    Pixel = "Pixel",
-    Line = "Line",
-    Page = "Page"
-}
-/**
- * Type that indicates Excalibur's valid synthetic pointer events
- */
-export declare type PointerEventName = 'pointerdragstart' | 'pointerdragend' | 'pointerdragmove' | 'pointerdragenter' | 'pointerdragleave' | 'pointermove' | 'pointerenter' | 'pointerleave' | 'pointerup' | 'pointerdown';
-/**
- * Pointer events
- *
- * Represents a mouse, touch, or stylus event. See [[Pointers]] for more information on
- * handling pointer input.
- *
- * For mouse-based events, you can inspect [[PointerEvent.button]] to see what button was pressed.
- */
-export declare class PointerEvent extends GameEvent<Actor> {
-    protected coordinates: GlobalCoordinates;
-    pointer: Pointer;
-    index: number;
-    pointerType: PointerType;
-    button: PointerButton;
-    ev: any;
-    protected _name: string;
-    get name(): string;
-    /** The world coordinates of the event. */
-    get worldPos(): Vector;
-    /** The page coordinates of the event. */
-    get pagePos(): Vector;
-    /** The screen coordinates of the event. */
-    get screenPos(): Vector;
-    /**
-     * @param coordinates         The [[GlobalCoordinates]] of the event
-     * @param pointer             The [[Pointer]] of the event
-     * @param index               The index of the pointer (zero-based)
-     * @param pointerType         The type of pointer
-     * @param button              The button pressed (if [[PointerType.Mouse]])
-     * @param ev                  The raw DOM event being handled
-     */
-    constructor(coordinates: GlobalCoordinates, pointer: Pointer, index: number, pointerType: PointerType, button: PointerButton, ev: any);
-    get pos(): Vector;
-    _canceled: boolean;
-    /**
-     * Cancels pointer event propogation, event will not be transmitted to any other actors
-     */
-    cancel(): void;
-    /**
-     *
-     * @returns If the event is canceled it will no longer be transmitted to any other actors
-     */
-    isCanceled(): boolean;
-    propagate(actor: Actor): void;
-    /**
-     * Action, that calls when event happens
-     */
-    doAction(actor: Actor): void;
-    protected _onActionStart(_actor?: Actor): void;
-    protected _onActionEnd(_actor?: Actor): void;
-}
-export declare class PointerEventFactory<T extends PointerEvent> {
-    protected _pointerEventType: new (coordinates: GlobalCoordinates, pointer: Pointer, index: number, pointerType: PointerType, button: PointerButton, ev: any) => T;
-    constructor(_pointerEventType: new (coordinates: GlobalCoordinates, pointer: Pointer, index: number, pointerType: PointerType, button: PointerButton, ev: any) => T);
-    /**
-     * Create specific PointerEvent
-     */
-    create(coordinates: GlobalCoordinates, pointer: Pointer, index: number, pointerType: PointerType, button: PointerButton, ev: any): T;
-}
-export declare class PointerDragEvent extends PointerEvent {
-}
-export declare class PointerUpEvent extends PointerEvent {
-    protected _name: string;
-    protected _onActionEnd(actor: Actor): void;
-}
-export declare class PointerDownEvent extends PointerEvent {
-    protected _name: string;
-    protected _onActionEnd(actor: Actor): void;
-}
-export declare class PointerMoveEvent extends PointerEvent {
-    protected _name: string;
-    propagate(actor: Actor): void;
-    protected _onActionStart(actor: Actor): void;
-}
-export declare class PointerEnterEvent extends PointerEvent {
-    protected _name: string;
-    protected _onActionStart(actor: Actor): void;
-    protected _onActionEnd(actor: Actor): void;
-}
-export declare class PointerLeaveEvent extends PointerEvent {
-    protected _name: string;
-    protected _onActionStart(actor: Actor): void;
-    protected _onActionEnd(actor: Actor): void;
-}
-export declare class PointerCancelEvent extends PointerEvent {
-    protected _name: string;
-}
-/**
- * Wheel Events
- *
- * Represents a mouse wheel event. See [[Pointers]] for more information on
- * handling point input.
- */
-export declare class WheelEvent extends GameEvent<Actor> {
-    x: number;
-    y: number;
-    pageX: number;
-    pageY: number;
-    screenX: number;
-    screenY: number;
-    index: number;
-    deltaX: number;
-    deltaY: number;
-    deltaZ: number;
-    deltaMode: WheelDeltaMode;
-    ev: any;
-    /**
-     * @param x            The `x` coordinate of the event (in world coordinates)
-     * @param y            The `y` coordinate of the event (in world coordinates)
-     * @param pageX        The `x` coordinate of the event (in document coordinates)
-     * @param pageY        The `y` coordinate of the event (in document coordinates)
-     * @param screenX      The `x` coordinate of the event (in screen coordinates)
-     * @param screenY      The `y` coordinate of the event (in screen coordinates)
-     * @param index        The index of the pointer (zero-based)
-     * @param deltaX       The type of pointer
-     * @param deltaY       The type of pointer
-     * @param deltaZ       The type of pointer
-     * @param deltaMode    The type of movement [[WheelDeltaMode]]
-     * @param ev           The raw DOM event being handled
-     */
-    constructor(x: number, y: number, pageX: number, pageY: number, screenX: number, screenY: number, index: number, deltaX: number, deltaY: number, deltaZ: number, deltaMode: WheelDeltaMode, ev: any);
-    private _isCanceled;
-    /**
-     * Cancels pointer event propogation, event will not be transmitted to any other actors
-     */
-    cancel(): void;
-    /**
-     *
-     * @returns If the event is canceled it will no longer be transmitted to any other actors
-     */
-    isCanceled(): boolean;
-}
-/**
- *
- */
-export declare function createPointerEventByName(eventName: string, coordinates: GlobalCoordinates, pointer: Pointer, index: number, pointerType: PointerType, button: PointerButton, ev: any): PointerEvent;