@cesdk/cesdk-js 1.4.0 → 1.4.3

package/BlockAPI.d.ts

@@ -10,6 +10,7 @@ type Size2 = {
   width: number;
   height: number;
 };
+type RGBA = [r: number, g: number, b: number, a: number];
 
 export enum PositionMode {
   /** Position in absolute design units. */
@@ -29,6 +30,16 @@ export enum SizeMode {
   Auto = 'Auto'
 }
 
+export enum PropertyType {
+  Bool = 'Bool',
+  Int = 'Int',
+  Float = 'Float',
+  String = 'String',
+  Color = 'Color',
+  Enum = 'Enum',
+  Struct = 'Struct'
+}
+
 export default class BlockAPI {
   /**
    * Exports a design block element as a file of the given mime type.
@@ -390,4 +401,385 @@ export default class BlockAPI {
    * @return UBQResult<float> The height of the axis-aligned bounding box.
    */
   getGlobalBoundingBoxHeight(id: DesignBlockId): number;
+
+  /**
+   * Get all available properties of a block.
+   * @param id The block whose properties should be queried.
+   * @returns A list of the property names.
+   */
+  findAllProperties(id: DesignBlockId): string[];
+
+  /**
+   * Get the type of a property given its name.
+   * @param property The name of the property whose type should be queried.
+   * @returns The property type.
+   */
+  getPropertyType(property: string): PropertyType;
+
+  /**
+   * Get all the possible values of an enum given an enum property.
+   * @param enumProperty The name of the property whose enum values should be queried.
+   * @returns A list of the enum value names as string.
+   */
+  getEnumValues<T = string>(enumProperty: string): T[];
+
+  /**
+   * Set a bool 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 value The value to set.
+   */
+  setBool(id: DesignBlockId, property: string, value: boolean): void;
+
+  /**
+   * Get the value of a bool 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.
+   */
+  getBool(id: DesignBlockId, property: string): boolean;
+
+  /**
+   * Set an int 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 value The value to set.
+   */
+  setInt(id: DesignBlockId, property: string, value: number): void;
+
+  /**
+   * Get the value of an int 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.
+   */
+  getInt(id: DesignBlockId, property: string): number;
+
+  /**
+   * Set a float 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 value The value to set.
+   */
+  setFloat(id: DesignBlockId, property: string, value: number): void;
+
+  /**
+   * Get the value of a float 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.
+   */
+  getFloat(id: DesignBlockId, property: string): number;
+
+  /**
+   * Set a string 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 value The value to set.
+   */
+  setString(id: DesignBlockId, property: string, value: string): 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.
+   */
+  getString(id: DesignBlockId, property: string): string;
+
+  /**
+   * 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 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,
+    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 A tuple of channels red, green, blue and alpha in the range of 0 to 1.
+   */
+  getColorRGBA(id: DesignBlockId, property: string): RGBA;
+
+  /**
+   * Set an enum property of the given design block to the given value.
+   * @param block The block whose property should be set.
+   * @param property The name of the property to set.
+   * @param value The enum value as string.
+   */
+  setEnum(id: DesignBlockId, property: string, value: string): void;
+
+  /**
+   * Get the value of an enum property of the given design block.
+   * @param block The block whose property should be queried.
+   * @param property The name of the property to query.
+   * @returns The value as string.
+   */
+  getEnum(id: DesignBlockId, property: string): string;
+
+  /**
+   * Query if the given block has crop properties.
+   * @param id The block to query.
+   * @returns true, if the block has crop properties.
+   */
+  hasCrop(id: DesignBlockId): boolean;
+
+  /**
+   * Set the crop scale in x direction of the given design block.
+   * @param id The block whose crop should be set.
+   * @param scaleX The scale in x direction.
+   */
+  setCropScaleX(id: DesignBlockId, scaleX: number): void;
+
+  /**
+   * Set the crop scale in y direction of the given design block.
+   * @param id The block whose crop should be set.
+   * @param scaleY The scale in y direction.
+   */
+  setCropScaleY(id: DesignBlockId, scaleY: number): void;
+
+  /**
+   * Set the crop rotation of the given design block.
+   * @param id The block whose crop should be set.
+   * @param rotation The rotation in radians.
+   */
+  setCropRotation(id: DesignBlockId, rotation: number): void;
+
+  /**
+   * Set the crop translation in x direction of the given design block.
+   * @param id The block whose crop should be set.
+   * @param translationY The translation in x direction.
+   */
+  setCropTranslationX(id: DesignBlockId, translationX: number): void;
+
+  /**
+   * Set the crop translation in y direction of the given design block.
+   * @param id The block whose crop should be set.
+   * @param translationY The translation in y direction.
+   */
+  setCropTranslationY(id: DesignBlockId, translationY: number): void;
+
+  /**
+   * Resets the manually set crop of the given design block.
+   * The block's content fill mode is set to 'cover'.
+   * @param id The block whose crop should be reset.
+   */
+  resetCrop(id: DesignBlockId): void;
+
+  /**
+   * 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.
+   */
+  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.
+   * @param id The block to query.
+   * @returns true, if the block has an opcity.
+   */
+  hasOpacity(id: DesignBlockId): boolean;
+
+  /**
+   * Set the opacity of the given design block.
+   * @param id The block whose opacity should be set.
+   * @param opacity The opacity to be set. The valid range is 0 to 1.
+   */
+  setOpacity(id: DesignBlockId, opacity: number): void;
+
+  /**
+   * Get the opacity of the given design block.
+   * @param id The block whose opacity should be queried.
+   * @returns The opacity in a range of 0 to 1.
+   */
+  getOpacity(id: DesignBlockId): number;
+
+  /**
+   * Query if the given block has fill color properties.
+   * @param id The block to query.
+   * @returns true, if the block has fill color properties.
+   */
+  hasFillColor(id: DesignBlockId): boolean;
+
+  /**
+   * 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
+   * @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,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
+
+  /**
+   * Get the fill color of the given design block.
+   * @param id The block whose fill color should be queried.
+   * @returns The fill color.
+   */
+  getFillColorRGBA(id: DesignBlockId): RGBA;
+
+  /**
+   * Enable or disable the fill of the given design block.
+   * @param id The block whose fill should be enabled or disabled.
+   * @param enabled If true, the fill will be enabled.
+   */
+  setFillColorEnabled(id: DesignBlockId, enabled: boolean): void;
+
+  /**
+   * Query if the fill of the given design block is enabled.
+   * @param id The block whose fill state should be queried.
+   * @returns True, if fill is enabled.
+   */
+  isFillColorEnabled(id: DesignBlockId): boolean;
+
+  /**
+   * Query if the given block has background color properties.
+   * @param id The block to query.
+   * @returns true, if the block has background color properties.
+   */
+  hasBackgroundColor(id: DesignBlockId): boolean;
+
+  /**
+   * 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
+   * @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,
+    r: number,
+    g: number,
+    b: number,
+    a: number
+  ): void;
+
+  /**
+   * Get the background color of the given design block.
+   * @param id The block whose background color should be queried.
+   * @returns The background color.
+   */
+  getBackgroundColorRGBA(id: DesignBlockId): RGBA;
+
+  /**
+   * Enable or disable the background of the given design block.
+   * @param id The block whose background should be enabled or disabled.
+   * @param enabled If true, the background will be enabled.
+   */
+  setBackgroundColorEnabled(id: DesignBlockId, enabled: boolean): void;
+
+  /**
+   * Query if the background of the given design block is enabled.
+   * @param id The block whose background state should be queried.
+   * @returns True, if background is enabled.
+   */
+  isBackgroundColorEnabled(id: DesignBlockId): boolean;
+
+  /**
+   * Query if the given block has outline properties.
+   * @param id The block to query.
+   * @returns true, if the block has outline properties.
+   */
+  hasOutline(id: DesignBlockId): boolean;
+
+  /**
+   * 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
+   * @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.
+   * @param id The block whose outline color should be queried.
+   * @returns The outline color.
+   */
+  getOutlineColorRGBA(id: DesignBlockId): RGBA;
+
+  /**
+   * Enable or disable the outline of the given design block.
+   * @param id The block whose outline should be enabled or disabled.
+   * @param enabled If true, the outline will be enabled.
+   */
+  setOutlineEnabled(id: DesignBlockId, enabled: boolean): void;
+
+  /**
+   * Query if the outline of the given design block is enabled.
+   * @param id The block whose outline state should be queried.
+   * @returns True, if outline is enabled.
+   */
+  isOutlineEnabled(id: DesignBlockId): boolean;
+
+  /**
+   * Set the outline width of the given design block.
+   * @param id The block whose outline width should be set.
+   * @param width The outline width to be set.
+   */
+  setOutlineWidth(id: DesignBlockId, width: number): void;
+
+  /**
+   * Get the outline width of the given design block.
+   * @param id The block whose outline width should be queried.
+   * @returns The outline width.
+   */
+  getOutlineWidth(id: DesignBlockId): number;
 }

package/api.d.ts

@@ -1,6 +1,5 @@
 import BlockAPI from './BlockAPI';
 import SceneAPI from './SceneAPI';
-import PropertyAPI from './PropertyAPI';
 import VariableAPI from './VariableAPI';
 
 export default class API {
@@ -8,7 +7,5 @@ export default class API {
 
   scene: SceneAPI;
 
-  property: PropertyAPI;
-
   variable: VariableAPI;
 }

package/cesdk-engine.umd.d.ts

@@ -1,7 +1,6 @@
-import BlockAPI from './BlockAPI';
+import BlockAPI, { PropertyType } from './BlockAPI';
 import SceneAPI from './SceneAPI';
 import VariableAPI from './VariableAPI';
-import PropertyAPI, { PropertyType } from './PropertyAPI';
 import { UserConfiguration } from './types';
 
 export { PropertyType };
@@ -16,8 +15,6 @@ export default class CreativeEngine {
 
   scene: SceneAPI;
 
-  property: PropertyAPI;
-
   variable: VariableAPI;
 
   private constructor(...args: unknown[]);