@revideo/2d 0.4.7-two.1024 → 0.4.8-alpha.1032

package/lib/components/Curve.d.ts

@@ -1,212 +1,202 @@
-import {
-  BBox,
-  SerializedVector2,
-  SignalValue,
-  SimpleSignal,
-  Vector2,
-} from '@revideo/core';
-import {CurveDrawingInfo} from '../curves/CurveDrawingInfo';
-import {CurvePoint} from '../curves/CurvePoint';
-import {CurveProfile} from '../curves/CurveProfile';
-import {DesiredLength} from '../partials';
-import {Shape, ShapeProps} from './Shape';
+import { BBox, SerializedVector2, SignalValue, SimpleSignal, Vector2 } from '@revideo/core';
+import { CurveDrawingInfo } from '../curves/CurveDrawingInfo';
+import { CurvePoint } from '../curves/CurvePoint';
+import { CurveProfile } from '../curves/CurveProfile';
+import { DesiredLength } from '../partials';
+import { Shape, ShapeProps } from './Shape';
 export interface CurveProps extends ShapeProps {
-  /**
-   * {@inheritDoc Curve.closed}
-   */
-  closed?: SignalValue<boolean>;
-  /**
-   * {@inheritDoc Curve.start}
-   */
-  start?: SignalValue<number>;
-  /**
-   * {@inheritDoc Curve.startOffset}
-   */
-  startOffset?: SignalValue<number>;
-  /**
-   * {@inheritDoc Curve.startArrow}
-   */
-  startArrow?: SignalValue<boolean>;
-  /**
-   * {@inheritDoc Curve.end}
-   */
-  end?: SignalValue<number>;
-  /**
-   * {@inheritDoc Curve.endOffset}
-   */
-  endOffset?: SignalValue<number>;
-  /**
-   * {@inheritDoc Curve.endArrow}
-   */
-  endArrow?: SignalValue<boolean>;
-  /**
-   * {@inheritDoc Curve.arrowSize}
-   */
-  arrowSize?: SignalValue<number>;
+    /**
+     * {@inheritDoc Curve.closed}
+     */
+    closed?: SignalValue<boolean>;
+    /**
+     * {@inheritDoc Curve.start}
+     */
+    start?: SignalValue<number>;
+    /**
+     * {@inheritDoc Curve.startOffset}
+     */
+    startOffset?: SignalValue<number>;
+    /**
+     * {@inheritDoc Curve.startArrow}
+     */
+    startArrow?: SignalValue<boolean>;
+    /**
+     * {@inheritDoc Curve.end}
+     */
+    end?: SignalValue<number>;
+    /**
+     * {@inheritDoc Curve.endOffset}
+     */
+    endOffset?: SignalValue<number>;
+    /**
+     * {@inheritDoc Curve.endArrow}
+     */
+    endArrow?: SignalValue<boolean>;
+    /**
+     * {@inheritDoc Curve.arrowSize}
+     */
+    arrowSize?: SignalValue<number>;
 }
 export declare abstract class Curve extends Shape {
-  /**
-   * Whether the curve should be closed.
-   *
-   * @remarks
-   * Closed curves have their start and end points connected.
-   */
-  readonly closed: SimpleSignal<boolean, this>;
-  /**
-   * A percentage from the start before which the curve should be clipped.
-   *
-   * @remarks
-   * The portion of the curve that comes before the given percentage will be
-   * made invisible.
-   *
-   * This property is usefully for animating the curve appearing on the screen.
-   * The value of `0` means the very start of the curve (accounting for the
-   * {@link startOffset}) while `1` means the very end (accounting for the
-   * {@link endOffset}).
-   */
-  readonly start: SimpleSignal<number, this>;
-  /**
-   * The offset in pixels from the start of the curve.
-   *
-   * @remarks
-   * This property lets you specify where along the defined curve the actual
-   * visible portion starts. For example, setting it to `20` will make the first
-   * 20 pixels of the curve invisible.
-   *
-   * This property is useful for trimming the curve using a fixed distance.
-   * If you want to animate the curve appearing on the screen, use {@link start}
-   * instead.
-   */
-  readonly startOffset: SimpleSignal<number, this>;
-  /**
-   * Whether to display an arrow at the start of the visible curve.
-   *
-   * @remarks
-   * Use {@link arrowSize} to control the size of the arrow.
-   */
-  readonly startArrow: SimpleSignal<boolean, this>;
-  /**
-   * A percentage from the start after which the curve should be clipped.
-   *
-   * @remarks
-   * The portion of the curve that comes after the given percentage will be
-   * made invisible.
-   *
-   * This property is usefully for animating the curve appearing on the screen.
-   * The value of `0` means the very start of the curve (accounting for the
-   * {@link startOffset}) while `1` means the very end (accounting for the
-   * {@link endOffset}).
-   */
-  readonly end: SimpleSignal<number, this>;
-  /**
-   * The offset in pixels from the end of the curve.
-   *
-   * @remarks
-   * This property lets you specify where along the defined curve the actual
-   * visible portion ends. For example, setting it to `20` will make the last
-   * 20 pixels of the curve invisible.
-   *
-   * This property is useful for trimming the curve using a fixed distance.
-   * If you want to animate the curve appearing on the screen, use {@link end}
-   * instead.
-   */
-  readonly endOffset: SimpleSignal<number, this>;
-  /**
-   * Whether to display an arrow at the end of the visible curve.
-   *
-   * @remarks
-   * Use {@link arrowSize} to control the size of the arrow.
-   */
-  readonly endArrow: SimpleSignal<boolean, this>;
-  /**
-   * Controls the size of the end and start arrows.
-   *
-   * @remarks
-   * To make the arrows visible make sure to enable {@link startArrow} and/or
-   * {@link endArrow}.
-   */
-  readonly arrowSize: SimpleSignal<number, this>;
-  protected canHaveSubpath: boolean;
-  protected desiredSize(): SerializedVector2<DesiredLength>;
-  constructor(props: CurveProps);
-  protected abstract childrenBBox(): BBox;
-  abstract profile(): CurveProfile;
-  /**
-   * Convert a percentage along the curve to a distance.
-   *
-   * @remarks
-   * The returned distance is given in relation to the full curve, not
-   * accounting for {@link startOffset} and {@link endOffset}.
-   *
-   * @param value - The percentage along the curve.
-   */
-  percentageToDistance(value: number): number;
-  /**
-   * Convert a distance along the curve to a percentage.
-   *
-   * @remarks
-   * The distance should be given in relation to the full curve, not
-   * accounting for {@link startOffset} and {@link endOffset}.
-   *
-   * @param value - The distance along the curve.
-   */
-  distanceToPercentage(value: number): number;
-  /**
-   * The base arc length of this curve.
-   *
-   * @remarks
-   * This is the entire length of this curve, not accounting for
-   * {@link startOffset | the offsets}.
-   */
-  baseArcLength(): number;
-  /**
-   * The offset arc length of this curve.
-   *
-   * @remarks
-   * This is the length of the curve that accounts for
-   * {@link startOffset | the offsets}.
-   */
-  offsetArcLength(): number;
-  /**
-   * The visible arc length of this curve.
-   *
-   * @remarks
-   * This arc length accounts for both the offset and the {@link start} and
-   * {@link end} properties.
-   */
-  arcLength(): number;
-  /**
-   * The percentage of the curve that's currently visible.
-   *
-   * @remarks
-   * The returned value is the ratio between the visible length (as defined by
-   * {@link start} and {@link end}) and the offset length of the curve.
-   */
-  completion(): number;
-  protected processSubpath(
-    _path: Path2D,
-    _startPoint: Vector2 | null,
-    _endPoint: Vector2 | null,
-  ): void;
-  protected curveDrawingInfo(): CurveDrawingInfo;
-  protected getPointAtDistance(value: number): CurvePoint;
-  getPointAtPercentage(value: number): CurvePoint;
-  protected getComputedLayout(): BBox;
-  protected offsetComputedLayout(box: BBox): BBox;
-  protected getPath(): Path2D;
-  protected getCacheBBox(): BBox;
-  protected lineWidthCoefficient(): number;
-  /**
-   * Check if the path requires a profile.
-   *
-   * @remarks
-   * The profile is only required if certain features are used. Otherwise, the
-   * profile generation can be skipped, and the curve can be drawn directly
-   * using the 2D context.
-   */
-  protected requiresProfile(): boolean;
-  protected drawShape(context: CanvasRenderingContext2D): void;
-  private drawArrows;
-  private drawArrow;
+    /**
+     * Whether the curve should be closed.
+     *
+     * @remarks
+     * Closed curves have their start and end points connected.
+     */
+    readonly closed: SimpleSignal<boolean, this>;
+    /**
+     * A percentage from the start before which the curve should be clipped.
+     *
+     * @remarks
+     * The portion of the curve that comes before the given percentage will be
+     * made invisible.
+     *
+     * This property is usefully for animating the curve appearing on the screen.
+     * The value of `0` means the very start of the curve (accounting for the
+     * {@link startOffset}) while `1` means the very end (accounting for the
+     * {@link endOffset}).
+     */
+    readonly start: SimpleSignal<number, this>;
+    /**
+     * The offset in pixels from the start of the curve.
+     *
+     * @remarks
+     * This property lets you specify where along the defined curve the actual
+     * visible portion starts. For example, setting it to `20` will make the first
+     * 20 pixels of the curve invisible.
+     *
+     * This property is useful for trimming the curve using a fixed distance.
+     * If you want to animate the curve appearing on the screen, use {@link start}
+     * instead.
+     */
+    readonly startOffset: SimpleSignal<number, this>;
+    /**
+     * Whether to display an arrow at the start of the visible curve.
+     *
+     * @remarks
+     * Use {@link arrowSize} to control the size of the arrow.
+     */
+    readonly startArrow: SimpleSignal<boolean, this>;
+    /**
+     * A percentage from the start after which the curve should be clipped.
+     *
+     * @remarks
+     * The portion of the curve that comes after the given percentage will be
+     * made invisible.
+     *
+     * This property is usefully for animating the curve appearing on the screen.
+     * The value of `0` means the very start of the curve (accounting for the
+     * {@link startOffset}) while `1` means the very end (accounting for the
+     * {@link endOffset}).
+     */
+    readonly end: SimpleSignal<number, this>;
+    /**
+     * The offset in pixels from the end of the curve.
+     *
+     * @remarks
+     * This property lets you specify where along the defined curve the actual
+     * visible portion ends. For example, setting it to `20` will make the last
+     * 20 pixels of the curve invisible.
+     *
+     * This property is useful for trimming the curve using a fixed distance.
+     * If you want to animate the curve appearing on the screen, use {@link end}
+     * instead.
+     */
+    readonly endOffset: SimpleSignal<number, this>;
+    /**
+     * Whether to display an arrow at the end of the visible curve.
+     *
+     * @remarks
+     * Use {@link arrowSize} to control the size of the arrow.
+     */
+    readonly endArrow: SimpleSignal<boolean, this>;
+    /**
+     * Controls the size of the end and start arrows.
+     *
+     * @remarks
+     * To make the arrows visible make sure to enable {@link startArrow} and/or
+     * {@link endArrow}.
+     */
+    readonly arrowSize: SimpleSignal<number, this>;
+    protected canHaveSubpath: boolean;
+    protected desiredSize(): SerializedVector2<DesiredLength>;
+    constructor(props: CurveProps);
+    protected abstract childrenBBox(): BBox;
+    abstract profile(): CurveProfile;
+    /**
+     * Convert a percentage along the curve to a distance.
+     *
+     * @remarks
+     * The returned distance is given in relation to the full curve, not
+     * accounting for {@link startOffset} and {@link endOffset}.
+     *
+     * @param value - The percentage along the curve.
+     */
+    percentageToDistance(value: number): number;
+    /**
+     * Convert a distance along the curve to a percentage.
+     *
+     * @remarks
+     * The distance should be given in relation to the full curve, not
+     * accounting for {@link startOffset} and {@link endOffset}.
+     *
+     * @param value - The distance along the curve.
+     */
+    distanceToPercentage(value: number): number;
+    /**
+     * The base arc length of this curve.
+     *
+     * @remarks
+     * This is the entire length of this curve, not accounting for
+     * {@link startOffset | the offsets}.
+     */
+    baseArcLength(): number;
+    /**
+     * The offset arc length of this curve.
+     *
+     * @remarks
+     * This is the length of the curve that accounts for
+     * {@link startOffset | the offsets}.
+     */
+    offsetArcLength(): number;
+    /**
+     * The visible arc length of this curve.
+     *
+     * @remarks
+     * This arc length accounts for both the offset and the {@link start} and
+     * {@link end} properties.
+     */
+    arcLength(): number;
+    /**
+     * The percentage of the curve that's currently visible.
+     *
+     * @remarks
+     * The returned value is the ratio between the visible length (as defined by
+     * {@link start} and {@link end}) and the offset length of the curve.
+     */
+    completion(): number;
+    protected processSubpath(_path: Path2D, _startPoint: Vector2 | null, _endPoint: Vector2 | null): void;
+    protected curveDrawingInfo(): CurveDrawingInfo;
+    protected getPointAtDistance(value: number): CurvePoint;
+    getPointAtPercentage(value: number): CurvePoint;
+    protected getComputedLayout(): BBox;
+    protected offsetComputedLayout(box: BBox): BBox;
+    protected getPath(): Path2D;
+    protected getCacheBBox(): BBox;
+    protected lineWidthCoefficient(): number;
+    /**
+     * Check if the path requires a profile.
+     *
+     * @remarks
+     * The profile is only required if certain features are used. Otherwise, the
+     * profile generation can be skipped, and the curve can be drawn directly
+     * using the 2D context.
+     */
+    protected requiresProfile(): boolean;
+    protected drawShape(context: CanvasRenderingContext2D): void;
+    private drawArrows;
+    private drawArrow;
 }
