@cesdk/engine 1.9.0-preview.1 → 1.9.0-preview.3

package/index.d.ts

@@ -366,6 +366,7 @@ export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply'
  * @public
  */
 export declare class Block extends Entity {
+    #private;
     effects: ReadWriteChannelSync<number[]>;
     soloPlaybackEnabled: ReadWriteChannelSync<boolean>;
     trimOffset: ReadWriteChannelSync<number>;
@@ -375,8 +376,11 @@ export declare class Block extends Entity {
     selection: ReadWriteChannelSync<boolean>;
     videoMode: ReadWriteChannelSync<boolean>;
     duration: ReadWriteChannelSync<number>;
+    name: ReadWriteChannelSync<string>;
     muted: ReadWriteChannelSync<boolean>;
     avResourceTotalDuration: ReadWriteChannelSync<number>;
+    timeOffset: ReadWriteChannelSync<number>;
+
 
 }
 
@@ -811,6 +815,18 @@ export declare class BlockAPI {
      * @returns A list of the property names.
      */
     findAllProperties(id: DesignBlockId): string[];
+    /**
+     * Check if a property with a given name is readable
+     * @param property - The name of the property whose type should be queried.
+     * @returns Whether the property is readable or not. Will return false for unknown properties
+     */
+    isPropertyReadable(property: string): boolean;
+    /**
+     * Check if a property with a given name is writable
+     * @param property - The name of the property whose type should be queried.
+     * @returns Whether the property is writable or not. Will return false for unknown properties
+     */
+    isPropertyWritable(property: string): boolean;
     /**
      * Get the type of a property given its name.
      * @param property - The name of the property whose type should be queried.
@@ -1966,6 +1982,13 @@ export declare interface Configuration {
      * If not configured the fallback font is used.
      */
     defaultFont?: string;
+    /**
+     * By default the engine tries to create a webgl2 context. If this fails it
+     * falls back to trying to create a webgl1 context. If this configuration
+     * option is set to true, it will no longer try to create a webgl2 context
+     * and always create a webgl1 context.
+     */
+    forceWebGL1?: boolean;
 }
 
 /**
@@ -2713,7 +2736,7 @@ export declare class SceneAPI {
      * Create a new design scene, along with its own camera.
      * @returns The scene's handle.
      */
-    create(): DesignBlockId;
+    create(sceneLayout?: SceneLayout): DesignBlockId;
     /**
      * Create a new scene in video mode, along with its own camera and page stack.
      * @returns The scene's handle.
@@ -2728,7 +2751,7 @@ export declare class SceneAPI {
      * @param pixelScaleFactor - The displays pixel scale factor.
      * @returns A promise that resolves with the scene ID on success or rejected with an error otherwise.
      */
-    createFromImage(url: string, dpi?: number, pixelScaleFactor?: number): Promise<DesignBlockId>;
+    createFromImage(url: string, dpi?: number, pixelScaleFactor?: number, sceneLayout?: SceneLayout, spacing?: number, spacingInScreenSpace?: boolean): Promise<DesignBlockId>;
     /**
      * Return the currently active scene.
      * @returns The scene or null, if none was created yet.
@@ -2777,6 +2800,13 @@ 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>;
+    /**
+     * 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.
+     * @returns A method to unsubscribe.
+     * @privateRemarks This will currently fire on _all_ changes to camera properties
+     */
+    onZoomLevelChanged(callback: () => void): () => void;
     /**
      * Converts all values of the current scene into the given design unit.
      * @param designUnit - The new design unit of the scene
@@ -2789,6 +2819,9 @@ export declare class SceneAPI {
     unstable_getDesignUnit(): DesignUnit;
 }
 
+/** @public */
+export declare type SceneLayout = 'Free' | 'VerticalStack' | 'HorizontalStack' | 'DepthStack';
+
 /** @public */
 export declare interface Size2 {
     width: number;
@@ -2930,4 +2963,16 @@ export declare interface Vec4 {
     w: number;
 }
 
+/**
+ * This channel allows to subscribe/update the current zoom level of the camera.
+ * @public
+ */
+export declare class ZoomLevelChannel implements ReadWriteChannelSync<number> {
+    #private;
+    subscribe: Source<number>;
+
+    update: (zoomLevel: number) => void;
+    value: () => number;
+}
+
 export { }