@expofp/renderer 2.1.2 → 2.2.0

package/dist/index.d.ts

@@ -256,7 +256,7 @@ export declare interface ImageDef extends SharedDef {
 
 export declare type ImageSource = HTMLImageElement | HTMLCanvasElement | ImageBitmap | OffscreenCanvas;
 
-export declare type Index = [number, number, number];
+export declare type Index = readonly [number, number, number];
 
 export declare function isImageDef(def: RenderableDef): def is ImageDef;
 
@@ -278,9 +278,9 @@ export declare function isTextDef(def: RenderableDef): def is TextDef;
 
 export declare function isTextLayer(layer: LayerDef): layer is TypedLayerDef<TextDef>;
 
-export declare type IVector2 = Vector2 | Vector2Like | Vector2Tuple;
+export declare type IVector2 = Vector2Like | Vector2Tuple;
 
-export declare type IVector3 = Vector3 | Vector3Like | Vector3Tuple;
+export declare type IVector3 = Vector3Like | Vector3Tuple;
 
 /** Layer definition */
 export declare interface LayerDef extends SharedDef {
@@ -334,15 +334,20 @@ export declare interface PitchHandlerOptions {
 
 /** Polygon shape instance. */
 export declare class Polygon {
-    /** Array of polygon vertices. */
-    readonly vertices: Vector3[];
-    /** Array of polygon indices. Each index is a triplet of vertex indices forming a triangle. */
-    readonly indices: Index[];
+    private _indices;
+    private _vertices;
+    private _bbox;
     /**
      * @param vertices Array of polygon vertices.
      * @param indices Array of polygon indices. Each index is a triplet of vertex indices forming a triangle.
      */
     constructor(vertices: (IVector3 | IVector2)[], indices: Index[]);
+    /** Array of polygon vertices. */
+    get vertices(): readonly Vector3Like[];
+    /** Array of polygon indices. Each index is a triplet of vertex indices forming a triangle. */
+    get indices(): readonly Index[];
+    /** Bounding rectangle of the polygon. */
+    get bounds(): Rect;
     /**
      * Converts a {@link Rect} to a {@link Polygon}.
      * @param rect {@link Rect} instance
@@ -356,34 +361,58 @@ export declare class Polygon {
      */
     static merge(...polygons: Polygon[]): Polygon;
     /**
-     * Rotates all vertices of the polygon around the given center.
+     * Translates all vertices of the polygon by the given offset.
+     * @param offset Offset to translate the polygon by. Can be a 2D or 3D vector.
+     * @returns this {@link Polygon} instance
+     */
+    translate(offset: Vector2Like | Vector3Like): Polygon;
+    /**
+     * Rotates all vertices of the polygon around the given center. Only 2D rotation (around Z axis) is supported.
      * @param rotation Rotation angle in radians. Positive values rotate clockwise.
-     * @param center Center of the rotation.
+     * @param center Center of the rotation. If omitted, defaults to the bounding rectangle center.
      * @returns this {@link Polygon} instance
      */
-    rotate(rotation: number, center: Vector2Like): Polygon;
+    rotate(rotation: number, center?: Vector2Like): Polygon;
+    /**
+     * Scales the polygon around the given origin.
+     * @param scaleFactor Can be a single number or a 2D vector. If a single number is provided, both horizontal and vertical axes will be scaled by the same factor.
+     * @param origin Origin of the scaling. If omitted, defaults to the bounding rectangle center.
+     * @returns this {@link Polygon} instance
+     */
+    scale(scaleFactor: number | Vector2Like, origin?: Vector2Like): Polygon;
+    private computeBoundingRect;
 }
 
 /** Rectangle shape instance. */
 export declare class Rect {
-    /** Top left corner of the rectangle. */
-    readonly min: Vector2;
-    /** Bottom right corner of the rectangle. */
-    readonly max: Vector2;
     /** Optional rotation of the rectangle. In radians, around center. Positive values rotate clockwise. */
     rotation: number;
-    private _center?;
-    private _size?;
+    private _min;
+    private _max;
+    private _center;
+    private _size;
     /**
      * @param min Top left corner of the rectangle.
      * @param max Bottom right corner of the rectangle.
      * @param rotation Optional rotation of the rectangle. In radians, around center. Positive values rotate clockwise.
      */
     constructor(min: IVector2, max: IVector2, rotation?: number);
-    /** Center of the rectangle. Read-only, calculated on demand. */
-    get center(): Vector2;
-    /** Size of the rectangle. Read-only, calculated on demand. */
-    get size(): Vector2;
+    /** Top left corner of the rectangle. */
+    get min(): Vector2Like;
+    /** Set top left corner of the rectangle. */
+    set min(min: Vector2Like);
+    /** Bottom right corner of the rectangle. */
+    get max(): Vector2Like;
+    /** Set bottom right corner of the rectangle. */
+    set max(max: Vector2Like);
+    /** Center of the rectangle. */
+    get center(): Vector2Like;
+    /** Set center of the rectangle. */
+    set center(center: Vector2Like);
+    /** Size of the rectangle. */
+    get size(): Vector2Like;
+    /** Set size of the rectangle. */
+    set size(size: Vector2Like);
     /**
      * Creates a rectangle from an SVG rectangle element.
      * @param rect {@link SVGRectElement} or {@link SVGImageElement}
@@ -392,12 +421,20 @@ export declare class Rect {
      */
     static fromSvg(rect: SVGRectElement | SVGImageElement, rotation?: number): Rect;
     /**
-     * Increases the size of the rectangle by the given amount. Padding is added to both sides of the rectangle.
-     * @param x Horizontal padding.
-     * @param y Vertical padding. If omitted, defaults to the same value as `x`.
+     * Moves the rectangle by the given offset.
+     * @param offset Offset to move the rectangle by.
+     * @returns this {@link Rect} instance
+     */
+    translate(offset: Vector2Like): Rect;
+    /**
+     * Expands the rectangle by the given amount on all sides.
+     * Use positive values to increase the size of the rectangle, negative values to decrease it.
+     * @param expansion Can be a single number or a 2D vector. If a single number is provided, both horizontal and vertical sizes will be expanded by the same amount.
      * @returns this {@link Rect} instance
      */
-    addPadding(x: number, y?: number): this;
+    expand(expansion: number | Vector2Like): Rect;
+    private updateCenterAndSize;
+    private updateMinAndMax;
 }
 
 export declare type RenderableDef = LayerDef | ShapeDef | ImageDef | TextDef | LineDef;
@@ -505,7 +542,7 @@ export declare class Renderer {
     private updateMemoryInfo;
     private onContextLost;
     private onContextRestored;
-    private initContext;
+    private initStatsContext;
     private assertNotDisposed;
     private assertInitialized;
     private assertNotInitialized;
@@ -561,7 +598,10 @@ export declare type Shape = Rect | Polygon;
 
 /** Shape definition. */
 export declare interface ShapeDef extends SharedDef {
-    /** Shape to render. Not updatable. */
+    /**
+     * Shape to render. Updating partially supported, you can't add or remove polygon's vertices or indices.
+     * Also it's not possible to change the shape type (i.e. from polygon to rect and vice versa).
+     */
     shape: Shape;
     /** Shape's color in css format */
     color: ColorInput;
@@ -629,6 +669,10 @@ export declare interface UI {
     memoryInfoPanel: HTMLDivElement;
 }
 
+export { Vector2Like }
+
+export { Vector3Like }
+
 /** Viewport system public API. */
 export declare interface ViewportAPI {
     /**