@galacean/effects-core 2.1.0-alpha.1 → 2.1.0-alpha.11

package/dist/material/material.d.ts

@@ -51,7 +51,6 @@ export interface MaterialProps {
  * Material 抽象类
  */
 export declare abstract class Material extends EffectsObject implements Disposable {
-    shader: Shader;
     shaderVariant: ShaderVariant;
     shaderSource: ShaderWithSource;
     stringTags: Record<string, string>;
@@ -62,11 +61,15 @@ export declare abstract class Material extends EffectsObject implements Disposab
     readonly props: MaterialProps;
     protected destroyed: boolean;
     protected initialized: boolean;
+    protected shaderDirty: boolean;
+    private _shader;
     /**
      *
      * @param props - 材质属性
      */
     constructor(engine: Engine, props?: MaterialProps);
+    get shader(): Shader;
+    set shader(value: Shader);
     /******** effects-core 中会调用 引擎必须实现 ***********************/
     /**
      * 设置 Material 的颜色融合开关

package/dist/math/index.d.ts

@@ -1,4 +1,4 @@
 export * from './float16array-wrapper';
 export * from './translate';
 export * from './utils';
-export * from './value-getter';
+export * from './value-getters';

package/dist/math/translate.d.ts

@@ -1,6 +1,6 @@
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import type { ItemLinearVelOverLifetime } from '../plugins';
-import type { ValueGetter } from './value-getter';
+import type { ValueGetter } from './value-getters';
 export declare function translatePoint(x: number, y: number): number[];
 export interface TranslateTarget {
     speedOverLifetime?: ValueGetter<number>;

package/dist/math/value-getters/color-curve.d.ts

@@ -0,0 +1,12 @@
+import { Color } from '@galacean/effects-math/es/core/color';
+import { ValueGetter } from './value-getter';
+import type * as spec from '@galacean/effects-specification';
+export declare class ColorCurve extends ValueGetter<Color> {
+    private value;
+    private rCurve;
+    private gCurve;
+    private bCurve;
+    private aCurve;
+    onCreate(arg: spec.ColorCurveData): void;
+    getValue(t: number): Color;
+}

package/dist/math/value-getters/index.d.ts

@@ -0,0 +1,4 @@
+export * from './value-getter';
+export * from './color-curve';
+export * from './vector4-curve';
+export * from './value-getter-map';

package/dist/math/value-getters/value-getter-map.d.ts

@@ -0,0 +1,2 @@
+import { ValueGetter } from './value-getter';
+export declare function createValueGetter(args: any): ValueGetter<any>;

package/dist/math/{value-getter.d.ts → value-getters/value-getter.d.ts}

@@ -2,9 +2,9 @@ import type { Vector2 } from '@galacean/effects-math/es/core/vector2';
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import { Quaternion } from '@galacean/effects-math/es/core/quaternion';
 import * as spec from '@galacean/effects-specification';
-import type { ColorStop } from '../utils';
-import type { BezierEasing } from './bezier';
-import { BezierPath, BezierQuat } from './bezier';
+import type { ColorStop } from '../../utils';
+import type { BezierEasing } from '../bezier';
+import { BezierPath, BezierQuat } from '../bezier';
 interface KeyFrameMeta {
     curves: ValueGetter<any>[];
     index: number;
@@ -97,8 +97,11 @@ export declare class BezierCurve extends ValueGetter<number> {
         timeInterval: number;
         valueInterval: number;
         curve: BezierEasing;
+        timeStart: number;
+        timeEnd: number;
     }>;
     keys: number[][];
+    keyTimeData: string[];
     onCreate(props: spec.BezierKeyframeValue[]): void;
     getValue(time: number): number;
     getIntegrateValue(t0: number, t1: number, ts?: number): number;
@@ -142,7 +145,6 @@ export declare class BezierCurveQuat extends ValueGetter<Quaternion> {
     getPercValue(curveKey: string, time: number): number;
     getMaxTime(): number;
 }
-export declare function createValueGetter(args: any): ValueGetter<any>;
 export declare function getKeyFrameMetaByRawValue(meta: KeyFrameMeta, value?: [type: spec.ValueType, value: any]): void;
 export declare function createKeyFrameMeta(): {
     curves: never[];

package/dist/math/value-getters/vector4-curve.d.ts

@@ -0,0 +1,12 @@
+import { Vector4 } from '@galacean/effects-math/es/core/vector4';
+import { ValueGetter } from './value-getter';
+import type * as spec from '@galacean/effects-specification';
+export declare class Vector4Curve extends ValueGetter<Vector4> {
+    private value;
+    private xCurve;
+    private yCurve;
+    private zCurve;
+    private wCurve;
+    onCreate(arg: spec.Vector4CurveData): void;
+    getValue(t: number): Vector4;
+}

package/dist/plugin-system.d.ts

@@ -3,8 +3,7 @@ import type { Composition } from './composition';
 import type { Plugin, PluginConstructor } from './plugins';
 import type { RenderFrame, Renderer } from './render';
 import type { Scene, SceneLoadOptions } from './scene';
-import type { VFXItemConstructor, VFXItemProps } from './vfx-item';
-import { VFXItem } from './vfx-item';
+import type { VFXItemConstructor } from './vfx-item';
 export declare const pluginLoaderMap: Record<string, PluginConstructor>;
 export declare const defaultPlugins: string[];
 export type PrecompileOptions = {
@@ -25,9 +24,12 @@ export declare class PluginSystem {
     initializeComposition(composition: Composition, scene: Scene): void;
     destroyComposition(comp: Composition): void;
     resetComposition(comp: Composition, renderFrame: RenderFrame): void;
-    createPluginItem(name: string, props: VFXItemProps, composition: Composition): VFXItem;
     processRawJSON(json: spec.JSONScene, options: SceneLoadOptions): Promise<void[]>;
+    processAssets(json: spec.JSONScene, options?: SceneLoadOptions): Promise<{
+        assets: spec.AssetBase[];
+        loadedAssets: unknown[];
+    }[]>;
+    precompile(compositions: spec.CompositionData[], renderer: Renderer, options?: PrecompileOptions): Promise<unknown[]>;
+    loadResources(scene: Scene, options: SceneLoadOptions): Promise<unknown[]>;
     private callStatic;
-    precompile(compositions: spec.CompositionData[], renderer: Renderer, options?: PrecompileOptions): Promise<void[]>;
-    loadResources(scene: Scene, options: SceneLoadOptions): Promise<void[]>;
 }

package/dist/plugins/cal/calculate-item.d.ts

@@ -1,7 +1,8 @@
-import type { Euler, Vector3 } from '@galacean/effects-math/es/core/index';
+import type { Euler } from '@galacean/effects-math/es/core/euler';
+import type { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import type { ValueGetter } from '../../math';
-import { TrackAsset } from '../timeline/track';
-import type { TimelineAsset } from './timeline-asset';
+import { TrackAsset } from '../timeline';
+import type { TimelineAsset } from '../timeline';
 /**
  * 基础位移属性数据
  */
@@ -22,5 +23,6 @@ export type ItemLinearVelOverLifetime = {
  * @since 2.0.0
  */
 export declare class ObjectBindingTrack extends TrackAsset {
+    updateAnimatedObject(): void;
     create(timelineAsset: TimelineAsset): void;
 }

package/dist/plugins/cal/calculate-loader.d.ts

@@ -1,3 +1,3 @@
-import { AbstractPlugin } from '../index';
+import { AbstractPlugin } from '../plugin';
 export declare class CalculateLoader extends AbstractPlugin {
 }

package/dist/plugins/cal/calculate-vfx-item.d.ts

@@ -42,7 +42,7 @@ export declare class TransformAnimationPlayable extends AnimationPlayable {
     startSpeed: number;
     data: TransformPlayableAssetData;
     private velocity;
-    private binding;
+    private boundObject;
     start(): void;
     processFrame(context: FrameContext): void;
     /**

package/dist/plugins/cal/playable-graph.d.ts

@@ -22,7 +22,7 @@ export declare class PlayableGraph {
 export declare class Playable implements Disposable {
     onPlayablePlayFlag: boolean;
     onPlayablePauseFlag: boolean;
-    overrideTimeNextEvaluation: boolean;
+    private duration;
     private destroyed;
     private inputs;
     private inputOuputPorts;
@@ -50,6 +50,8 @@ export declare class Playable implements Disposable {
     setInputWeight(inputIndex: number, weight: number): void;
     setTime(time: number): void;
     getTime(): number;
+    setDuration(duration: number): void;
+    getDuration(): number;
     getPlayState(): PlayState;
     setTraversalMode(mode: PlayableTraversalMode): void;
     getTraversalMode(): PlayableTraversalMode;
@@ -82,7 +84,7 @@ export declare class PlayableOutput {
     protected time: number;
     private sourceOutputPort;
     constructor();
-    setSourcePlayeble(playable: Playable, port?: number): void;
+    setSourcePlayable(playable: Playable, port?: number): void;
     getSourceOutputPort(): number;
     setUserData(value: object): void;
     getUserData(): object;

package/dist/plugins/camera/camera-vfx-item-loader.d.ts

@@ -1,3 +1,3 @@
-import { AbstractPlugin } from '../index';
+import { AbstractPlugin } from '../plugin';
 export declare class CameraVFXItemLoader extends AbstractPlugin {
 }

package/dist/plugins/index.d.ts

@@ -7,6 +7,7 @@ export * from './interact/interact-loader';
 export * from './interact/interact-mesh';
 export * from './interact/interact-vfx-item';
 export * from './interact/interact-item';
+export * from './interact/mesh-collider';
 export * from './sprite/sprite-loader';
 export * from './sprite/sprite-item';
 export * from './sprite/sprite-mesh';
@@ -18,11 +19,5 @@ export * from './particle/particle-system-renderer';
 export * from './cal/calculate-loader';
 export * from './cal/calculate-vfx-item';
 export * from './cal/calculate-item';
-export * from './timeline/track';
-export * from './timeline/tracks/transform-track';
-export * from './timeline/tracks/activation-track';
-export * from './timeline/tracks/sprite-color-track';
-export * from './timeline/tracks/sub-composition-track';
-export * from './timeline/playables/sub-composition-playable-asset';
-export * from './cal/timeline-asset';
+export * from './timeline';
 export * from './text';

package/dist/plugins/interact/interact-item.d.ts

@@ -6,6 +6,7 @@ import { RendererComponent } from '../../components';
 import type { DragEventType } from './interact-vfx-item';
 import type { Renderer } from '../../render';
 /**
+ * 交互组件
  * @since 2.0.0
  */
 export declare class InteractComponent extends RendererComponent {
@@ -22,12 +23,24 @@ export declare class InteractComponent extends RendererComponent {
      * 拖拽的距离映射系数，越大越容易拖动
      */
     dragRatio: number[];
+    /**
+     * 拖拽X范围
+     */
+    dragRange: {
+        dxRange: [min: number, max: number];
+        dyRange: [min: number, max: number];
+    };
     /** 是否响应点击和拖拽交互事件 */
     private _interactive;
-    private hasBeenAddedToComposition;
     set interactive(enable: boolean);
     get interactive(): boolean;
+    getDragRangeX(): [min: number, max: number];
+    setDragRangeX(min: number, max: number): void;
+    getDragRangeY(): [min: number, max: number];
+    setDragRangeY(min: number, max: number): void;
     onStart(): void;
+    onDisable(): void;
+    onEnable(): void;
     onUpdate(dt: number): void;
     render(renderer: Renderer): void;
     onDestroy(): void;

package/dist/plugins/interact/interact-loader.d.ts

@@ -1,3 +1,3 @@
-import { AbstractPlugin } from '../index';
+import { AbstractPlugin } from '../plugin';
 export declare class InteractLoader extends AbstractPlugin {
 }

package/dist/plugins/interact/mesh-collider.d.ts

@@ -0,0 +1,15 @@
+import type { Geometry } from '../../render/geometry';
+import type { BoundingBoxTriangle } from './click-handler';
+import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
+/**
+ *
+ */
+export declare class MeshCollider {
+    private boundingBoxData;
+    private geometry;
+    private triangles;
+    getBoundingBoxData(): BoundingBoxTriangle;
+    getBoundingBox(): BoundingBoxTriangle;
+    setGeometry(geometry: Geometry, worldMatrix?: Matrix4): void;
+    private geometryToTriangles;
+}

package/dist/plugins/particle/burst.d.ts

@@ -7,6 +7,8 @@ interface BurstOptions {
     probability: number;
 }
 export declare class Burst {
+    once: boolean;
+    disabled: boolean;
     private now;
     private index;
     private internalCycles;

package/dist/plugins/particle/particle-mesh.d.ts

@@ -2,7 +2,6 @@ import type * as spec from '@galacean/effects-specification';
 import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
 import { Vector2 } from '@galacean/effects-math/es/core/vector2';
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
-import { Matrix3 } from '@galacean/effects-math/es/core/matrix3';
 import type { Engine } from '../../engine';
 import { ValueGetter } from '../../math';
 import type { GPUCapability, SharedShaderWithSource } from '../../render';
@@ -139,6 +138,10 @@ export declare class ParticleMesh implements ParticleMeshData {
     readonly textureOffsets: number[];
     readonly maxCount: number;
     readonly anchor: Vector2;
+    private cachedRotationVector3;
+    private cachedRotationMatrix;
+    private cachedLinearMove;
+    private tempMatrix3;
     VERT_MAX_KEY_FRAME_COUNT: number;
     constructor(engine: Engine, props: ParticleMeshProps);
     getPointColor(index: number): number[];
@@ -146,12 +149,12 @@ export declare class ParticleMesh implements ParticleMeshData {
     resetGeometryData(geometry: Geometry): void;
     onUpdate(dt: number): void;
     minusTime(time: number): void;
-    calculateTranslation(velocity: Vector3, t0: number, t1: number, duration: number): Vector3;
-    transformFromRotation(rot: Vector3, life: number, dur: number, aSeed: number): Matrix3;
-    mat3FromRotation(rotation: Vector3): Matrix3;
-    calLinearMov(time: number, duration: number, aSeed: number): Vector3;
     removePoint(index: number): void;
     setPoint(index: number, point: Point): void;
+    private applyTranslation;
+    private applyRotation;
+    private applyLinearMove;
+    private expandArray;
 }
 export declare function getParticleMeshShader(item: spec.ParticleItem, gpuCapability: GPUCapability, env?: string): {
     shader: SharedShaderWithSource;

package/dist/plugins/particle/particle-system.d.ts

@@ -6,10 +6,9 @@ import { Component } from '../../components';
 import type { Engine } from '../../engine';
 import type { ValueGetter } from '../../math';
 import type { Mesh } from '../../render';
-import type { ShapeGenerator } from '../../shape';
+import type { ShapeGenerator, ShapeParticle } from '../../shape';
 import { Texture } from '../../texture';
 import { Transform } from '../../transform';
-import { type color } from '../../utils';
 import type { BoundingBoxSphere, HitTestCustomParams } from '../interact/click-handler';
 import { Burst } from './burst';
 import type { Point } from './particle-mesh';
@@ -24,7 +23,7 @@ type ParticleOptions = {
     startSpeed: ValueGetter<number>;
     startLifetime: ValueGetter<number>;
     startDelay: ValueGetter<number>;
-    startColor: ValueGetter<color>;
+    startColor: ValueGetter<spec.RGBAColorValue>;
     start3DRotation?: boolean;
     startRotationX?: ValueGetter<number>;
     startRotationY?: ValueGetter<number>;
@@ -188,7 +187,7 @@ export declare class ParticleSystem extends Component {
      * 通过粒子参数获取当前时刻粒子的位置
      */
     getPointPosition(point: Point): Vector3;
-    initPoint(data: Record<string, any>): Point;
+    initPoint(data: ShapeParticle): Point;
     addBurst(burst: Burst, offsets: vec3[]): number;
     removeBurst(index: number): void;
     createPoint(lifetime: number): Point;

package/dist/plugins/plugin.d.ts

@@ -6,7 +6,7 @@ import type { Composition } from '../composition';
 export interface Plugin {
     /**
      * plugin 的数组内排序，按照升序排列
-     * 默认为100
+     * @default 100
      */
     order: number;
     name: string;
@@ -88,7 +88,7 @@ export declare abstract class AbstractPlugin implements Plugin {
     order: number;
     name: string;
     /***
-     * player.loadScene 函数调用的时候会触发此函数，
+     * loadScene 函数调用的时候会触发此函数，
      * 此阶段可以对资源 JSON 进行处理，替换调 JSON 中的数据，或者直接终止加载流程
      * 一旦被 reject，加载过程将失败
      * @param json 动画资源
@@ -96,7 +96,18 @@ export declare abstract class AbstractPlugin implements Plugin {
      */
     static processRawJSON: (json: spec.JSONScene, options: SceneLoadOptions) => Promise<void>;
     /**
-     * player.loadScene 函数调用的时候会触发此函数，
+     * loadScene 函数调用的时候会触发此函数，
+     * 此阶段可以加载插件所需类型资源，并返回原始资源和加载后的资源。
+     * @param json
+     * @param options
+     * @returns
+     */
+    static processAssets: (json: spec.JSONScene, options?: SceneLoadOptions) => Promise<{
+        assets: spec.AssetBase[];
+        loadedAssets: unknown[];
+    }>;
+    /**
+     * loadScene 函数调用的时候会触发此函数，
      * 此阶段时，json 中的图片和二进制已经被加载完成，可以对加载好的资源做进一步处理，
      * 如果 promise 被 reject, loadScene 函数同样会被 reject，表示场景加载失败。
      * 请记住，整个 load 阶段都不要创建 GL 相关的对象，只创建 JS 对象

package/dist/plugins/shape/build-adaptive-bezier.d.ts

@@ -0,0 +1 @@
+export declare function buildAdaptiveBezier(points: number[], sX: number, sY: number, cp1x: number, cp1y: number, cp2x: number, cp2y: number, eX: number, eY: number, smoothness?: number): number[];

package/dist/plugins/shape/ellipse.d.ts

@@ -0,0 +1,79 @@
+import { ShapePrimitive } from './shape-primitive';
+/**
+ * The Ellipse object is used to help draw graphics and can also be used to specify a hit area for containers.
+ */
+export declare class Ellipse extends ShapePrimitive {
+    /**
+     * The X coordinate of the center of this ellipse
+     * @default 0
+     */
+    x: number;
+    /**
+     * The Y coordinate of the center of this ellipse
+     * @default 0
+     */
+    y: number;
+    /**
+     * The half width of this ellipse
+     * @default 0
+     */
+    halfWidth: number;
+    /**
+     * The half height of this ellipse
+     * @default 0
+     */
+    halfHeight: number;
+    /**
+     * The type of the object, mainly used to avoid `instanceof` checks
+     * @default 'ellipse'
+     */
+    readonly type = "ellipse";
+    /**
+     * @param x - The X coordinate of the center of this ellipse
+     * @param y - The Y coordinate of the center of this ellipse
+     * @param halfWidth - The half width of this ellipse
+     * @param halfHeight - The half height of this ellipse
+     */
+    constructor(x?: number, y?: number, halfWidth?: number, halfHeight?: number);
+    /**
+     * Creates a clone of this Ellipse instance
+     * @returns {Ellipse} A copy of the ellipse
+     */
+    clone(): Ellipse;
+    /**
+     * Checks whether the x and y coordinates given are contained within this ellipse
+     * @param x - The X coordinate of the point to test
+     * @param y - The Y coordinate of the point to test
+     * @returns Whether the x/y coords are within this ellipse
+     */
+    contains(x: number, y: number): boolean;
+    /**
+     * Checks whether the x and y coordinates given are contained within this ellipse including stroke
+     * @param x - The X coordinate of the point to test
+     * @param y - The Y coordinate of the point to test
+     * @param width
+     * @returns Whether the x/y coords are within this ellipse
+     */
+    strokeContains(x: number, y: number, width: number): boolean;
+    /**
+     * Returns the framing rectangle of the ellipse as a Rectangle object
+     * @param out
+     * @returns The framing rectangle
+     */
+    /**
+     * Copies another ellipse to this one.
+     * @param ellipse - The ellipse to copy from.
+     * @returns Returns itself.
+     */
+    copyFrom(ellipse: Ellipse): this;
+    /**
+     * Copies this ellipse to another one.
+     * @param ellipse - The ellipse to copy to.
+     * @returns Returns given parameter.
+     */
+    copyTo(ellipse: Ellipse): Ellipse;
+    getX(): number;
+    getY(): number;
+    build(points: number[]): number[];
+    triangulate(points: number[], vertices: number[], verticesOffset: number, indices: number[], indicesOffset: number): void;
+}

package/dist/plugins/shape/graphics-path.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Based on:
+ * https://github.com/pixijs/pixijs/blob/dev/src/scene/graphics/shared/path/GraphicsPath.ts
+ */
+import type { Matrix4 } from '@galacean/effects-math/es/core/matrix4';
+import { ShapePath } from './shape-path';
+import type { StarType } from './poly-star';
+export declare class GraphicsPath {
+    instructions: PathInstruction[];
+    private dirty;
+    private _shapePath;
+    /**
+     * Provides access to the internal shape path, ensuring it is up-to-date with the current instructions.
+     * @returns The `ShapePath` instance associated with this `GraphicsPath`.
+     */
+    get shapePath(): ShapePath;
+    /**
+     * Adds a cubic Bezier curve to the path.
+     * It requires three points: the first two are control points and the third one is the end point.
+     * The starting point is the last point in the current path.
+     * @param cp1x - The x-coordinate of the first control point.
+     * @param cp1y - The y-coordinate of the first control point.
+     * @param cp2x - The x-coordinate of the second control point.
+     * @param cp2y - The y-coordinate of the second control point.
+     * @param x - The x-coordinate of the end point.
+     * @param y - The y-coordinate of the end point.
+     * @param smoothness - Optional parameter to adjust the smoothness of the curve.
+     * @returns The instance of the current object for chaining.
+     */
+    bezierCurveTo(cp1x: number, cp1y: number, cp2x: number, cp2y: number, x: number, y: number, smoothness?: number): GraphicsPath;
+    /**
+     * Sets the starting point for a new sub-path. Any subsequent drawing commands are considered part of this path.
+     * @param x - The x-coordinate for the starting point.
+     * @param y - The y-coordinate for the starting point.
+     * @returns The instance of the current object for chaining.
+     */
+    moveTo(x: number, y: number): GraphicsPath;
+    /**
+     * Draws an ellipse at the specified location and with the given x and y radii.
+     * An optional transformation can be applied, allowing for rotation, scaling, and translation.
+     * @param x - The x-coordinate of the center of the ellipse.
+     * @param y - The y-coordinate of the center of the ellipse.
+     * @param radiusX - The horizontal radius of the ellipse.
+     * @param radiusY - The vertical radius of the ellipse.
+     * @param transform - An optional `Matrix` object to apply a transformation to the ellipse. This can include rotations.
+     * @returns The instance of the current object for chaining.
+     */
+    ellipse(x: number, y: number, radiusX: number, radiusY: number, transform?: Matrix4): this;
+    /**
+     * Draws a rectangle shape. This method adds a new rectangle path to the current drawing.
+     * @param x - The x-coordinate of the top-left corner of the rectangle.
+     * @param y - The y-coordinate of the top-left corner of the rectangle.
+     * @param w - The width of the rectangle.
+     * @param h - The height of the rectangle.
+     * @param transform - An optional `Matrix` object to apply a transformation to the rectangle.
+     * @returns The instance of the current object for chaining.
+     */
+    rect(x: number, y: number, w: number, h: number, transform?: Matrix4): this;
+    polyStar(pointCount: number, outerRadius: number, innerRadius: number, outerRoundness: number, innerRoundness: number, starType: StarType, transform?: Matrix4): this;
+    clear(): GraphicsPath;
+}
+export interface PathInstruction {
+    action: 'moveTo' | 'lineTo' | 'quadraticCurveTo' | 'bezierCurveTo' | 'arc' | 'closePath' | 'addPath' | 'arcTo' | 'ellipse' | 'rect' | 'roundRect' | 'arcToSvg' | 'poly' | 'circle' | 'regularPoly' | 'roundPoly' | 'roundShape' | 'filletRect' | 'chamferRect' | 'polyStar';
+    data: any[];
+}

package/dist/plugins/shape/point-data.d.ts

@@ -0,0 +1,6 @@
+export interface PointData {
+    /** X coord */
+    x: number;
+    /** Y coord */
+    y: number;
+}

package/dist/plugins/shape/point-like.d.ts

@@ -0,0 +1,31 @@
+import type { PointData } from './point-data';
+/**
+ * Common interface for points. Both Point and ObservablePoint implement it
+ */
+export interface PointLike extends PointData {
+    /**
+     * Copies x and y from the given point
+     * @param p - The point to copy from
+     * @returns Returns itself.
+     */
+    copyFrom: (p: PointData) => this;
+    /**
+     * Copies x and y into the given point
+     * @param p - The point to copy.fds
+     * @returns Given point with values updated
+     */
+    copyTo: <T extends PointLike>(p: T) => T;
+    /**
+     * Returns true if the given point is equal to this point
+     * @param p - The point to check
+     * @returns Whether the given point equal to this point
+     */
+    equals: (p: PointData) => boolean;
+    /**
+     * Sets the point to a new x and y position.
+     * If y is omitted, both x and y will be set to x.
+     * @param {number} [x=0] - position of the point on the x axis
+     * @param {number} [y=x] - position of the point on the y axis
+     */
+    set: (x?: number, y?: number) => void;
+}

package/dist/plugins/shape/point.d.ts

@@ -0,0 +1,58 @@
+import type { PointData } from './point-data';
+import type { PointLike } from './point-like';
+/**
+ * The Point object represents a location in a two-dimensional coordinate system, where `x` represents
+ * the position on the horizontal axis and `y` represents the position on the vertical axis.
+ */
+export declare class Point implements PointLike {
+    /**
+     * Position of the point on the x axis
+     */
+    x: number;
+    /**
+     * Position of the point on the y axis
+     */
+    y: number;
+    /**
+     * Creates a new `Point`
+     * @param {number} [x=0] - position of the point on the x axis
+     * @param {number} [y=0] - position of the point on the y axis
+     */
+    constructor(x?: number, y?: number);
+    /**
+     * Creates a clone of this point
+     * @returns A clone of this point
+     */
+    clone(): Point;
+    /**
+     * Copies `x` and `y` from the given point into this point
+     * @param p - The point to copy from
+     * @returns The point instance itself
+     */
+    copyFrom(p: PointData): this;
+    /**
+     * Copies this point's x and y into the given point (`p`).
+     * @param p - The point to copy to. Can be any of type that is or extends `PointData`
+     * @returns The point (`p`) with values updated
+     */
+    copyTo<T extends PointLike>(p: T): T;
+    /**
+     * Accepts another point (`p`) and returns `true` if the given point is equal to this point
+     * @param p - The point to check
+     * @returns Returns `true` if both `x` and `y` are equal
+     */
+    equals(p: PointData): boolean;
+    /**
+     * Sets the point to a new `x` and `y` position.
+     * If `y` is omitted, both `x` and `y` will be set to `x`.
+     * @param {number} [x=0] - position of the point on the `x` axis
+     * @param {number} [y=x] - position of the point on the `y` axis
+     * @returns The point instance itself
+     */
+    set(x?: number, y?: number): this;
+    /**
+     * A static Point object with `x` and `y` values of `0`. Can be used to avoid creating new objects multiple times.
+     * @readonly
+     */
+    static get shared(): Point;
+}