-//# sourceMappingURL=Curve.d.ts.map
+//# sourceMappingURL=Curve.d.ts.map

package/lib/components/Grid.d.ts

@@ -1,23 +1,18 @@
-import {
-  PossibleVector2,
-  SignalValue,
-  SimpleSignal,
-  Vector2Signal,
-} from '@revideo/core';
-import {Shape, ShapeProps} from './Shape';
+import { PossibleVector2, SignalValue, SimpleSignal, Vector2Signal } from '@revideo/core';
+import { Shape, ShapeProps } from './Shape';
 export interface GridProps extends ShapeProps {
-  /**
-   * {@inheritDoc Grid.spacing}
-   */
-  spacing?: SignalValue<PossibleVector2>;
-  /**
-   * {@inheritDoc Grid.start}
-   */
-  start?: SignalValue<number>;
-  /**
-   * {@inheritDoc Grid.end}
-   */
-  end?: SignalValue<number>;
+    /**
+     * {@inheritDoc Grid.spacing}
+     */
+    spacing?: SignalValue<PossibleVector2>;
+    /**
+     * {@inheritDoc Grid.start}
+     */
+    start?: SignalValue<number>;
+    /**
+     * {@inheritDoc Grid.end}
+     */
+    end?: SignalValue<number>;
 }
 /**
  * A node for drawing a two-dimensional grid.
@@ -49,32 +44,32 @@ export interface GridProps extends ShapeProps {
  * ```
  */
 export declare class Grid extends Shape {
-  /**
-   * The spacing between the grid lines.
-   */
-  readonly spacing: Vector2Signal<this>;
-  /**
-   * The percentage that should be clipped from the beginning of each grid line.
-   *
-   * @remarks
-   * The portion of each grid line that comes before the given percentage will
-   * be made invisible.
-   *
-   * This property is useful for animating the grid appearing on-screen.
-   */
-  readonly start: SimpleSignal<number, this>;
-  /**
-   * The percentage that should be clipped from the end of each grid line.
-   *
-   * @remarks
-   * The portion of each grid line that comes after the given percentage will
-   * be made invisible.
-   *
-   * This property is useful for animating the grid appearing on-screen.
-   */
-  readonly end: SimpleSignal<number, this>;
-  constructor(props: GridProps);
-  protected drawShape(context: CanvasRenderingContext2D): void;
-  private mapPoints;
+    /**
+     * The spacing between the grid lines.
+     */
+    readonly spacing: Vector2Signal<this>;
+    /**
+     * The percentage that should be clipped from the beginning of each grid line.
+     *
+     * @remarks
+     * The portion of each grid line that comes before the given percentage will
+     * be made invisible.
+     *
+     * This property is useful for animating the grid appearing on-screen.
+     */
+    readonly start: SimpleSignal<number, this>;
+    /**
+     * The percentage that should be clipped from the end of each grid line.
+     *
+     * @remarks
+     * The portion of each grid line that comes after the given percentage will
+     * be made invisible.
+     *
+     * This property is useful for animating the grid appearing on-screen.
+     */
+    readonly end: SimpleSignal<number, this>;
+    constructor(props: GridProps);
+    protected drawShape(context: CanvasRenderingContext2D): void;
+    private mapPoints;
 }
