@sapui5/types 1.136.14 → 1.136.16

package/types/sap.ui.vk.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.6
+// For Library Version: 1.136.8
 
 declare module "sap/ui/vk/library" {
   /**
@@ -8626,6 +8626,301 @@ declare module "sap/ui/vk/dvl/ViewStateManager" {
     extends $ViewStateManagerBaseSettings {}
 }
 
+declare module "sap/ui/vk/ecad/ElementsPanel" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  import Event from "sap/ui/base/Event";
+
+  import { ID, CSSSize } from "sap/ui/core/library";
+
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
+
+  import ContentConnector from "sap/ui/vk/ContentConnector";
+
+  import ViewStateManagerBase from "sap/ui/vk/ViewStateManagerBase";
+
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
+  /**
+   * Provides a list of all ECAD elements in a given scene in table format.
+   *
+   * **NOTE:** To use this control the application developer should add dependencies to the following libraries
+   * on application level to ensure that the libraries are loaded before the module dependencies will be required:
+   *
+   * 	 - sap.f
+   * 	 - sap.ui.comp
+   *
+   * @since 1.136.0
+   */
+  export default class ElementsPanel extends Control {
+    /**
+     * Constructor for a new ElementsPanel.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $ElementsPanelSettings
+    );
+    /**
+     * Constructor for a new ElementsPanel.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * id for the new control, generated automatically if no id is given
+       */
+      sId?: string,
+      /**
+       * initial settings for the new control
+       */
+      mSettings?: $ElementsPanelSettings
+    );
+
+    /**
+     * Creates a new subclass of class sap.ui.vk.ecad.ElementsPanel with name `sClassName` and enriches it with
+     * the information contained in `oClassInfo`.
+     *
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+     *
+     *
+     * @returns Created class / constructor function
+     */
+    static extend<T extends Record<string, unknown>>(
+      /**
+       * Name of the class being created
+       */
+      sClassName: string,
+      /**
+       * Object literal with information about the class
+       */
+      oClassInfo?: sap.ClassInfo<T, ElementsPanel>,
+      /**
+       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+       * used by this class
+       */
+      FNMetaImpl?: Function
+    ): Function;
+    /**
+     * Returns a metadata object for class sap.ui.vk.ecad.ElementsPanel.
+     *
+     *
+     * @returns Metadata object describing this class
+     */
+    static getMetadata(): ElementMetadata;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.ui.vk.ecad.ElementsPanel` itself.
+     *
+     * This event will be fired when content is replaced.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachContentChanged(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.ElementsPanel` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.ui.vk.ecad.ElementsPanel` itself.
+     *
+     * This event will be fired when content is replaced.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachContentChanged(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.ElementsPanel` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:contentChanged contentChanged} event of this
+     * `sap.ui.vk.ecad.ElementsPanel`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachContentChanged(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event {@link #event:contentChanged contentChanged} to attached listeners.
+     *
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    fireContentChanged(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: object
+    ): this;
+    /**
+     * ID of the element which is the current target of the association {@link #getContentConnector contentConnector},
+     * or `null`.
+     */
+    getContentConnector(): ID | null;
+    /**
+     * Gets current value of property {@link #getHeight height}.
+     *
+     * Default value is `"100%"`.
+     *
+     *
+     * @returns Value of property `height`
+     */
+    getHeight(): CSSSize;
+    /**
+     * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager},
+     * or `null`.
+     */
+    getViewStateManager(): ID | null;
+    /**
+     * Gets current value of property {@link #getWidth width}.
+     *
+     * Default value is `"auto"`.
+     *
+     *
+     * @returns Value of property `width`
+     */
+    getWidth(): CSSSize;
+    /**
+     * Sets the associated {@link #getContentConnector contentConnector}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setContentConnector(
+      /**
+       * ID of an element which becomes the new target of this contentConnector association; alternatively, an
+       * element instance may be given
+       */
+      oContentConnector: ID | ContentConnector
+    ): this;
+    /**
+     * Sets a new value for property {@link #getHeight height}.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"100%"`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setHeight(
+      /**
+       * New value for property `height`
+       */
+      sHeight?: CSSSize
+    ): this;
+    /**
+     * Sets the associated {@link #getViewStateManager viewStateManager}.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setViewStateManager(
+      /**
+       * ID of an element which becomes the new target of this viewStateManager association; alternatively, an
+       * element instance may be given
+       */
+      oViewStateManager: ID | ViewStateManagerBase
+    ): this;
+    /**
+     * Sets a new value for property {@link #getWidth width}.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"auto"`.
+     *
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setWidth(
+      /**
+       * New value for property `width`
+       */
+      sWidth?: CSSSize
+    ): this;
+  }
+  /**
+   * Describes the settings that can be provided to the ElementsPanel constructor.
+   */
+  export interface $ElementsPanelSettings extends $ControlSettings {
+    width?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    height?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * An association to the `ContentConnector` instance that manages content resources.
+     */
+    contentConnector?: ContentConnector | string;
+
+    /**
+     * An association to the `ViewStateManager` instance.
+     */
+    viewStateManager?: ViewStateManagerBase | string;
+
+    /**
+     * This event will be fired when content is replaced.
+     */
+    contentChanged?: (oEvent: Event) => void;
+  }
+
+  /**
+   * Parameters of the ElementsPanel#contentChanged event.
+   */
+  export interface ElementsPanel$ContentChangedEventParameters {}
+
+  /**
+   * Event object of the ElementsPanel#contentChanged event.
+   */
+  export type ElementsPanel$ContentChangedEvent = Event<
+    ElementsPanel$ContentChangedEventParameters,
+    ElementsPanel
+  >;
+}
+
 declare module "sap/ui/vk/ecad/LayersPanel" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
