@cesdk/engine 1.10.0-preview.0 → 1.10.0-preview.1

package/index.d.ts

@@ -105,7 +105,6 @@ export declare class AssetAPI {
      */
     removeAssetFromSource(sourceId: string, assetId: string): void;
 
-
     /**
      * Apply an asset result to the active scene.
      * The default behavior will instantiate a block and configure it according to the asset's properties.
@@ -312,10 +311,8 @@ export declare interface AssetSource {
     addAsset?(asset: AssetDefinition): void;
     /**
      * Removes the given asset from this source.
-     *
-     * @returns true if asset was found and removed, and false otherwise
      */
-    removeAsset?(assetId: string): Promise<boolean>;
+    removeAsset?(assetId: string): void;
     /**
      * Generates a list of supported mime types for this source.
      *
@@ -418,6 +415,7 @@ export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply'
  */
 export declare class Block extends Entity {
     #private;
+    get type(): DesignBlockType;
     effects: ReadWriteChannelSync<number[]>;
     blur: ReadWriteChannelSync<number>;
     isBlurEnabled: ReadWriteChannelSync<boolean>;
@@ -442,6 +440,7 @@ export declare class Block extends Entity {
     height: ReadWriteChannelSync<number>;
     dimensions: ReadWriteChannelSync<Vec2>;
     contentFillMode: ReadWriteChannelSync<ContentFillMode>;
+    blendMode: ReadWriteChannelSync<BlendMode>;
     designStyleScope: ReadWriteChannelSync<boolean>;
     designArrangeScope: ReadWriteChannelSync<boolean>;
     designArrangeScopeMove: ReadWriteChannelSync<boolean>;
@@ -457,6 +456,12 @@ export declare class Block extends Entity {
     editorManagePagesScope: ReadWriteChannelSync<boolean>;
     editorSelectScope: ReadWriteChannelSync<boolean>;
     editorZoomScope: ReadWriteChannelSync<boolean>;
+    boundingBox: ReadOnlyChannelSync<{
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }>;
 
 
 }
@@ -701,6 +706,46 @@ export declare class BlockAPI {
      * @param mode - The y position mode: absolute, percent or undefined.
      */
     setPositionYMode(id: DesignBlockId, mode: PositionMode): void;
+    /**
+     * Update the block's always-on-top property. If true, this blocks's global sorting order is automatically
+     * adjusted to be higher than all other siblings
+     * without this property. If more than one block is set to be always-on-top, the child order decides which is on top.
+     *
+     * @param id - the block to update.
+     * @param enabled - whether the block shall be always-on-top.
+     */
+    setAlwaysOnTop(id: DesignBlockId, enabled: boolean): void;
+    /**
+     * Query a block's always-on-top property.
+     *
+     * @param id - the block to query.
+     * @returns true if the block is set to be always-on-top, false otherwise.
+     */
+    isAlwaysOnTop(id: DesignBlockId): boolean;
+    /**
+     * Updates the sorting order of this block and all of its manually created siblings
+     * so that the given block has the highest sorting order.
+     * @param id - The id of the block to be given the highest sorting order among its siblings.
+     */
+    bringToFront(id: DesignBlockId): void;
+    /**
+     * Updates the sorting order of this block and all of its manually created siblings
+     * so that the given block has the lowest sorting order.
+     * @param id - The id of the block to be given the lowest sorting order among its siblings.
+     */
+    sendToBack(id: DesignBlockId): void;
+    /**
+     * Updates the sorting order of this block and all of its superjacent siblings
+     * so that the given block has a higher sorting order than the next superjacent sibling.
+     * @param id - The id of the block to be given a higher sorting than the next superjacent sibling.
+     */
+    bringForward(id: DesignBlockId): void;
+    /**
+     * Updates the sorting order of this block and all of its manually created and subjacent siblings
+     * so that the given block will have a lower sorting order than the next subjacent sibling.
+     * @param id - The id of the block to be given a lower sorting order than the next subjacent sibling.
+     */
+    sendBackward(id: DesignBlockId): void;
     /**
      * Query a block's rotation in radians.
      * @param id - The block to query.
@@ -767,12 +812,6 @@ export declare class BlockAPI {
      * @returns The current mode for the height: absolute, percent or auto.
      */
     getHeightMode(id: DesignBlockId): SizeMode;
-    /**
-     * Query a block's content fill mode.
-     * @param id - The block to query.
-     * @returns The current mode: crop, cover or contain.
-     */
-    getContentFillMode(id: DesignBlockId): ContentFillMode;
     /**
      * Update a block's width.
      * @param id - The block to update.
@@ -797,12 +836,6 @@ export declare class BlockAPI {
      * @param mode - The height mode: absolute, percent or auto.
      */
     setHeightMode(id: DesignBlockId, mode: SizeMode): void;
-    /**
-     * Set a block's content fill mode.
-     * @param id - The block to update.
-     * @param mode - The content fill mode mode: crop, cover or contain.
-     */
-    setContentFillMode(id: DesignBlockId, mode: ContentFillMode): void;
     /**
      * Get a block's layout position on the x-axis. The position is only available after an
      * internal update loop which only occurs if the `features/implicitUpdatesEnabled` setting is set.
@@ -831,6 +864,18 @@ export declare class BlockAPI {
      * @returns The layout height.
      */
     getFrameHeight(id: DesignBlockId): number;
+    /**
+     * Set a block's content fill mode.
+     * @param id - The block to update.
+     * @param mode - The content fill mode mode: crop, cover or contain.
+     */
+    setContentFillMode(id: DesignBlockId, mode: ContentFillMode): void;
+    /**
+     * Query a block's content fill mode.
+     * @param id - The block to query.
+     * @returns The current mode: crop, cover or contain.
+     */
+    getContentFillMode(id: DesignBlockId): ContentFillMode;
     /**
      * Duplicates a block including its children.
      * @param id - The block to duplicate.
@@ -909,6 +954,12 @@ export declare class BlockAPI {
      * @returns float The height of the axis-aligned bounding box.
      */
     getGlobalBoundingBoxHeight(id: DesignBlockId): number;
+    /**
+     * Get the position and size of the axis-aligned bounding box for the given blocks in screen space.
+     * @param ids - The block to query.
+     * @returns The position and size of the bounding box.
+     */
+    getScreenSpaceBoundingBoxXYWH(ids: DesignBlockId[]): XYWH;
     /**
      * Scales the block and all of its children proportionally around the specified
      * relative anchor point.
@@ -2067,6 +2118,15 @@ declare type Callbacks = {
     log?: Logger;
 };
 
+declare type CameraSettings = {
+    /** Horizontal resolution in physical pixels */
+    width: number;
+    /** Vertical resolution in physical pixels */
+    height: number;
+    /** Physical pixels per CSS pixel */
+    pixelRatio: number;
+};
+
 /**
  * A Channel represents a reactive data source consisting of three elements:
  *
@@ -2216,6 +2276,7 @@ declare class CreativeEngine {
     scene: SceneAPI;
     variable: VariableAPI;
 
+
     get element(): HTMLCreativeEngineCanvasElement | undefined;
     /**
      * Dispose the engine.
@@ -2233,6 +2294,8 @@ declare class CreativeEngine {
     } : {
         readonly element: HTMLCreativeEngineCanvasElement;
     })>;
+
+
 }
 export default CreativeEngine;
 
@@ -2892,6 +2955,24 @@ declare interface QueryData {
     page: number;
 }
 
+/**
+ * A Read only {@link Channel}
+ * @public
+ */
+export declare interface ReadOnlyChannel<Out> extends Omit<Channel<Out>, 'update'> {
+    subscribe: Source<Out>;
+    value?: () => Out;
+}
+
+/**
+ * A {@link ReadOnlyChannel} that is guaranteed to have a `value`
+ * @public
+ */
+export declare interface ReadOnlyChannelSync<Out> extends Omit<ChannelSync<Out>, 'update'>, ReadOnlyChannel<Out> {
+    subscribe: Source<Out>;
+    value: () => Out;
+}
+
 /**
  * A {@link Channel} that is guaranteed to have an `update` method.
  * @public
@@ -2960,7 +3041,7 @@ export declare type RoleString = 'Creator' | 'Adopter' | 'Viewer' | 'Presenter';
  * @public
  */
 export declare class Scene {
-    constructor(ubq: UBQ, blockChannels: BlockChannels);
+
     /**
      * A channel containing the latest Block.
      * Will emit an event when the scene changes
@@ -2968,10 +3049,10 @@ export declare class Scene {
     block: ChannelSync<Block | undefined>;
     mode: ChannelSync<SceneMode | undefined>;
     totalDuration: ChannelSync<number>;
-    pages: ChannelSync<DesignBlockId[]> & EngineChannel<DesignBlockId[]>;
+    pages: ChannelSync<DesignBlockId[]>;
     playing: ReadWriteChannelSync<boolean>;
     playbackTime: ReadWriteChannelSync<number>;
-    pageDurations: ChannelSync<PageDuration[]> & EngineChannel<PageDuration[]>;
+    pageDurations: ChannelSync<PageDuration[]>;
 }
 
 /**
@@ -3108,6 +3189,47 @@ export declare class SceneAPI {
      * @returns A promise that resolves once the zoom was set or rejects with an error otherwise.
      */
     zoomToBlock(id: DesignBlockId, paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): Promise<void>;
+    /**
+     * Continually adjusts the zoom level to fit the width or height of a block's axis-aligned bounding box.
+     * Only has an effect if the zoom level is not handled by the UI.
+     * Without padding, this results in a tight view on the block.
+     * No more than one block per scene can have zoom auto-fit enabled.
+     * Calling `setZoomLevel` or `zoomToBlock` disables the continuous adjustment.
+     *
+     * @param id - The block for which the zoom is adjusted.
+     * @param axis - The block axis for which the zoom is adjusted.
+     * @param paddingBefore - Optional padding in screen pixels before the block.
+     * @param paddingAfter - Optional padding in screen pixels after the block.
+     */
+    enableZoomAutoFit(id: DesignBlockId, axis: 'Horizontal' | 'Vertical', paddingBefore?: number, paddingAfter?: number): void;
+    /**
+     * Continually adjusts the zoom level to fit the width or height of a block's axis-aligned bounding box.
+     * Only has an effect if the zoom level is not handled by the UI.
+     * Without padding, this results in a tight view on the block.
+     * Calling `setZoomLevel` or `zoomToBlock` disables the continuous adjustment.
+     *
+     * @param id - The block for which the zoom is adjusted.
+     * @param axis - The block axis for which the zoom is adjusted.
+     * @param paddingLeft - Optional padding in screen pixels to the left of the block.
+     * @param paddingTop - Optional padding in screen pixels to the top of the block.
+     * @param paddingRight - Optional padding in screen pixels to the right of the block.
+     * @param paddingBottom - Optional padding in screen pixels to the bottom of the block.
+     */
+    enableZoomAutoFit(id: DesignBlockId, axis: 'Both', paddingLeft?: number, paddingTop?: number, paddingRight?: number, paddingBottom?: number): void;
+    /**
+     *  Disables any previously set zoom auto-fit.
+     *
+     * @param blockOrScene - The scene or a block in the scene for which to disable a zoom auto-fit.
+     */
+    disableZoomAutoFit(blockOrScene: DesignBlockId): void;
+    /**
+     *  Queries whether zoom auto-fit is enabled.
+     *
+     * @param blockOrScene - The scene or a block in the scene for which to disable a zoom auto-fit.
+     * @returns True if the given block has auto-fit set or the scene contains a block for which auto-fit is set, false
+     * otherwise.
+     */
+    isZoomAutoFitEnabled(blockOrScene: DesignBlockId): boolean;
     /**
      * Subscribe to changes to the zoom level.
      * @param callback - This function is called at the end of the engine update, if the zoom level has changed.
@@ -3154,6 +3276,7 @@ export declare class SelectionChannel implements ReadWriteChannelSync<number[]>
     subscribe: Source<number[]>;
     update: (selectedDesignElements: number[]) => void;
     value: () => number[];
+    blocks: ChannelSync<Block[]>;
 
     private deselectAll;
     private selectAll;
@@ -3208,6 +3331,12 @@ export declare type StrokeStyle = 'Dashed' | 'DashedRound' | 'Dotted' | 'LongDas
 /** @public */
 declare type Subscription = number;
 
+/**
+ * Checks if the current browser supports necessary technologies to match our supported browsers
+ * @public
+ */
+export declare function supportsBrowser(): boolean;
+
 /**
  * Checks if the current browser supports video editing
  * @public
@@ -3305,14 +3434,14 @@ export declare interface Vec4 {
 }
 
 /**
- * This channel allows to subscribe/update the current zoom level of the camera.
+ * Describes a rectangle on the screen
+ * - `x` and `y` indicate the position
+ * - `w` and `h` indicate the width and height
  * @public
  */
-export declare class ZoomLevelChannel implements ReadWriteChannelSync<number> {
-    subscribe: Source<number>;
-    update: (zoomLevel: number) => void;
-    value: () => number;
+export declare type XYWH = [x: number, y: number, w: number, h: number];
 
-}
+/**  @public */
+export declare type ZoomAutoFitAxis = 'Horizontal' | 'Vertical' | 'Both';
 
 export { }