-//# sourceMappingURL=Grid.d.ts.map
+//# sourceMappingURL=Grid.d.ts.map

package/lib/components/Icon.d.ts

@@ -1,63 +1,58 @@
-import {
-  ColorSignal,
-  PossibleColor,
-  SignalValue,
-  SimpleSignal,
-} from '@revideo/core';
-import {Img, ImgProps} from './Img';
+import { ColorSignal, PossibleColor, SignalValue, SimpleSignal } from '@revideo/core';
+import { Img, ImgProps } from './Img';
 export interface IconProps extends ImgProps {
-  /**
-   * {@inheritDoc Icon.icon}
-   */
-  icon: SignalValue<string>;
-  /**
-   * {@inheritDoc Icon.color}
-   */
-  color?: SignalValue<PossibleColor>;
+    /**
+     * {@inheritDoc Icon.icon}
+     */
+    icon: SignalValue<string>;
+    /**
+     * {@inheritDoc Icon.color}
+     */
+    color?: SignalValue<PossibleColor>;
 }
 /**
  * An Icon Component that provides easy access to over 150k icons.
  * See https://icones.js.org/collection/all for all available Icons.
  */
 export declare class Icon extends Img {
-  /**
-   * The identifier of the icon.
-   *
-   * @remarks
-   * You can find identifiers on [Icônes](https://icones.js.org).
-   * They can look like this:
-   * * `mdi:language-typescript`
-   * * `ph:anchor-simple-bold`
-   * * `ph:activity-bold`
-   */
-  icon: SimpleSignal<string, this>;
-  /**
-   * The color of the icon
-   *
-   * @remarks
-   * Provide the color in one of the following formats:
-   * * named color like `red`, `darkgray`, …
-   * * hexadecimal string with # like `#bada55`, `#141414`
-   *   Value can be either RGB or RGBA: `#bada55`, `#bada55aa` (latter is partially transparent)
-   *   The shorthand version (e.g. `#abc` for `#aabbcc` is also possible.)
-   *
-   * @defaultValue 'white'
-   */
-  color: ColorSignal<this>;
-  constructor(props: IconProps);
-  /**
-   * Create the URL that will be used as the Image source
-   * @returns Address to Iconify API for the requested Icon.
-   */
-  protected svgUrl(): string;
-  /**
-   * overrides `Image.src` getter
-   */
-  protected getSrc(): string;
-  /**
-   * overrides `Image.src` setter to warn the user that the value
-   * is not used
-   */
-  protected setSrc(src: string | null): void;
+    /**
+     * The identifier of the icon.
+     *
+     * @remarks
+     * You can find identifiers on [Icônes](https://icones.js.org).
+     * They can look like this:
+     * * `mdi:language-typescript`
+     * * `ph:anchor-simple-bold`
+     * * `ph:activity-bold`
+     */
+    icon: SimpleSignal<string, this>;
+    /**
+     * The color of the icon
+     *
+     * @remarks
+     * Provide the color in one of the following formats:
+     * * named color like `red`, `darkgray`, …
+     * * hexadecimal string with # like `#bada55`, `#141414`
+     *   Value can be either RGB or RGBA: `#bada55`, `#bada55aa` (latter is partially transparent)
+     *   The shorthand version (e.g. `#abc` for `#aabbcc` is also possible.)
+     *
+     * @defaultValue 'white'
+     */
+    color: ColorSignal<this>;
+    constructor(props: IconProps);
+    /**
+     * Create the URL that will be used as the Image source
+     * @returns Address to Iconify API for the requested Icon.
+     */
+    protected svgUrl(): string;
+    /**
+     * overrides `Image.src` getter
+     */
+    protected getSrc(): string;
+    /**
+     * overrides `Image.src` setter to warn the user that the value
+     * is not used
+     */
+    protected setSrc(src: string | null): void;
 }
-//# sourceMappingURL=Icon.d.ts.map
+//# sourceMappingURL=Icon.d.ts.map