@cesdk/cesdk-js 1.4.0-alpha.5 → 1.4.0-alpha.6

package/BlockAPI.d.ts

@@ -6,12 +6,29 @@ type MimeType =
   | 'image/jpeg'
   | 'image/x-tga'
   | 'application/octet-stream';
-type Size = number; // | 'auto';
 type Size2 = {
-  width: Size;
-  height: Size;
+  width: number;
+  height: number;
 };
 
+export enum PositionMode {
+  /** Position in absolute design units. */
+  Absolute = 'Absolute',
+  /** Position in relation to the block's parent's size in percent, where 1.0 means 100%. */
+  Percent = 'Percent',
+  /** Position is not defined. */
+  Undefined = 'Undefined'
+}
+
+export enum SizeMode {
+  /** Size in absolute design units. */
+  Absolute = 'Absolute',
+  /** Size in relation to the block's parent's size in percent, where 1.0 means 100%. */
+  Percent = 'Percent',
+  /** Size is determined by the block's content. */
+  Auto = 'Auto'
+}
+
 export default class BlockAPI {
   /**
    * Exports a design block element as a file of the given mime type.
@@ -124,18 +141,60 @@ export default class BlockAPI {
   setVisible(id: DesignElementId, visible: boolean): void;
 
   /**
-   * Query a block's absolute position in design units.
+   * Query a block's x position.
+   * @param id The block to query.
+   * @returns The value of the x position.
+   */
+  getPositionX(id: DesignElementId): number;
+
+  /**
+   * Query a block's mode for its x position.
+   * @param id The block to query.
+   * @returns The current mode for the x position: absolute, percent or undefined.
+   */
+  getPositionXMode(id: DesignElementId): PositionMode;
+
+  /**
+   * Query a block's y position.
+   * @param id The block to query.
+   * @returns The value of the y position.
+   */
+  getPositionY(id: DesignElementId): number;
+
+  /**
+   * Query a block's mode for its y position.
    * @param id The block to query.
-   * @returns
+   * @returns The current mode for the y position: absolute, percent or undefined.
+   */
+  getPositionYMode(id: DesignElementId): PositionMode;
+
+  /**
+   * Update a block's x position.
+   * @param id The block to update.
+   * @param value The value of the x position.
+   */
+  setPositionX(id: DesignElementId, value: number): void;
+
+  /**
+   * Set a block's mode for its x position.
+   * @param id The block to update.
+   * @param mode The x position mode: absolute, percent or undefined.
+   */
+  setPositionXMode(id: DesignElementId, mode: PositionMode): void;
+
+  /**
+   * Update a block's y position.
+   * @param id The block to update.
+   * @param value The value of the y position.
    */
-  getPosition(id: DesignElementId): Vec2;
+  setPositionY(id: DesignElementId, value: number): void;
 
   /**
-   * Update a block's absolute position.
+   * Set a block's mode for its y position.
    * @param id The block to update.
-   * @param { x, y } pos The new position in design units.
+   * @param mode The y position mode: absolute, percent or undefined.
    */
-  setPosition(id: DesignElementId, { x, y }: Vec2): void;
+  setPositionYMode(id: DesignElementId, mode: PositionMode): void;
 
   /**
    * Query a block's rotation in radians.
@@ -169,7 +228,6 @@ export default class BlockAPI {
    * Update a block's horizontal flip.
    * @param id The block to update.
    * @param horizontal Whether the block should be flipped along its x-axis.
-   * @returns
    */
   setFlipHorizontal(id: DesignElementId, flip: boolean): void;
 
@@ -177,23 +235,64 @@ export default class BlockAPI {
    * Update a block's vertical flip.
    * @param id The block to update.
    * @param vertical Whether the block should be flipped along its y-axis.
-   * @returns
    */
   setFlipVertical(id: DesignElementId, flip: boolean): void;
 
   /**
-   * Query a block's absolute size in design units.
+   * Query a block's width.
+   * @param id The block to query.
+   * @returns The value of the block's width.
+   */
+  getWidth(id: DesignElementId): number;
+
+  /**
+   * Query a block's mode for its width.
+   * @param id The block to query.
+   * @returns The current mode for the width: absolute, percent or auto.
+   */
+  getWidthMode(id: DesignElementId): SizeMode;
+
+  /**
+   * Query a block's height.
+   * @param id The block to query.
+   * @returns The value of the block's height.
+   */
+  getHeight(id: DesignElementId): number;
+
+  /**
+   * Query a block's mode for its height.
    * @param id The block to query.
-   * @returns A `Size2` object.
+   * @returns The current mode for the height: absolute, percent or auto.
+   */
+  getHeightMode(id: DesignElementId): SizeMode;
+
+  /**
+   * Update a block's width.
+   * @param id The block to update.
+   * @param value The new width of the block.
+   */
+  setWidth(id: DesignElementId, value: number): void;
+
+  /**
+   * Set a block's mode for its width.
+   * @param id The block to update.
+   * @param mode The width mode: absolute, percent or auto.
+   */
+  setWidthMode(id: DesignElementId, mode: SizeMode): void;
+
+  /**
+   * Update a block's height.
+   * @param id The block to update.
+   * @param value The new height of the block.
    */
-  getSize(id: DesignElementId): Size2;
+  setHeight(id: DesignElementId, value: number): void;
 
   /**
-   * Update a block's absolute size in design units.
+   * Set a block's mode for its height.
    * @param id The block to update.
-   * @param size A size object defining width and height.
+   * @param mode The height mode: absolute, percent or auto.
    */
-  setSize(id: DesignElementId, size: Size2): void;
+  setHeightMode(id: DesignElementId, mode: SizeMode): void;
 
   /**
    * Get a block's layouted size. Requires an `engine.render()` beforehand.

package/PropertyAPI.d.ts

@@ -1,16 +1,5 @@
 type DesignBlockId = number;
 type RGBA = [r: number, g: number, b: number, a: number];
-type Size2 = {
-  width: number;
-  height: number;
-};
-type Crop = {
-  scaleX: number;
-  scaleY: number;
-  rotation: number;
-  translationX: number;
-  translationY: number;
-};
 
 export enum PropertyType {
   Bool = 'Bool',
@@ -18,7 +7,6 @@ export enum PropertyType {
   Float = 'Float',
   String = 'String',
   Color = 'Color',
-  Size = 'Size',
   Enum = 'Enum',
   Struct = 'Struct'
 }
@@ -113,42 +101,28 @@ export default class PropertyAPI {
    * Set a color property of the given design block to the given value.
    * @param id The block whose property should be set.
    * @param property The name of the property to set.
-   * @param color A tuple of channels red, green, blue and alpha in the range 0 to 1.
+   * @param r The red color component in the range of 0 to 1.
+   * @param g The green color component in the range of 0 to 1.
+   * @param b The blue color component in the range of 0 to 1.
+   * @param a The alpha color component in the range of 0 to 1.
    */
-  setColorRGBA(id: DesignBlockId, property: string, color: RGBA): void;
+  setColorRGBA(
+    id: DesignBlockId,
+    property: string,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
 
   /**
    * Get the value of a string property of the given design block.
    * @param id The block whose property should be queried.
    * @param property The name of the property to query.
-   * @returns The value of the property.
+   * @returns A tuple of channels red, green, blue and alpha in the range of 0 to 1.
    */
   getColorRGBA(id: DesignBlockId, property: string): RGBA;
 
-  /**
-   * Set a size property's width of the given design block to the given value.
-   * @param id The block whose property should be set.
-   * @param property The name of the property to set.
-   * @param value The width to set to.
-   */
-  setSize2Width(id: DesignBlockId, property: string, value: number);
-
-  /**
-   * Set a size property's height of the given design block to the given value.
-   * @param id The block whose property should be set.
-   * @param property The name of the property to set.
-   * @param value The height to set to.
-   */
-  setSize2Height(id: DesignBlockId, property: string, value: number): void;
-
-  /**
-   * Get the value of a size property of the given design block.
-   * @param id The block whose property should be queried.
-   * @param property The name of the property to query.
-   * @returns The value of the property.
-   */
-  getSize2(id: DesignBlockId, property: string): Size2;
-
   /**
    * Set an enum property of the given design block to the given value.
    * @param block The block whose property should be set.
@@ -208,11 +182,39 @@ export default class PropertyAPI {
   setCropTranslationY(id: DesignBlockId, translationY: number): void;
 
   /**
-   * Get the crop of the given design block.
-   * @param id The block whose crop should be queried.
-   * @returns An object with crop properties of scale, rotation and translation.
+   * Get the crop scale on the x axis of the given design block.
+   * @param id The block whose scale should be queried.
+   * @returns The scale on the x axis.
+   */
+  getCropScaleX(id: DesignBlockId): number;
+
+  /**
+   * Get the crop scale on the y axis of the given design block.
+   * @param id The block whose scale should be queried.
+   * @returns The scale on the y axis.
+   */
+  getCropScaleY(id: DesignBlockId): number;
+
+  /**
+   * Get the crop rotation of the given design block.
+   * @param id The block whose crop rotation should be queried.
+   * @returns The crop rotation.
    */
-  getCrop(id: DesignBlockId): Crop;
+  getCropRotation(id: DesignBlockId): number;
+
+  /**
+   * Get the crop translation on the x axis of the given design block.
+   * @param id The block whose translation should be queried.
+   * @returns The translation on the x axis.
+   */
+  getCropTranslationX(id: DesignBlockId): number;
+
+  /**
+   * Get the crop translation on the y axis of the given design block.
+   * @param id The block whose translation should be queried.
+   * @returns The translation on the y axis.
+   */
+  getCropTranslationY(id: DesignBlockId): number;
 
   /**
    * Query if the given block has an opacity.
@@ -231,7 +233,7 @@ export default class PropertyAPI {
   /**
    * Get the opacity of the given design block.
    * @param id The block whose opacity should be queried.
-   * @param opacity The opacity.
+   * @returns The opacity in a range of 0 to 1.
    */
   getOpacity(id: DesignBlockId): number;
 
@@ -246,9 +248,18 @@ export default class PropertyAPI {
    * Set the fill color of the given design block.
    * @param id The block whose fill color should be set.
    * @param color The fill color to be set, a tuple of
-   * red, green, blue and alpha in the range of 0 to 1.
+   * @param r The red color component in the range of 0 to 1.
+   * @param g The green color component in the range of 0 to 1.
+   * @param b The blue color component in the range of 0 to 1.
+   * @param a The alpha color component in the range of 0 to 1.
    */
-  setFillColorRGBA(id: DesignBlockId, color: RGBA): void;
+  setFillColorRGBA(
+    id: DesignBlockId,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
 
   /**
    * Get the fill color of the given design block.
@@ -282,9 +293,18 @@ export default class PropertyAPI {
    * Set the background color of the given design block.
    * @param id The block whose background color should be set.
    * @param color The background color to be set, a tuple of
-   * red, green, blue and alpha in the range of 0 to 1.
+   * @param r The red color component in the range of 0 to 1.
+   * @param g The green color component in the range of 0 to 1.
+   * @param b The blue color component in the range of 0 to 1.
+   * @param a The alpha color component in the range of 0 to 1.
    */
-  setBackgroundColorRGBA(id: DesignBlockId, color: RGBA): void;
+  setBackgroundColorRGBA(
+    id: DesignBlockId,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
 
   /**
    * Get the background color of the given design block.
@@ -318,9 +338,18 @@ export default class PropertyAPI {
    * Set the outline color of the given design block.
    * @param id The block whose outline color should be set.
    * @param color The outline color to be set, a tuple of
-   * red, green, blue and alpha in the range of 0 to 1.
-   */
-  setOutlineColorRGBA(id: DesignBlockId, color: RGBA): void;
+   * @param r The red color component in the range of 0 to 1.
+   * @param g The green color component in the range of 0 to 1.
+   * @param b The blue color component in the range of 0 to 1.
+   * @param a The alpha color component in the range of 0 to 1.
+   */
+  setOutlineColorRGBA(
+    id: DesignBlockId,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
 
   /**
    * Get the outline color of the given design block.