@@ -25965,6 +26260,10 @@ declare module "sap/ui/vk/threejs/Viewport" {
          * Indicator to retrieve selection information.
          */
         selection?: boolean | object;
+        /**
+         * Indicator to retrieve cross-section tool information.
+         */
+        crossSection?: boolean | object;
       }
     ): object;
     /**
@@ -26143,6 +26442,27 @@ declare module "sap/ui/vk/threejs/Viewport" {
            */
           outlined: string[];
         };
+        /**
+         * A JSON-like object containing the cross-section tool information.
+         */
+        crossSection?: {
+          /**
+           * Indicator whether the cross-section tool is enabled.
+           */
+          enabled?: boolean;
+          /**
+           * Axis along which the cross-section is performed (0 - X, 1 - Y, 2 - Z).
+           */
+          axis?: int;
+          /**
+           * Indicator whether the cross-section direction is flipped.
+           */
+          flip?: boolean;
+          /**
+           * Position of the cross-section planes defined as [x, y, z].
+           */
+          position?: float[];
+        };
       },
       /**
        * Fly-to animation duration in seconds.
@@ -30349,6 +30669,15 @@ declare module "sap/ui/vk/tools/CrossSectionTool" {
      * @returns Value of property `showEditingUI`
      */
     getShowEditingUI(): boolean;
+    /**
+     * Gets information about the current state.
+     *
+     * @since 1.145.0
+     *
+     * @returns JSON-like object which holds the current state information. See {@link sap.ui.vk.tools.CrossSectionTool#setState setState }
+     * for details.
+     */
+    getState(): object | null;
     /**
      * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should
      * be called using this method.
@@ -30404,6 +30733,40 @@ declare module "sap/ui/vk/tools/CrossSectionTool" {
        */
       bShowEditingUI?: boolean
     ): this;
+    /**
+     * Sets the current state.
+     *
+     * @since 1.145.0
+     *
+     * @returns `this` to allow method chaining.
+     */
+    setState(
+      /**
+       * JSON-like object which holds the state information. See below for details.
+       */
+      state?: {
+        /**
+         * Specifies whether the cross section tool should be activated.
+         */
+        enabled?: boolean;
+        /**
+         * Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z.
+         */
+        axis?: number;
+        /**
+         * If set to `true`, the clipping plane will be flipped.
+         */
+        flip?: boolean;
+        /**
+         * The position of the clipping planes defined as [x, y, z].
+         */
+        position?: number[];
+      },
+      /**
+       * The viewport where the tool is used.
+       */
+      viewport?: Viewport
+    ): this;
   }
   /**
    * Describes the settings that can be provided to the CrossSectionTool constructor.
@@ -38981,6 +39344,12 @@ declare module "sap/ui/vk/Viewer" {
    * Provides simple 3D visualization capability by connecting, configuring and presenting the essential Visualization
    * Toolkit controls a single composite control.
    *
+   * **NOTE:** To use this control the application developer should add dependencies to the following libraries
+   * on application level to ensure that the libraries are loaded before the module dependencies will be required:
+   *
+   * 	 - sap.f
+   * 	 - sap.ui.comp
+   *
    * @since 1.32.0
    */
   export default class Viewer extends Control {
@@ -42408,6 +42777,10 @@ declare module "sap/ui/vk/Viewport" {
          * Indicator to retrieve selection information.
          */
         selection?: boolean | object;
+        /**
+         * Indicator to retrieve cross-section information.
+         */
+        crossSection?: boolean | object;
       }
     ): object;
     /**
@@ -47454,6 +47827,8 @@ declare namespace sap {
 
     "sap/ui/vk/dvl/ViewStateManager": undefined;
 
+    "sap/ui/vk/ecad/ElementsPanel": undefined;
+
     "sap/ui/vk/ecad/LayersPanel": undefined;
 
     "sap/ui/vk/FlexibleControl": undefined;