// For Library Version: 1.149.0 declare namespace sap { namespace ui { /** * SAPUI5 library with controls for displaying 3D models. */ namespace vk { /** * Retrieve the {@link sap.ui.vk.Core Core} instance for the current window. * * @since 1.50.0 * * @returns the API of the current Core instance. */ function getCore(): /* was: sap.ui.vk.Core */ any; namespace dvl { /** * Describes the settings that can be provided to the ContentManager constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.ContentManager } * instead. */ interface $ContentManagerSettings extends sap.ui.vk.$ContentManagerSettings {} /** * Describes the settings that can be provided to the NodeHierarchy constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.NodeHierarchy } * instead. */ interface $NodeHierarchySettings extends sap.ui.vk.$NodeHierarchySettings {} /** * Describes the settings that can be provided to the NodeProxy constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.NodeProxy } * instead. */ interface $NodeProxySettings extends sap.ui.vk.$NodeProxySettings {} /** * Describes the settings that can be provided to the Scene constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.Scene } * instead. */ interface $SceneSettings extends sap.ui.vk.$SceneSettings {} /** * Describes the settings that can be provided to the Viewport constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.Viewport } * instead. */ interface $ViewportSettings extends sap.ui.vk.$ViewportBaseSettings { /** * Viewport background top color in the ABGR format */ backgroundColorTopABGR?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport background bottom color in the ABGR format */ backgroundColorBottomABGR?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; pan?: (oEvent: Viewport$PanEvent) => void; zoom?: (oEvent: Viewport$ZoomEvent) => void; rotate?: (oEvent: Viewport$RotateEvent) => void; /** * This event will be fired when the frame rendering has finished. */ frameRenderingFinished?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the ViewStateManager constructor. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.ViewStateManager } * instead. */ interface $ViewStateManagerSettings extends sap.ui.vk.$ViewStateManagerBaseSettings {} /** * Parameters of the Viewport#frameRenderingFinished event. */ interface Viewport$FrameRenderingFinishedEventParameters {} /** * Parameters of the Viewport#pan event. */ interface Viewport$PanEventParameters { dx?: int; dy?: int; } /** * Parameters of the Viewport#rotate event. */ interface Viewport$RotateEventParameters { dx?: int; dy?: int; } /** * Parameters of the Viewport#zoom event. */ interface Viewport$ZoomEventParameters { zoomFactor?: float; } /** * Provides a simple, lightweight proxy object to a node in a node hierarchy. * * The objects of this class should not be created directly, and should only be created through the use * of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } * * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.BaseNodeProxy } * instead. */ class BaseNodeProxy extends sap.ui.vk.BaseNodeProxy implements sap.ui.base.Poolable { __implements__sap_ui_base_Poolable: boolean; /** * Constructor for a new BaseNodeProxy. The objects of this class should not be created directly, and should * only be created through the use of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } * * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.BaseNodeProxy#constructor sap.ui.vk.BaseNodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.dvl.BaseNodeProxy 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.vk.BaseNodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.BaseNodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Indicates whether the node has child nodes. * * * @returns A value of `true` indicates that the node has child nodes, and a value of `false` indicates * otherwise. */ getHasChildren(): boolean; /** * Gets the name of the node. * * * @returns The node's name. */ getName(): string; /** * Gets the ID of the node. * * * @returns The node's ID. */ getNodeId(): string; /** * Gets the metadata of the node. * * * @returns A JSON object containing the node's metadata. */ getNodeMetadata(): object; /** * Gets the reference object of the node. * * * @returns The node's reference object. */ getNodeRef(): string; /** * Gets the scene reference that this BaseNodeProxy object wraps. * * * @returns A scene reference that this BaseNodeProxy object wraps. */ getSceneRef(): any; /** * Initialize this BaseNodeProxy with its data. * * The `init` method is called by an object pool when the object is (re-)activated for a new caller. * See: * sap.ui.base.Poolable.prototype#init * * @ui5-protected Do not call from applications (only from related classes in the framework) */ init( /** * The NodeHierarchy object this BaseNodeProxy object belongs to. */ nodeHierarchy: sap.ui.vk.dvl.NodeHierarchy, /** * The ID of the node for which to get BaseNodeProxy. */ nodeRef: string ): void; /** * Reset BaseNodeProxy data, needed for pooling. * See: * sap.ui.base.Poolable.prototype#reset * * @ui5-protected Do not call from applications (only from related classes in the framework) */ reset(): void; } /** * Provides a loader that uses the DVL library to load VDS and VDSL files. * * @since 1.50.0 * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.ContentManager } * instead. */ class ContentManager extends sap.ui.vk.ContentManager { /** * Constructor for a new ContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. */ constructor( /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.dvl.$ContentManagerSettings ); /** * Constructor for a new ContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. */ constructor( /** * ID for the new ContentManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.dvl.$ContentManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.dvl.ContentManager 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.vk.ContentManager.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.ContentManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets optional Emscripten runtime module settings. * * @since 1.50.0 * * @returns A JSON-like object. See {@link ContentManager.setRuntimeSettings ContentManager.setRuntimeSettings}. */ static getRuntimeSettings(): object; /** * Gets optional WebGL context attributes. * * @since 1.50.0 * * @returns A JSON-like object. See {@link ContentManager.setWebGLContextAttributes ContentManager.setWebGLContextAttributes}. */ static getWebGLContextAttributes(): object; /** * Sets optional Emscripten runtime module settings. * * Emscripten runtime module settings cannot be changed after the Emscripten module is initialized. * * @since 1.50.0 */ static setRuntimeSettings( /** * A JSON object with the following properties. */ settings: { /** * The size of Emscripten module memory in bytes, default value: 512 MB. */ totalMemory?: int; /** * ID of a textarea DOM element to write the log to. */ logElementId?: string; /** * ID of a DOM element to write the status messages to. */ statusElementId?: string; } ): void; /** * Sets optional WebGL context attributes. * * @since 1.50.0 */ static setWebGLContextAttributes( /** * A JSON object with the following properties. */ attributes: { /** * If set to `true`, the context will attempt to perform antialiased rendering if possible. */ antialias?: boolean; /** * If set to `true`, the context will have an alpha (transparency) channel. */ alpha?: boolean; /** * If set to `true`, the color channels in the framebuffer will be stored premultiplied by the alpha channel * to improve performance. Other {@link https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2 WebGL context attributes } * are also supported. WebGL context attributes cannot be changed after the control is fully initialized. */ premultipliedAlpha?: boolean; } ): void; /** * Collects and destroys unused objects and resources. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ collectGarbage(): this; /** * Destroys the content. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ destroyContent( /** * The content to destroy. */ content: any ): this; /** * Starts downloading and building or updating the content from the content resources. * * This method is asynchronous. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ loadContent( /** * The current content to update. It can be `null` if this is an initial loading call. */ content: any, /** * The content resources to load or update. */ contentResources: sap.ui.vk.ContentResource[] ): this; } /** * Loads the DVL library, wraps it, and makes the wrapper available for the application. * * Example: * * ```javascript * var oGraphicsCore = new GraphicsCore();``` * * * * @since 1.32.0 * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.ContentConnector } * instead. */ class GraphicsCore extends sap.ui.base.EventProvider { /** * Constructor for a new GraphicsCore. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.EventProvider#constructor sap.ui.base.EventProvider } * can be used. */ constructor( /** * The Emscripten runtime settings. */ runtimeSettings: { /** * The size of Emscripten module memory in bytes. */ totalMemory: int; /** * The ID of a textarea DOM element to write the log to. */ logElementId: string; /** * The ID of a DOM element to write the status messages to. */ statusElementId: string; }, /** * The WebGL context attributes. See {@link https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2 WebGL context attributes}. */ webGLContextAttributes: object ); /** * Creates a new subclass of class sap.ui.vk.dvl.GraphicsCore 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.base.EventProvider.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.GraphicsCore. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Builds a scene tree from the hierarchy of content resources. The content resources must be already downloaded. * * * @returns The scene built from the content resources. */ buildSceneTree( /** * The array of content resources to build the scene from. */ contentResources: sap.ui.vk.ContentResource[] ): sap.ui.vk.dvl.Scene; /** * Builds a scene tree from the hierarchy of content resources. The content resources must be already loaded. * * * @returns A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise } * object that resolves with an object with two fields: * - `scene` - {@link sap.ui.vk.dvl.Scene sap.ui.vk.dvl.Scene} - the scene object. * - `failureReason` - object[] - the list of errors if any. */ buildSceneTreeAsync( /** * The array of content resources to build the scene from. */ contentResources: sap.ui.vk.ContentResource[] ): Promise; /** * Collects and destroys unused objects and resources. * * * @returns `this` to allow method chaining. */ collectGarbage(): this; /** * Creates a new ViewStateManager object. * * GraphicsCore owns the new ViewStateManager object. The object must be destroyed with the {@link #destroyViewStateManager destroyViewStateManager } * method; * * @deprecated As of version 1.50.0. Create instance of {@link sap.ui.vk.ViewStateManager} instead. * * @returns The newly created ViewStateManager object. */ createViewStateManager( /** * The NodeHierarchy object the view state manager is created for. */ nodeHierarchy: sap.ui.vk.NodeHierarchy, /** * Flag set by the application to decide whether the {sap.ui.vk.ViewStateManager} should track the visibility * changes or not. */ shouldTrackVisibilityChanges: boolean ): sap.ui.vk.ViewStateManager; /** * Destroys the scene object. * * * @returns `this` to allow method chaining. */ destroyScene( /** * The scene to destroy. */ vkScene: sap.ui.vk.dvl.Scene ): this; /** * Destroys the ViewStateManager object created with the {@link #createViewStateManager createViewStateManager } * method. * * @deprecated As of version 1.50.0. Use your reference to {@link sap.ui.vk.ViewStateManager} to properly * destroy this object. * * @returns `this` to allow method chaining. */ destroyViewStateManager( /** * The ViewStateManagerObject to destroy. */ viewStateManager: sap.ui.vk.ViewStateManager ): this; /** * Gets one of APIs supported by the DVL library. * * * @returns The object that implements the requested API or null if the API is not supported. */ getApi( /** * The API identifier. */ apiId: sap.ui.vk.dvl.GraphicsCoreApi ): object; /** * Gets an object that decrypts content of encrypted models. * * * @returns An object that decrypts content of encrypted models. */ getDecryptionHandler(): sap.ui.vk.DecryptionHandler; /** * Loads content resources. * * Content resources can be downloaded from a URL or loaded from a local file. * * * @returns `this` to allow method chaining. */ loadContentResourcesAsync( /** * The content resources to build the scene from. */ contentResources: sap.ui.vk.ContentResource[], /** * The callback function to call when all content resources are processed. The onComplete callback parameter * `sourcesFailedToLoad` takes an array of objects with the properties: source (The content resource that * failed to load), status (The VIT Message code i.e 'VIT22') and statusText (VIT Message Summary). */ onComplete: Function, /** * The callback function to call to report the file loading progress. */ onProgress: Function ): this; /** * Sets an object that decrypts content of encrypted models. * * * @returns `this` to allow method chaining. */ setDecryptionHandler( /** * An object that decrypts content of encrypted models. */ handler: sap.ui.vk.DecryptionHandler ): this; /** * Sets the maximum number of retry attempts for a download operation if the initial request to retrieve * a model from a remote server could not be fulfilled and the error with which the request failed is considered * recoverable. * * See {@link sap.ui.vk.ContentConnector#setRetryCount} for details. * * @since 1.95.0 * * @returns `this` to allow method chaining. */ setRetryCount( /** * Maximum number of retry attempts. Value must be non-negative. The default number of retry attempts is * 1, unless specified otherwise by calling this method and passing in the desired value. Specifying 0 disables * any retry attempts. */ retryCount: int ): this; /** * Shows or hides debug information in the viewports. * * * @returns `this` to allow method chaining. */ showDebugInfo( /** * `true` to show debug information, `false` to hide debug information. */ enable: boolean ): this; /** * Updates or rebuilds a scene tree from the hierarchy of content resources. * * The content resources must be already loaded. Some changes in the content resource hierarchy can lead * to rebuilding the scene completely. In this case a new scene is created. * * * @returns The scene updated or created. */ updateSceneTree( /** * The scene to update or null to force to create a new one. */ vkScene: sap.ui.vk.dvl.Scene, /** * The array of content resources to update or build the scene from. */ contentResources: sap.ui.vk.ContentResource[], /** * The callback function to call when an error happens. */ onError?: Function ): sap.ui.vk.dvl.Scene; /** * Updates or rebuilds a scene tree from the hierarchy of content resources. * * The content resources must be already loaded. Some changes in the content resource hierarchy can lead * to rebuilding the scene completely. In this case a new scene is created. * * * @returns A {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise } * object that resolves with an object with two fields: * - `scene` - {@link sap.ui.vk.dvl.Scene sap.ui.vk.dvl.Scene} - the scene object. * - `failureReason` - object[] - the list of errors if any. */ updateSceneTreeAsync( /** * The scene to update or null to force to create a new one. */ vkScene: sap.ui.vk.dvl.Scene, /** * The array of content resources to update or build the scene from. */ contentResources: sap.ui.vk.ContentResource[] ): Promise; } /** * Provides a proxy object to the layer in the node hierarchy. * * Layer is a list of nodes. One node hierarchy can have multiple layers. One node can be included in multiple * layers. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createLayerProxy sap.ui.vk.NodeHierarchy.createLayerProxy } * method and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyLayerProxy sap.ui.vk.NodeHierarchy.destroyLayerProxy } * method. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.LayerProxy } * instead. */ class LayerProxy extends sap.ui.vk.LayerProxy { /** * Constructor for a new LayerProxy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createLayerProxy sap.ui.vk.NodeHierarchy.createLayerProxy } * method and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyLayerProxy sap.ui.vk.NodeHierarchy.destroyLayerProxy } * method. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.LayerProxy#constructor sap.ui.vk.LayerProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.dvl.LayerProxy 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.vk.LayerProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.LayerProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Gets the description of the layer. * * * @returns The description of the layer. */ getDescription(): string; /** * Gets the layer ID. * * * @returns The layer ID. */ getLayerId(): string; /** * Gets the layer metadata. * * * @returns The layer metadata. */ getLayerMetadata(): object; /** * Gets the name of the layer * * * @returns The name of the layer. */ getName(): string; /** * Gets an array of IDs of nodes belonging to the layer. * * * @returns An array of IDs of nodes belonging to the layer. */ getNodes(): string[]; /** * Gets the layer VE IDs. * * * @returns The layer VE IDs. */ getVeIds(): object[]; } /** * Provides the ability to explore a Scene object's node structure. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene.getDefaultNodeHierarchy}. * * @since 1.32.0 * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.NodeHierarchy } * instead. */ class NodeHierarchy extends sap.ui.vk.NodeHierarchy { /** * Constructor for a new NodeHierarchy. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene.getDefaultNodeHierarchy}. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeHierarchy#constructor sap.ui.vk.NodeHierarchy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.dvl.NodeHierarchy 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.vk.NodeHierarchy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.NodeHierarchy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Creates a layer proxy object. * * The layer proxy object must be destroyed with the {@link #destroyLayerProxy destroyLayerProxy} method. * * * @returns The proxy object. */ createLayerProxy( /** * The layer ID for which to create a proxy object. */ layerId: string ): sap.ui.vk.LayerProxy; /** * Creates a new node. * * @since 1.48.0 * * @returns The node reference of the newly created node. */ createNode( /** * The parent node reference where the created node is added to. If equals `null` the newly created node * is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any ): any; /** * Creates a copy of an existing node. * * @since 1.48.0 * * @returns The node reference of the newly created node. */ createNodeCopy( /** * The reference to the node to copy. */ nodeToCopy: any, /** * The reference to the parent node where the created node is added to. If equals `null` the newly created * node is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any ): any; /** * Creates a node proxy object. * * The node proxy object must be destroyed with the {@link #destroyNodeProxy destroyNodeProxy} method. * * * @returns The proxy object. */ createNodeProxy( /** * The node reference for which to create a proxy object. */ nodeRef: any ): sap.ui.vk.dvl.NodeProxy; /** * Destroys the layer proxy object. * * * @returns `this` to allow method chaining. */ destroyLayerProxy( /** * The layer proxy object. */ layerProxy: sap.ui.vk.LayerProxy ): this; /** * Destroys the node proxy object. * * * @returns `this` to allow method chaining. */ destroyNodeProxy( /** * The node proxy object. */ nodeProxy: sap.ui.vk.dvl.NodeProxy ): this; /** * Enumerates the ancestor nodes of a particular node in the Scene object. * * This method enumerates the ancestor nodes of a particular node, and then calls the `callback` function, * to which it passes the ancestor nodes to one by one. * The BaseNodeProxy objects passed to `callback` are temporary objects, they are reset after each call * to the `callback` function. * The ancestor nodes are enumerated starting from the top level node, and progresses down the node hierarchy. * * * @returns `this` to allow method chaining. */ enumerateAncestors( /** * The node reference whose ancestor nodes we want enumerated. */ nodeRef: any, /** * A function to call when the ancestor nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.dvl.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to pass the node references of the ancestor nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the ancestor nodes are passed to the `callback` function. * * If `false`, then the node proxies of the ancestor nodes are passed to the `callback` function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * The node reference whose child nodes we want enumerated. * When `nodeRef` is specified, the child nodes of this node are enumerated. * When no `nodeRef` is specified, only the top level nodes are enumerated. */ nodeRef: any, /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.dvl.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.dvl.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Finds nodes in a scene via node name. * * * @returns A list of IDs belonging to nodes that matched the search criteria. */ findNodesByName( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * value: string | string[], * predicate: "equals" | "contains" | "startsWith", * caseSensitive: true | false * }``` * * * - **query.value** * A string or an array of strings containing the name of a node or names of nodes. If no value is specified, * then all nodes in the scene will be returned. * The following example shows a single string being passed in: * ```javascript * value: "Box #14"``` * The following example shows an array of strings being passed in: * ```javascript * value: ["Box #3", "box #4", "BOX #5"]``` * * - **query.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for nodes with names that exactly match the provided string or array of * strings. * Using `"contains"` will search for nodes with names containing all or part of the provided string or * array of strings. * Using `"startsWith"` will search for nodes with names starting with the provided string or array of * strings. * If no value is specified, the search mode will default to `"equals"`. * * * - **query.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): string[]; /** * Returns a list of IDs belonging to the ancestors of a particular node. * * * @returns A list of IDs belonging to the ancestors of `nodeRef`. */ getAncestors( /** * The node reference of the node whose ancestors will be returned. */ nodeRef: any ): string[]; /** * Returns a list of IDs belonging to the children of a particular node. * * * @returns A list of IDs belonging to the children of `nodeRef`. */ getChildren( /** * The node reference of the node whose children will be returned. If `nodeRef` is not passed to the `getChildren` * function, the IDs of the root nodes will be returned. */ nodeRef: any, /** * Indicates whether to return only the child nodes of a closed node or not. If `true`, then the * children of that closed node will be returned. If `false`, then the children of that closed node * will not be returned. */ stepIntoClosedNodes?: boolean ): string[]; /** * Gets the GraphicsCore object this Scene object belongs to. * * * @returns The GraphicsCore object this Scene object belongs to. */ getGraphicsCore(): sap.ui.vk.dvl.GraphicsCore; /** * Returns a list of hotspot node references. * * * @returns A list of hotspot node references. */ getHotspotNodeRefs(): any[]; /** * Returns a list of layer IDs. * * * @returns A list of layer IDs. */ getLayers(): string[]; /** * Get node content type * * @since 1.73.0 * * @returns Node content type */ getNodeContentType( /** * The node reference */ nodeRef: any ): sap.ui.vk.NodeContentType; /** * Gets the Scene object the node hierarchy belongs to. * * * @returns The Scene object the node hierarchy belongs to. */ getScene(): sap.ui.vk.Scene; /** * Gets the scene reference that this NodeHierarchy object wraps. * * * @returns The scene reference that this NodeHierarchy object wraps. */ getSceneRef(): any; /** * Deletes a node and destroys it. * * @since 1.48.0 * * @returns `this` to allow method chaining. */ removeNode( /** * The reference to a node or an array of nodes to destroy. */ nodeRef: any ): this; } /** * Provides a proxy object to the node in the node hierarchy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createNodeProxy sap.ui.vk.NodeHierarchy.createNodeProxy } * method. and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyNodeProxy sap.ui.vk.NodeHierarchy.destroyNodeProxy } * method. * * @since 1.32.0 * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.NodeProxy } * instead. */ class NodeProxy extends sap.ui.vk.NodeProxy { /** * Constructor for a new NodeProxy. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeProxy#constructor sap.ui.vk.NodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.dvl.NodeProxy 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.vk.NodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.NodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; } /** * Provides the interface for the 3D model. * * The objects of this class should not be created directly. They should be created via {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector}. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.Scene } * instead. */ class Scene extends sap.ui.vk.Scene { /** * Constructor for a new Scene. * * The objects of this class should not be created directly. They should be created via {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector}. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.Scene#constructor sap.ui.vk.Scene } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.dvl.Scene 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.vk.Scene.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.Scene. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets the default node hierarchy in the Scene object. * * * @returns The default node hierarchy in the Scene object. */ getDefaultNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the GraphicsCore object this Scene object belongs to. * * * @returns The GraphicsCore object this Scene object belongs to. */ getGraphicsCore(): sap.ui.vk.dvl.GraphicsCore; /** * Gets the unique ID of the Scene object. * * * @returns The unique ID of the Scene object. */ getId(): string; /** * Gets the DVL scene ID. * * * @returns The DVL scene ID. */ getSceneRef(): string; } /** * Provides a rendering canvas for the 3D elements of a loaded scene. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.Viewport } * instead. */ class Viewport extends sap.ui.vk.ViewportBase { /** * Constructor for a new Viewport. * * 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 Viewport control. */ mSettings?: sap.ui.vk.dvl.$ViewportSettings ); /** * Constructor for a new Viewport. * * 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 Viewport control. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Viewport control. */ mSettings?: sap.ui.vk.dvl.$ViewportSettings ); /** * Creates a new subclass of class sap.ui.vk.dvl.Viewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * This event will be fired when the frame rendering has finished. * * * @returns Reference to `this` in order to allow method chaining */ attachFrameRenderingFinished( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * This event will be fired when the frame rendering has finished. * * * @returns Reference to `this` in order to allow method chaining */ attachFrameRenderingFinished( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pan pan} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPan( /** * 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: Viewport$PanEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pan pan} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPan( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$PanEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * 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: Viewport$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:zoom zoom} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachZoom( /** * 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: Viewport$ZoomEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:zoom zoom} event of this `sap.ui.vk.dvl.Viewport`. * * 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.dvl.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachZoom( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$ZoomEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.dvl.Viewport` itself */ oListener?: object ): this; /** * Marks the start of the current gesture operation. * * * @returns this */ beginGesture( /** * The x-coordinate of the gesture. */ x: int, /** * The y-coordinate of the gesture. */ y: int ): sap.ui.vk.Viewport; /** * Detaches event handler `fnFunction` from the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.dvl.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFrameRenderingFinished( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:pan pan} event of this `sap.ui.vk.dvl.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPan( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$PanEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotate rotate} event of this `sap.ui.vk.dvl.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotate( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$RotateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:zoom zoom} event of this `sap.ui.vk.dvl.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachZoom( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$ZoomEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Marks the end of the current gesture operation. * * * @returns this */ endGesture(): sap.ui.vk.Viewport; /** * Fires event {@link #event:frameRenderingFinished frameRenderingFinished} 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 */ fireFrameRenderingFinished( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:pan pan} 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 */ firePan( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.dvl.Viewport$PanEventParameters ): this; /** * Fires event {@link #event:rotate rotate} 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 */ fireRotate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.dvl.Viewport$RotateEventParameters ): this; /** * Fires event {@link #event:zoom zoom} 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 */ fireZoom( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.dvl.Viewport$ZoomEventParameters ): this; /** * Gets current value of property {@link #getBackgroundColorBottomABGR backgroundColorBottomABGR}. * * Viewport background bottom color in the ABGR format * * Default value is `0xffffffff`. * * * @returns Value of property `backgroundColorBottomABGR` */ getBackgroundColorBottomABGR(): int; /** * Gets current value of property {@link #getBackgroundColorTopABGR backgroundColorTopABGR}. * * Viewport background top color in the ABGR format * * Default value is `0xff000000`. * * * @returns Value of property `backgroundColorTopABGR` */ getBackgroundColorTopABGR(): int; /** * Gets the {@link sap.ui.vk.dvl.GraphicsCore GraphicsCore} object the Viewport is attached to. * * @deprecated As of version 1.50.0. Create instance of {@link sap.ui.vk.ContentConnector} instead. * * @returns The {@link sap.ui.vk.dvl.GraphicsCore GraphicsCore} object the Viewport is attached to, or `null`. */ getGraphicsCore(): sap.ui.vk.dvl.GraphicsCore; /** * * @returns The ID of the node that is currently set as isolated. */ getIsolatedNode(): string; /** * Gets position and size of the viewport square. The information can be used for making calculations when * restoring Redlining elements. * * * @returns The information in this object: * - **left** - The x coordinate of the top-left corner of the square. * - **top** - The y coordinate of the top-left corner of the square. * - **sideLength** - The length of the square. */ getOutputSize(): object; /** * Retrieves information about the current camera view in the scene, and saves the information in a JSON-like * object. The information can then be used at a later time to restore the scene to the same camera view * using the {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} method. * * * * @returns JSON-like object which holds the current view information. See {@link sap.ui.vk.Viewport#setViewInfo setViewInfo}. * In addition to properties defined in {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} the output from * {@link sap.ui.vk.Viewport#getViewInfo getViewInfo} contains camera view and projection matrices * ```javascript * * { * ... * camera: { * ... * matrices: { * view: [number, ...], * projection: [number, ...], * } * ... * }, * ... * } * ``` */ getViewInfo( /** * Query object which indicates what information to be retrieved. */ query?: { /** * Indicator to retrieve camera information. */ camera?: | boolean | { /** * Indicator to retrieve camera view and projection matrices. */ matrices?: boolean; /** * Indicator to retrieve the transition camera properties instead of regular one's. */ useTransitionCamera?: boolean; }; /** * Indicator to retrieve animation information. */ animation?: boolean; /** * Indicator to retrieve visibility information. */ visibility?: | boolean | { /** * Indicator to retrieve the complete visibility definition or just the difference. */ mode?: /* was: sap.ui.vk.VisibilityMode */ any; }; } ): object; /** * Performs a `pan` gesture to pan across the Viewport. * * * @returns this */ pan( /** * The change in distance along the x-coordinate. */ dx: int, /** * The change in distance along the y-coordinate. */ dy: int ): sap.ui.vk.Viewport; /** * Queues a command for execution during the rendering cycle. All gesture operations should be called using * this method. * * * @returns this */ queueCommand( /** * The command to be executed. */ command: Function ): sap.ui.vk.Viewport; /** * Executes a rectangular selection. * * * @returns The array of node references that are selected. */ rectSelect( /** * The x-coordinate of starting vertex of selection rectangle. */ x1: int, /** * The y-coordinate of starting vertex of selection rectangle. */ y1: int, /** * The x-coordinate of ending vertex of selection rectangle. */ x2: int, /** * The y-coordinate of ending vertex of selection rectangle. */ y2: int ): any[]; /** * Rotates the content resource displayed on the Viewport. * * * @returns this */ rotate( /** * The change in x-coordinate used to define the desired rotation. */ dx: int, /** * The change in y-coordinate used to define the desired rotation. */ dy: int ): sap.ui.vk.Viewport; /** * Sets the background color for the bottom area of the Viewport. * * * @returns `this` to allow method chaining. */ setBackgroundColorBottomABGR( /** * Takes an integer value as parameter. For example: 0xffffffff as hexadecimal value (0x prefix, FF alpha, * FF blue, FF green, FF red) */ integerColor: int ): this; /** * Sets the background color for the top area of the Viewport. * * * @returns `this` to allow method chaining. */ setBackgroundColorTopABGR( /** * Takes an integer value as parameter. For example: 0xffffffff as hexadecimal value (0x prefix, FF alpha, * FF blue, FF green, FF red) */ integerColor: int ): this; /** * Attaches or detaches the Viewport to the {@link sap.ui.vk.dvl.GraphicsCore GraphicsCore} object. * * @deprecated As of version 1.50.0. Create instance of {@link sap.ui.vk.ContentConnector} instead. * * @returns `this` to allow method chaining. */ setGraphicsCore( /** * The {@link sap.ui.vk.dvl.GraphicsCore GraphicsCore} object or `null`. If the `graphicsCore` parameter * is not `null`, a rendering object corresponding to the Viewport is created. If the `graphicsCore` parameter * is `null`, the rendering object corresponding to the Viewport is destroyed. */ graphicsCore: sap.ui.vk.dvl.GraphicsCore ): this; /** * Attaches the scene to the Viewport for rendering. * * @deprecated As of version 1.50.0. Viewport now gets reference to the scene via {@link sap.ui.vk.ContentConnector}. * * @returns `this` to allow method chaining. */ setScene( /** * The scene to attach to the Viewport. */ scene: sap.ui.vk.Scene ): this; /** * Set selection rectangle for rendering */ setSelectionRect( /** * coordinates of selection rectangle */ rect: object ): void; /** * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining. */ setShouldRenderFrame(): this; /** * Sets the current scene to use the camera view information acquired from the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. * Internally, the `setViewInfo` method activates certain steps at certain animation times, and then changes * the camera position, rotation and field of view (FOV) / zoom factor. * * * @returns `this` to allow method chaining. */ setViewInfo( /** * A JSON-like object containing view information acquired using the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. */ viewInfo: { /** * A JSON-like object containing the camera information. */ camera?: { /** * Rotation defined in {@link https://en.wikipedia.org/wiki/Aircraft_principal_axes Aircraft principal axes}. */ rotation: { /** * Angle around the vertical axis in degrees. */ yaw: float; /** * Angle around the lateral axis in degrees. */ pitch: float; /** * Angle around the longitudinal axis in degrees. */ roll: float; }; /** * Position defined in 3-dimensional space. */ position: { /** * X coordinate. */ x: float; /** * Y coordinate. */ y: float; /** * Z coordinate. */ z: float; }; /** * Camera field of view binding type. */ bindingType: sap.ui.vk.CameraFOVBindingType; /** * Camera projection type. */ projectionType: sap.ui.vk.CameraProjectionType; /** * Camera field of view in degrees. Applicable only to perspective cameras. */ fieldOfView: float; /** * Camera zoom factor. Applicable only to orthographic cameras. */ zoomFactor: float; }; /** * A JSON-like object containing the animation information. */ animation?: { /** * Step VE ID. If it is omitted then procedure and step indices are used. */ stepVeId?: string; /** * Procedure index in the list of procedures. */ procedureIndex?: int; /** * Step index in the list of steps in the procedure. */ stepIndex?: int; /** * Time at which to activate the step. */ animationTime?: float; }; /** * A JSON-like object containing the visibility information. */ visibility?: { /** * If the mode equals to {@link sap.ui.vk.VisibilityMode.Complete complete} then the visible and hidden * fields are defined. If the mode equals {@link sap.ui.vk.VisibilityMode.Differences differences} then * the changes field is defined. */ mode: /* was: sap.ui.vk.VisibilityMode */ any; /** * List of Ids of visible nodes. */ visible: string[]; /** * List of Ids of hidden nodes. */ hidden: string[]; /** * List of Ids of nodes with inverted visibility. */ changes: string[]; }; }, /** * Fly-to animation duration in seconds. */ flyToDuration?: float ): this; /** * * @returns `this` to allow method chaining. */ showHotspots( /** * The node reference or the array of node references that we want to tint. */ nodeRefs: any | any[], /** * Whether to highlight the nodes or remove the highlight. */ show: boolean, /** * The color to use for highlighting the nodes passed as argument. */ color: int | sap.ui.core.CSSColor ): this; /** * Executes a click or tap gesture. * * * @returns this */ tap( /** * The tap gesture's x-coordinate. */ x: int, /** * The tap gesture's y-coordinate. */ y: int, /** * Indicates whether the tap gesture should be interpreted as a double-click. A value of `true` indicates * a double-click gesture, and `false` indicates a single click gesture. */ isDoubleClick: boolean ): sap.ui.vk.dvl.Viewport; /** * Performs a `zoom` gesture to zoom in or out on the beginGesture coordinate. * * * @returns this */ zoom( /** * Zoom factor. A scale factor that specifies how much to zoom in or out by. */ dy: float ): sap.ui.vk.Viewport; /** * Zooms the scene to a bounding box created from a particular set of nodes. * * * @returns this */ zoomTo( /** * What set of nodes to zoom to. */ what: sap.ui.vk.ZoomTo | sap.ui.vk.ZoomTo[], /** * Is only used if what == sap.ui.vk.ZoomTo.Node. */ nodeRef: any, /** * Time to perform the "fly to" animation. Set to 0 to do this immediately. */ crossFadeSeconds: float, /** * Margin. Set to 0 to zoom to the entire screen. */ margin: float ): sap.ui.vk.Viewport; } /** * Manages the visibility and selection states of nodes in the scene. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. Use {@link sap.ui.vk.ViewStateManager } * instead. */ class ViewStateManager extends sap.ui.vk.ViewStateManagerBase { /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.dvl.$ViewStateManagerSettings ); /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * ID for the new ViewStateManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.dvl.$ViewStateManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.dvl.ViewStateManager 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.vk.ViewStateManagerBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.dvl.ViewStateManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Enumerates IDs of the selected nodes. * * * @returns `this` to allow method chaining. */ enumerateSelection( /** * A function to call when the selected nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Gets the NodeHierarchy object associated with this ViewStateManager object. * * * @returns The node hierarchy associated with this ViewStateManager object. */ getNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the opacity of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own opacity should * be used. */ getOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): float | float[]; /** * Gets the selection state of the node. * * If a single node reference is passed to the method then a single selection state is returned. * If an array of node references is passed to the method then an array of selection states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets the tint color of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * This flag indicates to return the tint color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[] | int | int[]; /** * Gets the visibility changes in the current ViewStateManager object. * * * @returns The visibility changes are in the form of an array. The array is a list of node VE ids which * suffered a visibility changed relative to the default state. */ getVisibilityChanges(): string[]; /** * Gets the visibility state of nodes. * * If a single node reference is passed to the method then a single visibility state is returned. * If an array of node references is passed to the method then an array of visibility states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is visible, `false` * otherwise. */ getVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Sets the opacity of the nodes. * * * @returns `this` to allow method chaining. */ setOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new opacity of the nodes. If `null` is passed then the opacity is reset and the node's own opacity * should be used. */ opacity: float | null, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the selection state of the nodes. * * @deprecated As of version 1.56.3. Use {@link sap.ui.vk.dvl.ViewStateManager#setSelectionStates} instead. * * @returns `this` to allow method chaining. */ setSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets or resets the selection state of the nodes. * * * @returns `this` to allow method chaining. */ setSelectionStates( /** * The node reference or the array of node references of selected nodes. */ selectedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unselectedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets the tint color of the nodes. * * * @returns `this` to allow method chaining. */ setTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an * integer in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint * color should be used. */ tintColor: sap.ui.core.CSSColor | int | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the visibility state of the nodes. * * * @returns `this` to allow method chaining. */ setVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new visibility state of the nodes. */ visible: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag * will force node to be visible regardless of parent's state. */ force: boolean ): this; } /** * The types of APIs supported by the {@link sap.ui.vk.dvl.GraphicsCore} class. * * @deprecated As of version 1.72.0. DVL namespace will be removed in future. This object does not have * replacement. */ enum GraphicsCoreApi { /** * The legacy DVL API implemented in the com.sap.ve.dvl library (dvl.js). */ LegacyDvl = "LegacyDvl", } /** * Event object of the Viewport#frameRenderingFinished event. */ type Viewport$FrameRenderingFinishedEvent = sap.ui.base.Event< Viewport$FrameRenderingFinishedEventParameters, Viewport >; /** * Event object of the Viewport#pan event. */ type Viewport$PanEvent = sap.ui.base.Event< Viewport$PanEventParameters, Viewport >; /** * Event object of the Viewport#rotate event. */ type Viewport$RotateEvent = sap.ui.base.Event< Viewport$RotateEventParameters, Viewport >; /** * Event object of the Viewport#zoom event. */ type Viewport$ZoomEvent = sap.ui.base.Event< Viewport$ZoomEventParameters, Viewport >; } namespace ecad { /** * Describes the settings that can be provided to the ElementsPanel constructor. */ interface $ElementsPanelSettings extends sap.ui.core.$ControlSettings { width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * An association to the `ContentConnector` instance that manages content resources. */ contentConnector?: sap.ui.vk.ContentConnector | string; /** * An association to the `ViewStateManager` instance. */ viewStateManager?: sap.ui.vk.ViewStateManagerBase | string; /** * This event will be fired when content is replaced. */ contentChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the LayersPanel constructor. */ interface $LayersPanelSettings extends sap.ui.core.$ControlSettings { width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; content?: sap.ui.core.Control; /** * An association to the `ContentConnector` instance that manages content resources. */ contentConnector?: sap.ui.vk.ContentConnector | string; /** * An association to the `ViewStateManager` instance. */ viewStateManager?: sap.ui.vk.ViewStateManagerBase | string; /** * This event will be fired when content is replaced. */ contentChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the ElementsPanel#contentChanged event. */ interface ElementsPanel$ContentChangedEventParameters {} /** * Parameters of the LayersPanel#contentChanged event. */ interface LayersPanel$ContentChangedEventParameters {} /** * 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 */ class ElementsPanel extends sap.ui.core.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?: sap.ui.vk.ecad.$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?: sap.ui.vk.ecad.$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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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(): sap.ui.core.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: sap.ui.base.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: sap.ui.base.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: sap.ui.base.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(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getHeight height}. * * Default value is `"100%"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager}, * or `null`. */ getViewStateManager(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * Default value is `"auto"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.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: sap.ui.core.ID | sap.ui.vk.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?: sap.ui.core.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: sap.ui.core.ID | sap.ui.vk.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?: sap.ui.core.CSSSize ): this; } /** * Provides a flat list view of all the ECAD layers in a given scene in table format. * * @since 1.136.0 */ class LayersPanel extends sap.ui.core.Control { /** * Constructor for a new LayersPanel. * * 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?: sap.ui.vk.ecad.$LayersPanelSettings ); /** * Constructor for a new LayersPanel. * * 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?: sap.ui.vk.ecad.$LayersPanelSettings ); /** * Creates a new subclass of class sap.ui.vk.ecad.LayersPanel 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.LayersPanel. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.ecad.LayersPanel`. * * 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.LayersPanel` 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.LayersPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.ecad.LayersPanel`. * * 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.LayersPanel` 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ecad.LayersPanel` itself */ oListener?: object ): this; /** * Destroys the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.ecad.LayersPanel`. * * 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: sap.ui.base.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; /** * Gets content of aggregation {@link #getContent content}. */ getContent(): sap.ui.core.Control; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getHeight height}. * * Default value is `"100%"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager}, * or `null`. */ getViewStateManager(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * Default value is `"auto"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Sets the aggregated {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ setContent( /** * The content to set */ oContent: sap.ui.core.Control ): this; /** * 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: sap.ui.core.ID | sap.ui.vk.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?: sap.ui.core.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: sap.ui.core.ID | sap.ui.vk.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?: sap.ui.core.CSSSize ): this; } /** * Event object of the ElementsPanel#contentChanged event. */ type ElementsPanel$ContentChangedEvent = sap.ui.base.Event< ElementsPanel$ContentChangedEventParameters, ElementsPanel >; /** * Event object of the LayersPanel#contentChanged event. */ type LayersPanel$ContentChangedEvent = sap.ui.base.Event< LayersPanel$ContentChangedEventParameters, LayersPanel >; } namespace pdf { /** * Describes the settings that can be provided to the Viewport constructor. */ interface $ViewportSettings extends sap.ui.vk.$ViewportBaseSettings { currentPageIndex?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; pageChanged?: (oEvent: Viewport$PageChangedEvent) => void; documentReplaced?: (oEvent: Viewport$DocumentReplacedEvent) => void; } /** * Parameters of the Viewport#documentReplaced event. */ interface Viewport$DocumentReplacedEventParameters { oldDocument?: /* was: sap.ui.vk.pdf.Document */ any; newDocument?: /* was: sap.ui.vk.pdf.Document */ any; } /** * Parameters of the Viewport#pageChanged event. */ interface Viewport$PageChangedEventParameters { newPageIndex?: int; oldPageIndex?: int; } /** * Enables displaying PDF content.. * * @since 1.123.0 */ class Viewport extends sap.ui.vk.ViewportBase { /** * Constructor for a new Viewport. * * 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 Native Viewport control. */ mSettings?: sap.ui.vk.pdf.$ViewportSettings ); /** * Constructor for a new Viewport. * * 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 Native Viewport control, generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Native Viewport control. */ mSettings?: sap.ui.vk.pdf.$ViewportSettings ); /** * Creates a new subclass of class sap.ui.vk.pdf.Viewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.pdf.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:documentReplaced documentReplaced} event of * this `sap.ui.vk.pdf.Viewport`. * * 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.pdf.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachDocumentReplaced( /** * 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: Viewport$DocumentReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.pdf.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:documentReplaced documentReplaced} event of * this `sap.ui.vk.pdf.Viewport`. * * 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.pdf.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachDocumentReplaced( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$DocumentReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.pdf.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pageChanged pageChanged} event of this `sap.ui.vk.pdf.Viewport`. * * 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.pdf.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPageChanged( /** * 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: Viewport$PageChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.pdf.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pageChanged pageChanged} event of this `sap.ui.vk.pdf.Viewport`. * * 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.pdf.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPageChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$PageChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.pdf.Viewport` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:documentReplaced documentReplaced} event of * this `sap.ui.vk.pdf.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachDocumentReplaced( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$DocumentReplacedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:pageChanged pageChanged} event of this `sap.ui.vk.pdf.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPageChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$PageChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:documentReplaced documentReplaced} 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 */ fireDocumentReplaced( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.pdf.Viewport$DocumentReplacedEventParameters ): this; /** * Fires event {@link #event:pageChanged pageChanged} 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 */ firePageChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.pdf.Viewport$PageChangedEventParameters ): this; /** * Gets current value of property {@link #getCurrentPageIndex currentPageIndex}. * * Default value is `0`. * * * @returns Value of property `currentPageIndex` */ getCurrentPageIndex(): int; /** * Sets a new value for property {@link #getCurrentPageIndex currentPageIndex}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setCurrentPageIndex( /** * New value for property `currentPageIndex` */ iCurrentPageIndex?: int ): this; } /** * Event object of the Viewport#documentReplaced event. */ type Viewport$DocumentReplacedEvent = sap.ui.base.Event< Viewport$DocumentReplacedEventParameters, Viewport >; /** * Event object of the Viewport#pageChanged event. */ type Viewport$PageChangedEvent = sap.ui.base.Event< Viewport$PageChangedEventParameters, Viewport >; } namespace svg { /** * Describes the settings that can be provided to the ContentManager constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $ContentManagerSettings extends sap.ui.vk.$ContentManagerSettings { errorReported?: (oEvent: ContentManager$ErrorReportedEvent) => void; } /** * Describes the settings that can be provided to the NodeHierarchy constructor. */ interface $NodeHierarchySettings extends sap.ui.vk.$NodeHierarchySettings {} /** * Describes the settings that can be provided to the NodeProxy constructor. */ interface $NodeProxySettings extends sap.ui.vk.$NodeProxySettings {} /** * Describes the settings that can be provided to the OrthographicCamera constructor. */ interface $OrthographicCameraSettings extends sap.ui.vk.$OrthographicCameraSettings {} /** * Describes the settings that can be provided to the Scene constructor. */ interface $SceneSettings extends sap.ui.vk.$SceneSettings {} /** * Describes the settings that can be provided to the Viewport constructor. */ interface $ViewportSettings extends sap.ui.vk.$ViewportBaseSettings { miniMap?: sap.m.Dialog; cameraChanged?: (oEvent: Viewport$CameraChangedEvent) => void; hotspotEnter?: (oEvent: Viewport$HotspotEnterEvent) => void; hotspotLeave?: (oEvent: Viewport$HotspotLeaveEvent) => void; } /** * Describes the settings that can be provided to the ViewStateManager constructor. */ interface $ViewStateManagerSettings extends sap.ui.vk.$ViewStateManagerBaseSettings {} /** * Parameters of the ContentManager#errorReported event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ContentManager$ErrorReportedEventParameters { error?: any; } /** * Parameters of the Viewport#cameraChanged event. */ interface Viewport$CameraChangedEventParameters { /** * Returns a new camera offset. */ offset?: float[]; /** * Returns a new camera zoom factor. */ zoom?: float; } /** * Parameters of the Viewport#hotspotEnter event. */ interface Viewport$HotspotEnterEventParameters { nodeRef?: any; } /** * Parameters of the Viewport#hotspotLeave event. */ interface Viewport$HotspotLeaveEventParameters { nodeRef?: any; } /** * Provides a simple, lightweight proxy object to a node in a node hierarchy. * * The objects of this class should not be created directly, and should only be created through the use * of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } */ class BaseNodeProxy extends sap.ui.vk.BaseNodeProxy implements sap.ui.base.Poolable { __implements__sap_ui_base_Poolable: boolean; /** * Constructor for a new BaseNodeProxy. The objects of this class should not be created directly, and should * only be created through the use of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } * * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.BaseNodeProxy#constructor sap.ui.vk.BaseNodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.svg.BaseNodeProxy 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.vk.BaseNodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.BaseNodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Gets the name of the node. * * * @returns The node's name. */ getName(): string; /** * Gets the node reference. * * * @returns The node reference. */ getNodeId(): any; /** * Gets the metadata of the node. * * * @returns A JSON object containing the node's metadata. */ getNodeMetadata(): object; /** * Gets the reference object of the node. * * * @returns The node's reference object. */ getNodeRef(): object; /** * Gets the scene reference that this BaseNodeProxy object wraps. * * * @returns A scene reference that this BaseNodeProxy object wraps. */ getSceneRef(): any; /** * Initialize this BaseNodeProxy with its data. * * The `init` method is called by an object pool when the object is (re-)activated for a new caller. * See: * sap.ui.base.Poolable.prototype#init * * @ui5-protected Do not call from applications (only from related classes in the framework) */ init( /** * The NodeHierarchy object this BaseNodeProxy object belongs to. */ nodeHierarchy: sap.ui.vk.svg.NodeHierarchy, /** * The reference object of the node for which to get BaseNodeProxy. */ nodeRef: any ): void; /** * Reset BaseNodeProxy data, needed for pooling. * See: * sap.ui.base.Poolable.prototype#reset * * @ui5-protected Do not call from applications (only from related classes in the framework) */ reset(): void; } /** * Provides a content manager object that uses to load 2D content. * * When registering a content manager resolver with {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * you can pass a function that will load a model and merge it into the three.js scene. * * @since 1.80.0 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ class ContentManager extends sap.ui.vk.ContentManager { /** * Constructor for a new ContentManager. * * 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. * See: * {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * for an example. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.svg.$ContentManagerSettings ); /** * Constructor for a new ContentManager. * * 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. * See: * {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * for an example. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * ID for the new ContentManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.svg.$ContentManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.svg.ContentManager 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.vk.ContentManager.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.ContentManager. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:errorReported errorReported} event of this `sap.ui.vk.svg.ContentManager`. * * 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.svg.ContentManager` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachErrorReported( /** * 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: ContentManager$ErrorReportedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:errorReported errorReported} event of this `sap.ui.vk.svg.ContentManager`. * * 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.svg.ContentManager` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachErrorReported( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentManager$ErrorReportedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.ContentManager` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:errorReported errorReported} event of this * `sap.ui.vk.svg.ContentManager`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachErrorReported( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentManager$ErrorReportedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:errorReported errorReported} 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 */ fireErrorReported( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.svg.ContentManager$ErrorReportedEventParameters ): this; /** * Starts downloading and building or updating the content from the content resources. * * This method is asynchronous. * * @since 1.80.0 * * @returns `this` to allow method chaining. */ loadContent( /** * The current content to update. It can be `null` if this is an initial loading call. */ content: any, /** * The content resources to load or update. */ contentResources: sap.ui.vk.ContentResource[] ): this; } /** * Provides the ability to explore a Scene object's node structure. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene#getDefaultNodeHierarchy}. */ class NodeHierarchy extends sap.ui.vk.NodeHierarchy { /** * Constructor for a new NodeHierarchy. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeHierarchy#constructor sap.ui.vk.NodeHierarchy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.svg.NodeHierarchy 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.vk.NodeHierarchy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.NodeHierarchy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Creates a layer proxy object. * * The layer proxy object must be destroyed with the {@link #destroyLayerProxy destroyLayerProxy} method. * * * @returns The proxy object. */ createLayerProxy( /** * The layer ID for which to create a proxy object. */ layerId: string ): sap.ui.vk.LayerProxy; /** * Creates a new node. * * @since 1.80.0 * * @returns The reference object of the newly created node. */ createNode( /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: /* was: sap.ui.vk.svg.Element */ any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: /* was: sap.ui.vk.svg.Element */ any, /** * The created node content type. */ nodeContentType?: sap.ui.vk.NodeContentType, /** * Optional Json structure used to define node properties. */ content?: object ): /* was: sap.ui.vk.svg.Element */ any; /** * Creates a copy of an existing node. * * @since 1.80.0 * * @returns The reference object of the newly created node. */ createNodeCopy( /** * The reference object of the node to copy. */ nodeToCopy: any, /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any ): any; /** * Creates a node proxy object. * * The node proxy object must be destroyed with the {@link #destroyNodeProxy destroyNodeProxy} method. * * * @returns The proxy object. */ createNodeProxy( /** * The reference object for which to create a proxy object. */ nodeRef: any ): sap.ui.vk.NodeProxy; /** * Destroys the layer proxy object. * * * @returns `this` to allow method chaining. */ destroyLayerProxy( /** * The layer proxy object. */ layerProxy: sap.ui.vk.LayerProxy ): this; /** * Destroys the node proxy object. * * * @returns `this` to allow method chaining. */ destroyNodeProxy( /** * The node proxy object. */ nodeProxy: sap.ui.vk.NodeProxy ): this; /** * Enumerates the ancestor nodes of a particular node in the Scene object. * * This method enumerates the ancestor nodes of a particular node, and then calls the `callback` function, * to which it passes the ancestor nodes to one by one. * The BaseNodeProxy objects passed to `callback` are temporary objects, they are reset after each call * to the `callback` function. * The ancestor nodes are enumerated starting from the top level node, and progresses down the node hierarchy. * * * @returns `this` to allow method chaining. */ enumerateAncestors( /** * The reference object of a node whose ancestor nodes we want enumerated. */ nodeRef: any, /** * A function to call when the ancestor nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to pass the node references of the ancestor nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the ancestor nodes are passed to the `callback` function. * * If `false`, then the node proxies of the ancestor nodes are passed to the `callback` function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * The reference object of a node whose child nodes we want enumerated. * When `nodeRef` is specified, the child nodes of this node are enumerated. * When no `nodeRef` is specified, only the top level nodes are enumerated. */ nodeRef: any, /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Finds nodes in a scene via node name. * * * @returns A list of reference objects belonging to nodes that matched the search criteria. */ findNodesByName( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * value: string | string[], * predicate: "equals" | "contains" | "startsWith", * caseSensitive: true | false * }``` * * * - **query.value** * A string or an array of strings containing the name of a node or names of nodes. If no value is specified, * then all nodes in the scene will be returned. * The following example shows a single string being passed in: * ```javascript * value: "Box #14"``` * The following example shows an array of strings being passed in: * ```javascript * value: ["Box #3", "box #4", "BOX #5"]``` * * - **query.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for nodes with names that exactly match the provided string or array of * strings. * Using `"contains"` will search for nodes with names containing all or part of the provided string or * array of strings. * Using `"startsWith"` will search for nodes with names starting with the provided string or array of * strings. * If no value is specified, the search mode will default to `"equals"`. * * * - **query.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): /* was: sap.ui.vk.svg.Element */ any[]; /** * Returns a list of reference objects belonging to the ancestors of a particular node. * * * @returns A list of reference objects belonging to the ancestors of `nodeRef`. */ getAncestors( /** * The reference object of the node whose ancestors will be returned. */ nodeRef: any ): any[]; /** * Returns a list of reference objects belonging to the children of a particular node. * * * @returns A list of reference objects belonging to the children of `nodeRef`. */ getChildren( /** * The reference object of the node whose children will be returned. If `nodeRef` is not passed to the `getChildren` * function, the reference objects of the root nodes will be returned. */ nodeRef: any, /** * Indicates whether to return only the child nodes of a closed node or not. If `true`, then the * children of that closed node will be returned. If `false`, then the children of that closed node * will not be returned. */ stepIntoClosedNodes?: boolean ): any[]; /** * Returns a list of dynamic content node references. * * * @returns A list of dynamic content node references. */ getDynamicContentNodeRefs(): any[]; /** * Returns a list of hotspot node references. * * * @returns A list of hotspot node references. */ getHotspotNodeRefs(): any[]; /** * Returns a list of layer IDs. * * * @returns A list of layer IDs. */ getLayers(): string[]; /** * Get node content type * * @since 1.80.0 * * @returns Node content type */ getNodeContentType( /** * The node reference */ nodeRef: any ): sap.ui.vk.NodeContentType; /** * Gets the Scene object the node hierarchy belongs to. * * * @returns The Scene object the node hierarchy belongs to. */ getScene(): sap.ui.vk.Scene; /** * Gets the scene reference that this NodeHierarchy object wraps. * * * @returns The scene reference that this NodeHierarchy object wraps. */ getSceneRef(): any; /** * Deletes a node and destroys it. * * @since 1.80.0 * * @returns `this` to allow method chaining. */ removeNode( /** * The reference object of a node or an array of nodes to destroy. */ nodeRef: any ): this; /** * Attaches a custom text to this elements. * * @since 1.144.0 * * @returns `this` to allow method chaining. */ setCustomText( /** * The node or array of nodes to set the custom text to. */ nodeRefs: /* was: sap.ui.vk.svg.Element */ | any | /* was: sap.ui.vk.svg.Element */ any[], /** * The custom text options. If not specified, the existing custom text will be removed. */ options?: { /** * The text to display, it's mutually exclusive with `htmlText` option. Line breaks are not supported, use * `htmlText` option for multi-line text. */ text?: string; /** * The HTML text to display, it's mutually exclusive with `text` option. Line breaks are supported using * paragraphs: `"

Line 1

Line 2

"`. */ htmlText?: string; /** * The font size of the text in scene coordinate units. If not specified then the size will be automatically * determined based on the median text size in the scene or computed from the bounding box of the scene, * but better to specify it explicitly to avoid unexpected results. */ size?: number; /** * The font family of the text. Default is `"Arial"`. */ fontFamily?: string; /** * The font style of the text (normal | italic | oblique). Default is undefined ("normal"). */ fontStyle?: string; /** * The font weight of the text (normal | bold | bolder | lighter | ). Default is undefined ("normal"). */ fontWeight?: string; /** * The text decoration of the text (none | underline | line-through, etc). Default is undefined ("none"). */ textDecoration?: string; /** * The fill color of the text in CSS format. Default is "black". */ fill?: string; /** * The pivot point of the custom text, relative to the text bounding box. The pivot point is used together * with the anchor point to position the text. Default is `[0.5, 0.5]` (middle of the custom text). `[0, * 0]` is top-left, `[1, 1]` is bottom-right. */ pivot?: number[]; /** * The anchor point of the text, relative to the bounding box of the node to which the custom text is attached. * Default is `[0.5, 0.5]` (center of node). `[0, 0]` is top-left, `[1, 1]` is bottom-right. */ anchor?: number[]; } ): this; } /** * Provides a proxy object to the node in the node hierarchy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createNodeProxy sap.ui.vk.NodeHierarchy.createNodeProxy } * method. and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyNodeProxy sap.ui.vk.NodeHierarchy.destroyNodeProxy } * method. */ class NodeProxy extends sap.ui.vk.NodeProxy { /** * Constructor for a new NodeProxy. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeProxy#constructor sap.ui.vk.NodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.svg.NodeProxy 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.vk.NodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.NodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; } /** * Provides the interface for the camera. * * @since 1.80.0 */ class OrthographicCamera extends sap.ui.vk.OrthographicCamera { /** * Constructor for a new OrthographicCamera. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.OrthographicCamera#constructor sap.ui.vk.OrthographicCamera } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.svg.OrthographicCamera 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.vk.OrthographicCamera.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.OrthographicCamera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; } /** * Provides the interface for the 2D model. * * The objects of this class should not be created directly. */ class Scene extends sap.ui.vk.Scene { /** * Constructor for a new Scene. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.Scene#constructor sap.ui.vk.Scene } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.svg.Scene 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.vk.Scene.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.Scene. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets the default node hierarchy in the Scene object. * * * @returns The default node hierarchy in the Scene object. */ getDefaultNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the unique ID of the Scene object. * * * @returns The unique ID of the Scene object. */ getId(): string; /** * Get initial view * * * @returns initial view */ getInitialView(): sap.ui.vk.View; /** * Gets the root element reference for the Scene object. * * * @returns The root element. */ getRootElement(): /* was: sap.ui.vk.svg.Element */ any; /** * Gets the persistent ID from node reference. * * * @returns The persistent ID or the array of the persistent IDs. */ nodeRefToPersistentId( /** * The reference to the node or the array of references to the nodes. */ nodeRefs: /* was: sap.ui.vk.svg.Element */ | any | /* was: sap.ui.vk.svg.Element */ any[] ): string | string[]; /** * Gets the node reference from persistent ID. * * * @returns The reference to the node or the array of references to the nodes. */ persistentIdToNodeRef( /** * The persistent ID or the array of the persistent IDs. */ pIDs: string | string[] ): /* was: sap.ui.vk.svg.Element */ | any | /* was: sap.ui.vk.svg.Element */ any[]; /** * Set initial view */ setInitialView( /** * Initial view */ view: sap.ui.vk.View ): void; } /** * Provides a control for SVG representation of 2D drawing data. */ class Viewport extends sap.ui.vk.ViewportBase { /** * Constructor for a SVG viewport. * * 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(); /** * Creates a new subclass of class sap.ui.vk.svg.Viewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Activates the view based on view object passed * * * @returns returns this */ activateView( /** * View object definition */ view: sap.ui.vk.View ): sap.ui.vk.svg.Viewport; /** * Attaches event handler `fnFunction` to the {@link #event:cameraChanged cameraChanged} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCameraChanged( /** * 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: Viewport$CameraChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cameraChanged cameraChanged} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCameraChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$CameraChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hotspotEnter hotspotEnter} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachHotspotEnter( /** * 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: Viewport$HotspotEnterEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hotspotEnter hotspotEnter} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachHotspotEnter( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$HotspotEnterEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hotspotLeave hotspotLeave} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachHotspotLeave( /** * 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: Viewport$HotspotLeaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hotspotLeave hotspotLeave} event of this `sap.ui.vk.svg.Viewport`. * * 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.svg.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachHotspotLeave( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$HotspotLeaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.svg.Viewport` itself */ oListener?: object ): this; /** * Destroys the miniMap in the aggregation {@link #getMiniMap miniMap}. * * * @returns Reference to `this` in order to allow method chaining */ destroyMiniMap(): this; /** * Detaches event handler `fnFunction` from the {@link #event:cameraChanged cameraChanged} event of this * `sap.ui.vk.svg.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCameraChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$CameraChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:hotspotEnter hotspotEnter} event of this `sap.ui.vk.svg.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHotspotEnter( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$HotspotEnterEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:hotspotLeave hotspotLeave} event of this `sap.ui.vk.svg.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHotspotLeave( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$HotspotLeaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:cameraChanged cameraChanged} 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 */ fireCameraChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.svg.Viewport$CameraChangedEventParameters ): this; /** * Fires event {@link #event:hotspotEnter hotspotEnter} 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 */ fireHotspotEnter( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.svg.Viewport$HotspotEnterEventParameters ): this; /** * Fires event {@link #event:hotspotLeave hotspotLeave} 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 */ fireHotspotLeave( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.svg.Viewport$HotspotLeaveEventParameters ): this; /** * Get current view - remembered when activateView function is called * * * @returns Current view */ getCurrentView(): sap.ui.vk.View; /** * Returns viewport content as an image of desired size. * * * @returns Base64 encoded PNG image */ getImage( /** * Requested image width in pixels. Allowed values are 8 to 2048, default is 16 */ width: int, /** * Requested image height in pixels. Allowed values are 8 to 2048, default is 16 */ height: int, /** * The sap.ui.core.CSSColor to be used for top background color */ topColor: string, /** * The sap.ui.core.CSSColor to be used for bottom background color */ bottomColor: string, /** * Include selected nodes */ includeSelection: boolean ): Promise; /** * Gets content of aggregation {@link #getMiniMap miniMap}. */ getMiniMap(): sap.m.Dialog; /** * Gets position and size of the viewport square. The information can be used for making calculations when * restoring Redlining elements. * * * @returns The information in this object: * - **left** - The x coordinate of the top-left corner of the square. * - **top** - The y coordinate of the top-left corner of the square. * - **sideLength** - The length of the square. */ getOutputSize(): object; /** * Gets the Viewport Scene * * * @returns returns Scene */ getScene(): sap.ui.vk.svg.Scene; /** * Retrieves information about the current camera view in the scene, and saves the information in a JSON-like * object. The information can then be used at a later time to restore the scene to the same camera view * using the {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} method. * * * * @returns JSON-like object which holds the current view information. See {@link sap.ui.vk.Viewport#setViewInfo setViewInfo}. * In addition to properties defined in {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} the output from * {@link sap.ui.vk.Viewport#getViewInfo getViewInfo} contains camera view and projection matrices * ```javascript * * { * ... * } * ``` */ getViewInfo( /** * Query object which indicates what information to be retrieved. */ query?: { /** * Indicator to retrieve visibility information. */ visibility?: | boolean | { /** * Indicator to retrieve the complete visibility definition or just the difference. */ mode?: /* was: sap.ui.vk.VisibilityMode */ any; }; /** * Indicator to retrieve selection information. */ selection?: boolean | object; } ): object; /** * Queues a command for execution during the rendering cycle. All gesture operations should be called using * this method. * * * @returns returns this */ queueCommand( /** * The command to be executed. */ command: Function ): sap.ui.vk.svg.Viewport; /** * Sets the aggregated {@link #getMiniMap miniMap}. * * * @returns Reference to `this` in order to allow method chaining */ setMiniMap( /** * The miniMap to set */ oMiniMap: sap.m.Dialog ): this; /** * Attaches the scene to the Viewport for rendering. * * @deprecated As of version 1.80.0. Viewport now gets reference to the scene via {@link sap.ui.vk.ContentConnector}. * * @returns `this` to allow method chaining. */ setScene( /** * The scene to attach to the Viewport. */ scene: sap.ui.vk.svg.Scene ): this; /** * Sets the current scene to use the camera view information acquired from the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. * Internally, the `setViewInfo` method activates certain steps at certain animation times, and then changes * the camera position, rotation and field of view (FOV) / zoom factor. * * * @returns `this` to allow method chaining. */ setViewInfo( /** * A JSON-like object containing view information acquired using the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. */ viewInfo: { /** * A JSON-like object containing the camera information. */ camera?: object; /** * A JSON-like object containing the visibility information. */ visibility?: { /** * If the mode equals to {@link sap.ui.vk.VisibilityMode.Complete complete} then the visible and hidden * fields are defined. If the mode equals {@link sap.ui.vk.VisibilityMode.Differences differences} then * the changes field is defined. */ mode: /* was: sap.ui.vk.VisibilityMode */ any; /** * List of Ids of visible nodes. */ visible: string[]; /** * List of Ids of hidden nodes. */ hidden: string[]; /** * List of Ids of nodes with inverted visibility. */ changes: string[]; }; /** * A JSON-like object containing the selection information. */ selection?: { /** * List of Ids of selected nodes. */ selected: string[]; /** * List of Ids of outlined nodes. */ outlined: string[]; }; }, /** * Fly-to animation duration in seconds. */ flyToDuration?: float ): this; /** * * @returns `this` to allow method chaining. */ showHotspots( /** * The node reference or the array of node references that we want to tint. */ nodeRefs: any | any[], /** * Whether to highlight the nodes or remove the highlight. */ show: boolean, /** * The color to use for highlighting the nodes passed as argument. */ color: int | sap.ui.core.CSSColor ): this; /** * Zooms the scene to a bounding box created from a particular set of nodes. * * * @returns this */ zoomTo( /** * What set of nodes to zoom to. */ what: sap.ui.vk.ZoomTo | sap.ui.vk.ZoomTo[], /** * Is used if what == (sap.ui.vk.ZoomTo.Node || ZoomTo.NodeSetIsolation) */ nodeRef: any, /** * Time to perform the "fly to" animation. Set to 0 to do this immediately. */ crossFadeSeconds: float, /** * Margin. Set to 0 to zoom to the entire screen. */ margin: float ): sap.ui.vk.Viewport; } /** * Manages the visibility and selection states of nodes in the scene. * * @since 1.80.0 */ class ViewStateManager extends sap.ui.vk.ViewStateManagerBase { /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.svg.$ViewStateManagerSettings ); /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * ID for the new ViewStateManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.svg.$ViewStateManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.svg.ViewStateManager 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.vk.ViewStateManagerBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.svg.ViewStateManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Enumerates IDs of the selected nodes. * * * @returns `this` to allow method chaining. */ enumerateSelection( /** * A function to call when the selected nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Gets the default highlighting color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getHighlightColor( /** * This flag indicates to return the highlighting color in the ABGR format, if it equals `false` then the * color is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the NodeHierarchy object associated with this ViewStateManager object. * * * @returns The node hierarchy associated with this ViewStateManager object. */ getNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the opacity of the node. * * If a single node is passed to the method then a single value is returned. * If an array of nodes is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own opacity should * be used. */ getOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): float | float[]; /** * Gets the selection state of the node. * * If a single node reference is passed to the method then a single selection state is returned. * If an array of node references is passed to the method then an array of selection states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets the tint color of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * This flag indicates to return the tint color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[] | int | int[]; /** * Gets the visibility changes in the current ViewStateManager object. * * * @returns The visibility changes are in the form of an array. The array is a list of node VE ids which * suffered a visibility changed relative to the default state. */ getVisibilityChanges(): string[]; /** * Gets the visibility state of nodes. * * If a single node is passed to the method then a single visibility state is returned. * If an array of nodes is passed to the method then an array of visibility states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is visible, `false` * otherwise. */ getVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Sets the default highlighting color * * * @returns `this` to allow method chaining. */ setHighlightColor( /** * The new highlighting color. The value can be defined as a string in the CSS color format or as an integer * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should * be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Sets the opacity of the nodes. * * * @returns `this` to allow method chaining. */ setOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new opacity of the nodes. If `null` is passed then the opacity is reset and the node's own opacity * should be used. */ opacity: float | float[] | null, /** * This flag is not used, as opacity is always recursively applied to the offspring nodes by multiplication */ recursive?: boolean ): this; /** * Sets the selection state of the nodes. * * @deprecated As of version 1.80.0. Use {@link sap.ui.vk.svg.ViewStateManager#setSelectionStates} instead. * * @returns `this` to allow method chaining. */ setSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets or resets the selection state of the nodes. * * * @returns `this` to allow method chaining. */ setSelectionStates( /** * The node reference or the array of node references of selected nodes. */ selectedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unselectedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets the tint color of the nodes. * * * @returns `this` to allow method chaining. */ setTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an * integer in the ABGR format or it could be array of these values. If `null` is passed then the tint color * is reset and the node's own tint color should be used. */ tintColor: | sap.ui.core.CSSColor | int | sap.ui.core.CSSColor[] | int[] | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the visibility state of the nodes. * * * @returns `this` to allow method chaining. */ setVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new visibility state or array of states of the nodes. */ visible: boolean | boolean[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag * will force node to be visible regardless of parent's state. */ force: boolean ): this; } /** * Event object of the ContentManager#errorReported event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ContentManager$ErrorReportedEvent = sap.ui.base.Event< ContentManager$ErrorReportedEventParameters, ContentManager >; /** * Event object of the Viewport#cameraChanged event. */ type Viewport$CameraChangedEvent = sap.ui.base.Event< Viewport$CameraChangedEventParameters, Viewport >; /** * Event object of the Viewport#hotspotEnter event. */ type Viewport$HotspotEnterEvent = sap.ui.base.Event< Viewport$HotspotEnterEventParameters, Viewport >; /** * Event object of the Viewport#hotspotLeave event. */ type Viewport$HotspotLeaveEvent = sap.ui.base.Event< Viewport$HotspotLeaveEventParameters, Viewport >; } namespace threejs { /** * Describes the settings that can be provided to the ContentManager constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $ContentManagerSettings extends sap.ui.vk.$ContentManagerSettings {} /** * Describes the settings that can be provided to the NodeHierarchy constructor. */ interface $NodeHierarchySettings extends sap.ui.vk.$NodeHierarchySettings {} /** * Describes the settings that can be provided to the NodeProxy constructor. */ interface $NodeProxySettings extends sap.ui.vk.$NodeProxySettings {} /** * Describes the settings that can be provided to the OrthographicCamera constructor. */ interface $OrthographicCameraSettings extends sap.ui.vk.$OrthographicCameraSettings {} /** * Describes the settings that can be provided to the PerspectiveCamera constructor. */ interface $PerspectiveCameraSettings extends sap.ui.vk.$PerspectiveCameraSettings {} /** * Describes the settings that can be provided to the Scene constructor. */ interface $SceneSettings extends sap.ui.vk.$SceneSettings {} /** * Describes the settings that can be provided to the Texture constructor. */ interface $TextureSettings extends sap.ui.vk.$TextureSettings {} /** * Describes the settings that can be provided to the Viewport constructor. */ interface $ViewportSettings extends sap.ui.vk.$ViewportBaseSettings { cameraChanged?: (oEvent: Viewport$CameraChangedEvent) => void; frameRenderingFinished?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the ViewStateManager constructor. */ interface $ViewStateManagerSettings extends sap.ui.vk.$ViewStateManagerBaseSettings {} /** * Parameters of the Viewport#cameraChanged event. */ interface Viewport$CameraChangedEventParameters { /** * Returns a new camera position. */ position?: float[]; /** * Returns a new camera rotation quaternion. */ quaternion?: float[]; /** * Returns a new camera orthographic zoom factor. */ zoom?: float; } /** * Parameters of the Viewport#frameRenderingFinished event. */ interface Viewport$FrameRenderingFinishedEventParameters {} /** * Provides a simple, lightweight proxy object to a node in a node hierarchy. * * The objects of this class should not be created directly, and should only be created through the use * of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } */ class BaseNodeProxy extends sap.ui.vk.BaseNodeProxy implements sap.ui.base.Poolable { __implements__sap_ui_base_Poolable: boolean; /** * Constructor for a new BaseNodeProxy. The objects of this class should not be created directly, and should * only be created through the use of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } * * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.BaseNodeProxy#constructor sap.ui.vk.BaseNodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.BaseNodeProxy 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.vk.BaseNodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.BaseNodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Indicates whether the node has child nodes. * * * @returns A value of `true` indicates that the node has child nodes, and a value of `false` indicates * otherwise. */ getHasChildren(): boolean; /** * Gets the name of the node. * * * @returns The node's name. */ getName(): string; /** * Gets the node reference. * * * @returns The node reference. */ getNodeId(): any; /** * Gets the metadata of the node. * * * @returns A JSON object containing the node's metadata. */ getNodeMetadata(): object; /** * Gets the reference object of the node. * * * @returns The node's reference object. */ getNodeRef(): object; /** * Gets the scene reference that this BaseNodeProxy object wraps. * * * @returns A scene reference that this BaseNodeProxy object wraps. */ getSceneRef(): any; /** * Initialize this BaseNodeProxy with its data. * * The `init` method is called by an object pool when the object is (re-)activated for a new caller. * See: * sap.ui.base.Poolable.prototype#init * * @ui5-protected Do not call from applications (only from related classes in the framework) */ init( /** * The NodeHierarchy object this BaseNodeProxy object belongs to. */ nodeHierarchy: sap.ui.vk.threejs.NodeHierarchy, /** * The reference object of the node for which to get BaseNodeProxy. */ nodeRef: any ): void; /** * Reset BaseNodeProxy data, needed for pooling. * See: * sap.ui.base.Poolable.prototype#reset * * @ui5-protected Do not call from applications (only from related classes in the framework) */ reset(): void; } /** * Provides a content manager object that uses the three.js library to load 3D files. * * When registering a content manager resolver with {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * you can pass a function that will load a model and merge it into the three.js scene. * * The loader function takes two parameters: * - parentNode - {@link https://threejs.org/docs/index.html#api/objects/Group THREE.Group} - a grouping * node to merge the content into * - contentResource - {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource} - a content resource * to load The loader function returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise } * object. If the loading the model succeeds the promise object resolves with a value with the following * structure: * - node - {@link https://threejs.org/docs/index.html#api/objects/Group THREE.Group} - the grouping node * to which the content is merged into. It should be the `parentNode` parameter that was passed to the loader * function. * - contentResource - {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource} - the content resource * that was loaded. * * @since 1.50.0 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ class ContentManager extends sap.ui.vk.ContentManager { /** * Constructor for a new ContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. * See: * {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * for an example. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.threejs.$ContentManagerSettings ); /** * Constructor for a new ContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. * See: * {@link sap.ui.vk.ContentConnector.addContentManagerResolver sap.ui.vk.ContentConnector.addContentManagerResolver } * for an example. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * ID for the new ContentManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.threejs.$ContentManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.threejs.ContentManager 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.vk.ContentManager.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.ContentManager. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Collects and destroys unused objects and resources. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ collectGarbage(): this; /** * Creates an Orthographic camera * * @since 1.52.0 * * @returns Created Camera. */ createOrthographicCamera(): sap.ui.vk.OrthographicCamera; /** * Creates a Perspective camera * * @since 1.52.0 * * @returns Created Camera. */ createPerspectiveCamera(): sap.ui.vk.PerspectiveCamera; /** * Destroys the content. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ destroyContent( /** * The content to destroy. */ content: any ): this; /** * Starts downloading and building or updating the content from the content resources. * * This method is asynchronous. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ loadContent( /** * The current content to update. It can be `null` if this is an initial loading call. */ content: any, /** * The content resources to load or update. */ contentResources: sap.ui.vk.ContentResource[] ): this; } /** * Provides the interface for the material. * * @since 1.60.0 */ class Material extends sap.ui.vk.Material { /** * Constructor for a new Material. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.Material#constructor sap.ui.vk.Material } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.Material 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.vk.Material.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.Material. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; } /** * Provides the ability to explore a Scene object's node structure. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene#getDefaultNodeHierarchy}. */ class NodeHierarchy extends sap.ui.vk.NodeHierarchy { /** * Constructor for a new NodeHierarchy. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeHierarchy#constructor sap.ui.vk.NodeHierarchy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.NodeHierarchy 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.vk.NodeHierarchy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.NodeHierarchy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Creates a layer proxy object. * * The layer proxy object must be destroyed with the {@link #destroyLayerProxy destroyLayerProxy} method. * * * @returns The proxy object. */ createLayerProxy( /** * The layer ID for which to create a proxy object. */ layerId: string ): sap.ui.vk.LayerProxy; /** * Creates a new node. * * @since 1.48.0 * * @returns The reference object of the newly created node. */ createNode( /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: THREE.Object3D, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: THREE.Object3D, /** * The created node content type. */ nodeContentType?: sap.ui.vk.NodeContentType, /** * Optional Json structure used to define node properties. */ content?: object ): THREE.Object3D; /** * Creates a copy of an existing node. * * @since 1.48.0 * * @returns The reference object of the newly created node. */ createNodeCopy( /** * The reference object of the node to copy. */ nodeToCopy: any, /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any ): any; /** * Creates a node proxy object. * * The node proxy object must be destroyed with the {@link #destroyNodeProxy destroyNodeProxy} method. * * * @returns The proxy object. */ createNodeProxy( /** * The reference object for which to create a proxy object. */ nodeRef: any ): sap.ui.vk.NodeProxy; /** * Destroys the layer proxy object. * * * @returns `this` to allow method chaining. */ destroyLayerProxy( /** * The layer proxy object. */ layerProxy: sap.ui.vk.LayerProxy ): this; /** * Destroys the node proxy object. * * * @returns `this` to allow method chaining. */ destroyNodeProxy( /** * The node proxy object. */ nodeProxy: sap.ui.vk.NodeProxy ): this; /** * Enumerates the ancestor nodes of a particular node in the Scene object. * * This method enumerates the ancestor nodes of a particular node, and then calls the `callback` function, * to which it passes the ancestor nodes to one by one. * The BaseNodeProxy objects passed to `callback` are temporary objects, they are reset after each call * to the `callback` function. * The ancestor nodes are enumerated starting from the top level node, and progresses down the node hierarchy. * * * @returns `this` to allow method chaining. */ enumerateAncestors( /** * The reference object of a node whose ancestor nodes we want enumerated. */ nodeRef: any, /** * A function to call when the ancestor nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to pass the node references of the ancestor nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the ancestor nodes are passed to the `callback` function. * * If `false`, then the node proxies of the ancestor nodes are passed to the `callback` function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * The reference object of a node whose child nodes we want enumerated. * When `nodeRef` is specified, the child nodes of this node are enumerated. * When no `nodeRef` is specified, only the top level nodes are enumerated. */ nodeRef: any, /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * * @returns `this` to allow method chaining. */ enumerateChildren( /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the node references of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the node references of the child nodes are passed to the `callback` function. * If `false`, then the node proxies created from the child node references are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Finds nodes in a scene via node name. * * * @returns A list of reference objects belonging to nodes that matched the search criteria. */ findNodesByName( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * value: string | string[], * predicate: "equals" | "contains" | "startsWith", * caseSensitive: true | false * }``` * * * - **query.value** * A string or an array of strings containing the name of a node or names of nodes. If no value is specified, * then all nodes in the scene will be returned. * The following example shows a single string being passed in: * ```javascript * value: "Box #14"``` * The following example shows an array of strings being passed in: * ```javascript * value: ["Box #3", "box #4", "BOX #5"]``` * * - **query.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for nodes with names that exactly match the provided string or array of * strings. * Using `"contains"` will search for nodes with names containing all or part of the provided string or * array of strings. * Using `"startsWith"` will search for nodes with names starting with the provided string or array of * strings. * If no value is specified, the search mode will default to `"equals"`. * * * - **query.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): THREE.Object3D[]; /** * Find nodes by UsageId path. * * The method can return multiple nodes matching `path` especially when `path contains a string "**"`. * * * @returns An array of node references. */ findNodesByUsageIdPath( /** * A UsageId name which the keys in `path` belong to. */ usageIdName: string, /** * An array of UsageId keys where each item is a single JSON like object with properties `name` and `value` * for single-key UsageIds and an array of such objects for multi-key UsageIds. The item can can be a string * `"*"` to indicate that it can be any node or the item can be a string `"**"` to indicate that some nodes * can be skipped. */ path: any[], /** * Optional settings for the method. */ options?: { /** * An optional non-`null` node reference for limiting the scope of search with a subtree starting with the * `options.searchUnder` node excluding the `options.searchUnder` node itself. */ searchUnder?: any; /** * An indicator to search in ***closed*** nodes as well. */ stepIntoClosedNodes?: boolean; } ): any[]; /** * Returns a list of reference objects belonging to the ancestors of a particular node. * * * @returns A list of reference objects belonging to the ancestors of `nodeRef`. */ getAncestors( /** * The reference object of the node whose ancestors will be returned. */ nodeRef: any ): any[]; /** * Returns a list of reference objects belonging to the children of a particular node. * * * @returns A list of reference objects belonging to the children of `nodeRef`. */ getChildren( /** * The reference object of the node whose children will be returned. If `nodeRef` is not passed to the `getChildren` * function, the reference objects of the root nodes will be returned. */ nodeRef: any, /** * Indicates whether to return only the child nodes of a closed node or not. If `true`, then the * children of that closed node will be returned. If `false`, then the children of that closed node * will not be returned. */ stepIntoClosedNodes?: boolean ): any[]; /** * Returns a list of hotspot node references. * * * @returns A list of hotspot node references. */ getHotspotNodeRefs(): any[]; /** * Returns a list of layer IDs. * * * @returns A list of layer IDs. */ getLayers(): string[]; /** * Get node content type * * @since 1.73.0 * * @returns Node content type */ getNodeContentType( /** * The node reference */ nodeRef: any ): sap.ui.vk.NodeContentType; /** * Gets the Scene object the node hierarchy belongs to. * * * @returns The Scene object the node hierarchy belongs to. */ getScene(): sap.ui.vk.Scene; /** * Gets the scene reference that this NodeHierarchy object wraps. * * * @returns The scene reference that this NodeHierarchy object wraps. */ getSceneRef(): any; /** * Deletes a node and destroys it. * * @since 1.48.0 * * @returns `this` to allow method chaining. */ removeNode( /** * The reference object of a node or an array of nodes to destroy. */ nodeRef: any ): this; } /** * Provides a proxy object to the node in the node hierarchy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createNodeProxy sap.ui.vk.NodeHierarchy.createNodeProxy } * method. and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyNodeProxy sap.ui.vk.NodeHierarchy.destroyNodeProxy } * method. */ class NodeProxy extends sap.ui.vk.NodeProxy { /** * Constructor for a new NodeProxy. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.NodeProxy#constructor sap.ui.vk.NodeProxy } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.NodeProxy 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.vk.NodeProxy.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.NodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Assign material to all mesh nodes contained in the current node * * * @returns `this` to allow method chaining. */ assignMaterial( /** * Material to be assigned. */ value: sap.ui.vk.Material ): this; /** * Retrieve all materials defined in the current node * * * @returns The array of materials. */ enumerateMaterials( /** * If `true` then include materials defined in all child nodes */ recursive: boolean ): sap.ui.vk.Material[]; /** * get local rotation represented by axis and angle * * * @returns angleAxis rotation [x, y, z, angle], (x, y, z) - rotation axis */ getLocalRotationInAngleAxis(): float[]; /** * get local rotation in Euler form * * * @returns angleAxis rotation [a1, a2, a3, order] a1, a2, a3 - rotation angles about 1st, 2nd, 3nd axis * order - int encoding order of XYZ axis (e.g, order "XZY" - 011100 (01 - 3rd axis(Y), 11 - 2nd axis(Z), * 00 - 1st axis(X))) */ getLocalRotationInEuler(): float[]; /** * get local rotation represented by quaternion * * * @returns quaternion [x, y, z, w] */ getLocalRotationInQuaternion(): float[]; /** * get local scale vector * * * @returns scale vector */ getLocalScale(): float[]; /** * get local translate vector * * * @returns translate vector */ getLocalTranslate(): float[]; /** * Replace material with another material * * * @returns `this` to allow method chaining. */ replaceMaterial( /** * Material to be replaced. */ materialToReplace: sap.ui.vk.Material | THREE.Material, /** * Material replacement. */ material: sap.ui.vk.Material | THREE.Material ): this; } /** * Provides the interface for the camera. * * @since 1.52.0 */ class OrthographicCamera extends sap.ui.vk.OrthographicCamera { /** * Constructor for a new OrthographicCamera. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.OrthographicCamera#constructor sap.ui.vk.OrthographicCamera } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.OrthographicCamera 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.vk.OrthographicCamera.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.OrthographicCamera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Adjust the camera near and far clipping planes to include the entire specified bounding box * * * @returns this */ adjustClipPlanes( /** * Bounding box */ boundingBox: THREE.Box3 ): sap.ui.vk.threejs.OrthographicCamera; /** * Adjust the camera zoom to include the entire specified bounding box * * * @returns this */ adjustZoom( /** * Bounding box */ boundingBox: THREE.Box3 ): sap.ui.vk.threejs.OrthographicCamera; /** * Updates the camera properties with width and height of viewport */ update( /** * width of the viewport */ width: float, /** * height of the viewport */ height: float ): void; } /** * Provides the interface for the camera. * * @since 1.52.0 */ class PerspectiveCamera extends sap.ui.vk.PerspectiveCamera { /** * Constructor for a new PerspectiveCamera. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.PerspectiveCamera#constructor sap.ui.vk.PerspectiveCamera } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.PerspectiveCamera 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.vk.PerspectiveCamera.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.PerspectiveCamera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Adjust the camera near and far clipping planes to include the entire specified bounding box * * * @returns this */ adjustClipPlanes( /** * Bounding box */ boundingBox: THREE.Box3 ): sap.ui.vk.threejs.PerspectiveCamera; /** * Updates the camera properties with width and height of viewport */ update( /** * width of the viewport */ width: float, /** * height of the viewport */ height: float ): void; } /** * Provides the interface for the 3D model. * * The objects of this class should not be created directly. */ class Scene extends sap.ui.vk.Scene { /** * Constructor for a new Scene. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.Scene#constructor sap.ui.vk.Scene } * can be used. */ constructor( /** * The three.js scene object. */ scene: THREE.Scene ); /** * Creates a new subclass of class sap.ui.vk.threejs.Scene 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.vk.Scene.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.Scene. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Add marker to node associations */ bindMarkerNodeTransformationToReferenceNode( /** * Marker's reference node id */ referenceNodeId: string, /** * Marker's node id */ markerNodeId: string ): void; /** * Gets all materials defined in scene nodes * * * @returns the array of materials. */ enumerateMaterials(): sap.ui.vk.Material[]; /** * Gets the default node hierarchy in the Scene object. * * * @returns The default node hierarchy in the Scene object. */ getDefaultNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the unique ID of the Scene object. * * * @returns The unique ID of the Scene object. */ getId(): string; /** * Get initial view * * * @returns initial view */ getInitialView(): sap.ui.vk.View; /** * Get reference node for a given marker node sid * * * @returns reference node of given marker */ getReferenceNodeFromMarkerNodeId( /** * Marker's sid */ markNodeId: string ): /* was: sap.ui.vk.threejs.Node */ any; /** * Gets the scene reference for the Scene object. * * * @returns The three.js scene. */ getSceneRef(): THREE.Scene; /** * Gets the persistent ID from node reference. * * * @returns The persistent ID or the array of the persistent IDs. */ nodeRefToPersistentId( /** * The reference to the node or the array of references to the nodes. */ nodeRefs: THREE.Object3D | THREE.Object3D[] ): string | string[]; /** * Gets the node reference from persistent ID. * * * @returns The reference to the node or the array of references to the nodes. */ persistentIdToNodeRef( /** * The persistent ID or the array of the persistent IDs. */ pIDs: string | string[] ): THREE.Object3D | THREE.Object3D[]; /** * Set initial view */ setInitialView( /** * Initial view */ view: sap.ui.vk.View ): void; /** * Remove marker from node associations */ unbindMarkerNodeTransformationFromReferenceNode( /** * Marker's reference node id */ referenceNodeId: string, /** * Marker's node id */ markerNodeId: string ): void; } /** * Provides the interface for the material. * * @since 1.60.0 */ class Texture extends sap.ui.vk.Texture { /** * Constructor for a new Material. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.Texture#constructor sap.ui.vk.Texture } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.threejs.Texture 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.vk.Texture.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.Texture. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; } /** * Provides a control for three.js canvas. */ class Viewport extends sap.ui.vk.ViewportBase { /** * Constructor for a ThreeJs viewport. * * 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(); /** * Creates a new subclass of class sap.ui.vk.threejs.Viewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Activates the view based on view object passed * * @since 1.52.0 * * @returns returns this */ activateView( /** * View object definition */ view: sap.ui.vk.View, /** * true if view activation is part of playing view group */ playViewGroup: boolean, /** * true if not animating the change of camera */ skipCameraTransitionAnimation: boolean ): sap.ui.vk.threejs.Viewport; /** * Attaches event handler `fnFunction` to the {@link #event:cameraChanged cameraChanged} event of this `sap.ui.vk.threejs.Viewport`. * * 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.threejs.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCameraChanged( /** * 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: Viewport$CameraChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.threejs.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cameraChanged cameraChanged} event of this `sap.ui.vk.threejs.Viewport`. * * 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.threejs.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCameraChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewport$CameraChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.threejs.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.threejs.Viewport`. * * 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.threejs.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachFrameRenderingFinished( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.threejs.Viewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.threejs.Viewport`. * * 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.threejs.Viewport` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachFrameRenderingFinished( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.threejs.Viewport` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:cameraChanged cameraChanged} event of this * `sap.ui.vk.threejs.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCameraChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewport$CameraChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:frameRenderingFinished frameRenderingFinished } * event of this `sap.ui.vk.threejs.Viewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFrameRenderingFinished( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:cameraChanged cameraChanged} 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 */ fireCameraChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.threejs.Viewport$CameraChangedEventParameters ): this; /** * Fires event {@link #event:frameRenderingFinished frameRenderingFinished} 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 */ fireFrameRenderingFinished( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Get current view - remembered when activateView function is called * * * @returns Current view */ getCurrentView(): sap.ui.vk.View; /** * Returns viewport content as an image of desired size. * * * @returns Base64 encoded PNG image */ getImage( /** * Requested image width in pixels. Allowed values are 8 to 2048, default is 16 */ width: int, /** * Requested image height in pixels. Allowed values are 8 to 2048, default is 16 */ height: int, /** * The sap.ui.core.CSSColor to be used for top background color */ topColor: string, /** * The sap.ui.core.CSSColor to be used for bottom background color */ bottomColor: string, /** * Include selected nodes */ includeSelection: boolean ): string; /** * Returns object as an image of desired size. * * @since 1.82.0 * * @returns Base64 encoded PNG image */ getObjectImage( /** * The node reference. */ nodeRef: any, /** * Requested image width in pixels. Allowed values are 8 to 2048, default is 256 */ width: int, /** * Requested image height in pixels. Allowed values are 8 to 2048, default is 256 */ height: int, /** * The sap.ui.core.CSSColor to be used for top background color */ topColor: string, /** * The sap.ui.core.CSSColor to be used for bottom background color */ bottomColor: string, /** * Optional camera rotation quaternion */ quaternion: THREE.Quaternion, /** * The object margin */ margin: float ): string; /** * Returns object/objects as an image of desired size. * * @since 1.102.0 * * @returns Base64 encoded image */ getObjectImageEx( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * Requested image width in pixels. Allowed values are 8 to 2048, default is 256 */ width: int, /** * Requested image height in pixels. Allowed values are 8 to 2048, default is 256 */ height: int, /** * The sap.ui.core.CSSColor to be used for top background color */ topColor: string, /** * The sap.ui.core.CSSColor to be used for bottom background color */ bottomColor: string, /** * A map of parameters, optional */ options: { /** * If set to `true`, the viewport camera will be used */ useViewportCamera?: boolean; /** * Camera rotation quaternion (if options.useViewportCamera is not set to `false`) */ quaternion: THREE.Quaternion; /** * The object margin (if options.useViewportCamera is not set to `false`) */ margin: float; /** * Output image format. The default type is "image/png" */ type: string; /** * A number between 0 and 1 indicating the output image quality */ encoderOptions: number; /** * If set to `true` then overlay nodes will be rendered */ includeOverlay?: boolean; /** * If set to `true` then underlay nodes will be rendered */ includeUnderlay?: boolean; } ): string; /** * Gets position and size of the viewport square. The information can be used for making calculations when * restoring Redlining elements. * * * @returns The information in this object: * - **left** - The x coordinate of the top-left corner of the square. * - **top** - The y coordinate of the top-left corner of the square. * - **sideLength** - The length of the square. */ getOutputSize(): object; /** * Gets the Viewport Scene * * * @returns returns Scene */ getScene(): sap.ui.vk.threejs.Scene; /** * Retrieves information about the current camera view in the scene, and saves the information in a JSON-like * object. The information can then be used at a later time to restore the scene to the same camera view * using the {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} method. * * * * @returns JSON-like object which holds the current view information. See {@link sap.ui.vk.Viewport#setViewInfo setViewInfo}. * In addition to properties defined in {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} the output from * {@link sap.ui.vk.Viewport#getViewInfo getViewInfo} contains camera view and projection matrices * ```javascript * * { * ... * camera: { * ... * matrices: { * view: [number, ...], * projection: [number, ...], * } * ... * }, * ... * } * ``` */ getViewInfo( /** * Query object which indicates what information to be retrieved. */ query?: { /** * Indicator to retrieve camera information. */ camera?: | boolean | { /** * Indicator to retrieve camera view and projection matrices. */ matrices?: boolean; /** * Indicator to retrieve the transition camera properties instead of regular one's. */ useTransitionCamera?: boolean; }; /** * Indicator to retrieve visibility information. */ visibility?: | boolean | { /** * Indicator to retrieve the complete visibility definition or just the difference. */ mode?: /* was: sap.ui.vk.VisibilityMode */ any; }; /** * Indicator to retrieve selection information. */ selection?: boolean | object; /** * Indicator to retrieve cross-section tool information. */ crossSection?: boolean | object; } ): object; /** * Queues a command for execution during the rendering cycle. All gesture operations should be called using * this method. * * * @returns returns this */ queueCommand( /** * The command to be executed. */ command: Function ): sap.ui.vk.threejs.Viewport; /** * Sets the camera for the Viewport * * * @returns `this` to allow method chaining. */ setCamera( /** * parameter */ camera: sap.ui.vk.Camera ): this; /** * Attaches the scene to the Viewport for rendering. * * @deprecated As of version 1.50.0. Viewport now gets reference to the scene via {@link sap.ui.vk.ContentConnector}. * * @returns `this` to allow method chaining. */ setScene( /** * The scene to attach to the Viewport. */ scene: sap.ui.vk.threejs.Scene ): this; /** * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining. */ setShouldRenderFrame( /** * If set to 'true', then hierarchy and matrix recomputation is not required, only redraw. */ skipHierarchyProcessing: boolean ): this; /** * Sets the current scene to use the camera view information acquired from the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. * Internally, the `setViewInfo` method activates certain steps at certain animation times, and then changes * the camera position, rotation and field of view (FOV) / zoom factor. * * * @returns `this` to allow method chaining. */ setViewInfo( /** * A JSON-like object containing view information acquired using the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. */ viewInfo: { /** * A JSON-like object containing the camera information. */ camera?: { /** * Rotation defined in {@link https://en.wikipedia.org/wiki/Aircraft_principal_axes Aircraft principal axes}. */ rotation: { /** * Angle around the vertical axis in degrees. */ yaw: float; /** * Angle around the lateral axis in degrees. */ pitch: float; /** * Angle around the longitudinal axis in degrees. */ roll: float; }; /** * Position defined in 3-dimensional space. */ position: { /** * X coordinate. */ x: float; /** * Y coordinate. */ y: float; /** * Z coordinate. */ z: float; }; /** * Camera field of view binding type. */ bindingType: sap.ui.vk.CameraFOVBindingType; /** * Camera projection type. */ projectionType: sap.ui.vk.CameraProjectionType; /** * Camera field of view in degrees. Applicable only to perspective cameras. */ fieldOfView: float; /** * Camera zoom factor. Applicable only to orthographic cameras. */ zoomFactor: float; }; /** * A JSON-like object containing the animation information. */ animation?: { /** * Step VE ID. If it is omitted then procedure and step indices are used. */ stepVeId?: string; /** * Procedure index in the list of procedures. */ procedureIndex?: int; /** * Step index in the list of steps in the procedure. */ stepIndex?: int; /** * Time at which to activate the step. */ animationTime?: float; }; /** * A JSON-like object containing the visibility information. */ visibility?: { /** * If the mode equals to {@link sap.ui.vk.VisibilityMode.Complete complete} then the visible and hidden * fields are defined. If the mode equals {@link sap.ui.vk.VisibilityMode.Differences differences} then * the changes field is defined. */ mode: /* was: sap.ui.vk.VisibilityMode */ any; /** * List of Ids of visible nodes. */ visible: string[]; /** * List of Ids of hidden nodes. */ hidden: string[]; /** * List of Ids of nodes with inverted visibility. */ changes: string[]; }; /** * A JSON-like object containing the selection information. */ selection?: { /** * List of Ids of selected nodes. */ selected: string[]; /** * List of Ids of outlined nodes. */ 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. */ flyToDuration?: float ): this; /** * Zooms the scene to a bounding box created from a particular set of nodes. * * * @returns this */ zoomTo( /** * What set of nodes to zoom to. */ what: sap.ui.vk.ZoomTo | sap.ui.vk.ZoomTo[], /** * Is used if what == (sap.ui.vk.ZoomTo.Node || ZoomTo.NodeSetIsolation) */ nodeRef: any, /** * Time to perform the "fly to" animation. Set to 0 to do this immediately. */ crossFadeSeconds: float, /** * Margin. Set to 0 to zoom to the entire screen. */ margin: float ): sap.ui.vk.Viewport; } /** * Manages the visibility, selection, opacity and tint color states of nodes in the scene. * * @since 1.32.0 */ class ViewStateManager extends sap.ui.vk.ViewStateManagerBase { /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.threejs.$ViewStateManagerSettings ); /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * ID for the new ViewStateManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.threejs.$ViewStateManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.threejs.ViewStateManager 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.vk.ViewStateManagerBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.threejs.ViewStateManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Enumerates IDs of the outlined nodes. * * * @returns Returns `this` to allow method chaining */ enumerateOutlinedNodes( /** * A function to call when the outlined nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Enumerates IDs of the selected nodes. * * * @returns Returns `this` to allow method chaining */ enumerateSelection( /** * A function to call when the selected nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Gets the default highlighting color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getHighlightColor( /** * This flag indicates to return the highlighting color in the ABGR format, if it equals `false` then the * color is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the NodeHierarchy object associated with this ViewStateManager object. * * * @returns The node hierarchy associated with this ViewStateManager object. */ getNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the opacity of the node. * * If a single node is passed to the method then a single value is returned. * If an array of nodes is passed to the method then an array of values is returned. */ getOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): void; /** * Gets the outline color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getOutlineColor( /** * This flag indicates to return the outline color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the outline width * * * @returns width of outline */ getOutlineWidth(): float; /** * Gets the outlining state of the node. * * If a single node reference is passed to the method then a single outlining state is returned. * If an array of node references is passed to the method then an array of outlining states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getOutliningState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets the selection state of the node. * * If a single node reference is passed to the method then a single selection state is returned. * If an array of node references is passed to the method then an array of selection states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets if showing the bounding box when nodes are selected * * * @returns `true` if bounding boxes of selected nodes are shown, `false` otherwise. */ getShowSelectionBoundingBox(): boolean; /** * Get the Symbol node from nodeId, if nodeId is not set, returns a collection of all Symbol nodes * * @since 1.82.0 * * @returns An array of nodes */ getSymbolNodes( /** * node Id string, optional */ nodeId: string ): any[]; /** * Gets the tint color of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * This flag indicates to return the tint color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[] | int | int[]; /** * Gets the visibility changes in the current ViewStateManager object. * * * @returns The visibility changes are in the form of an array. The array is a list of node VE ids which * suffered a visibility changed relative to the default state. */ getVisibilityChanges(): string[]; /** * Gets the visibility state of nodes. * * If a single node is passed to the method then a single visibility state is returned. * If an array of nodes is passed to the method then an array of visibility states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is visible, `false` * otherwise. */ getVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Reset node property to the value defined by current view.. */ resetNodeProperty( /** * reference to node. */ nodeRef: object, /** * node property */ property: string ): void; /** * Replace node's current transformation with its rest transformation stored in active view.. * * * @returns `this` to allow method chaining. */ restoreRestTransformation( /** * The node reference. */ nodeRef: any ): this; /** * Sets the default selection color * * * @returns Returns `this` to allow method chaining */ setHighlightColor( /** * The new selection color. The value can be defined as a string in the CSS color format or as an integer * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should * be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Set highlight display state. * * * @returns `this` to allow method chaining. */ setHighlightDisplayState( /** * for playing highlight - playing, pausing, and stopped */ state: /* was: sap.ui.vk.HighlightDisplayState */ any ): this; /** * Sets the highlight color of the nodes. * * * @returns Returns `this` to allow method chaining */ setNodesHighlightColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new highlight color of the nodes. The value should be defined as an array of floats in the RGBA format. * If `null` is passed then the highlight color is reset and the node's own highlight color should be used. */ highlightColor: float[] | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the opacity of the nodes. * * * @returns Returns `this` to allow method chaining */ setOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new opacity of the nodes. If `null` is passed then the opacity is reset and the node's own opacity * should be used. */ opacity: float | float[] | null, /** * This flag is not used, as opacity is always recursively applied to the offspring nodes by multiplication */ recursive?: boolean ): this; /** * Sets the outline color * * * @returns Returns `this` to allow method chaining */ setOutlineColor( /** * The new outline color. The value can be defined as a string in the CSS color format or as an integer * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should * be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Sets the outline width * * * @returns `this` to allow method chaining. */ setOutlineWidth( /** * width of outline */ width: float ): this; /** * Sets or resets the outlining state of the nodes. * * * @returns Returns `this` to allow method chaining */ setOutliningStates( /** * The node reference or the array of node references of outlined nodes. */ outlinedNodeRefs: any | any[], /** * The node reference or the array of node references of un-outlined nodes. */ unoutlinedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress outlineChanged event. */ blockNotification: boolean ): this; /** * Sets the selection state of the nodes. * * @deprecated As of version 1.56.3. Use {@link sap.ui.vk.threejs.ViewStateManager#setSelectionStates} instead. * * @returns Returns `this` to allow method chaining */ setSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets or resets the selection state of the nodes. * * * @returns Returns `this` to allow method chaining */ setSelectionStates( /** * The node reference or the array of node references of selected nodes. */ selectedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unselectedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets if showing the bounding box when nodes are selected */ setShowSelectionBoundingBox( /** * `true` if bounding boxes of selected nodes are shown, `false` otherwise. */ val: boolean ): void; /** * Sets the tint color of the nodes. * * * @returns Returns `this` to allow method chaining */ setTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an * integer in the ABGR format or it could be an array of these values. If `null` is passed then the tint * color is reset and the node's own tint color should be used. */ tintColor: | sap.ui.core.CSSColor | int | sap.ui.core.CSSColor[] | int[] | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the visibility state of the nodes. * * * @returns Returns `this` to allow method chaining */ setVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new visibility state or array of states of the nodes. */ visible: boolean | boolean[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag * will force node to be visible regardless of parent's state. */ force: boolean ): this; /** * Copy nodes' current transformation into their rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ updateNodesRestTransformation( /** * Array of node references. */ nodeRefs: any[] ): this; /** * Copy node's current transformation into its rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ updateRestTransformation( /** * The node reference. */ nodeRef: any, /** * Do not fire sequence changed event if true */ DoNotFireSequenceChanged: boolean ): this; } /** * Defines the three.js material type. */ enum MaterialType { /** * Line basic material */ LineBasicMaterial = "LineBasicMaterial", /** * Mesh basic material */ MeshBasicMaterial = "MeshBasicMaterial", /** * Mesh phong material */ MeshPhongMaterial = "MeshPhongMaterial", } /** * Event object of the Viewport#cameraChanged event. */ type Viewport$CameraChangedEvent = sap.ui.base.Event< Viewport$CameraChangedEventParameters, Viewport >; /** * Event object of the Viewport#frameRenderingFinished event. */ type Viewport$FrameRenderingFinishedEvent = sap.ui.base.Event< Viewport$FrameRenderingFinishedEventParameters, Viewport >; } namespace tools { /** * Describes the settings that can be provided to the AnchorPointTool constructor. */ interface $AnchorPointToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * If set to true values will change in round number increments instead of continual change */ enableStepping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates the type of allowed operations */ allowOperation?: | sap.ui.vk.tools.AnchorPointToolOperation | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not to allow context menu on right-click */ allowContextMenu?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The anchor point tool position in the world coordinate system. This property is read-only. */ position?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The anchor point tool quaternion. This property is read-only. */ quaternion?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when movement occurs. */ moving?: (oEvent: AnchorPointTool$MovingEvent) => void; /** * This event will be fired when movement finished. */ moved?: (oEvent: AnchorPointTool$MovedEvent) => void; /** * This event will be fired when rotation occurs. */ rotating?: (oEvent: AnchorPointTool$RotatingEvent) => void; /** * This event will be fired when rotation finished. */ rotated?: (oEvent: AnchorPointTool$RotatedEvent) => void; } /** * Describes the settings that can be provided to the AxisAngleRotationTool constructor. */ interface $AxisAngleRotationToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * If set to `true` values will change in round number increments instead of continual change */ enableStepping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if snapping when rotating is enabled */ enableSnapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not to allow context menu on right-click */ allowContextMenu?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determine what set of nodes will be transformed with this tool */ nodeSet?: | sap.ui.vk.tools.ToolNodeSet | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. */ rotating?: (oEvent: AxisAngleRotationTool$RotatingEvent) => void; /** * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. */ rotated?: (oEvent: AxisAngleRotationTool$RotatedEvent) => void; } /** * Describes the settings that can be provided to the CreateEllipseTool constructor. */ interface $CreateEllipseToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Parent node for new elements. */ parentNode?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the tool creates a circle instead of an ellipse. */ uniformMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when a new element is created. */ completed?: (oEvent: CreateEllipseTool$CompletedEvent) => void; } /** * Describes the settings that can be provided to the CreatePathTool constructor. */ interface $CreatePathToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Parent node for new elements. */ parentNode?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Flag to always create closed path elements. */ closePath?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when a new element is created. */ completed?: (oEvent: CreatePathTool$CompletedEvent) => void; } /** * Describes the settings that can be provided to the CreateRectangleTool constructor. */ interface $CreateRectangleToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Parent node for the rectangle that will be created. */ parentNode?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the tool creates a square instead of a rectangle. */ uniformMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when a new element is created. */ completed?: (oEvent: CreateRectangleTool$CompletedEvent) => void; } /** * Describes the settings that can be provided to the CreateTextTool constructor. */ interface $CreateTextToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Parent node for new elements. */ parentNode?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Font size */ fontSize?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Font face */ fontFace?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Fired when a new element is created. */ completed?: (oEvent: CreateTextTool$CompletedEvent) => void; } /** * Describes the settings that can be provided to the CrossSectionTool constructor. */ interface $CrossSectionToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; outlineColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; outlineWidth?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; showOutline?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; cappingColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; cappingOpacity?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; showCapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event is fired when the tool's setState method is called and the new state is applied. The event * can be used to update of the UI. */ stateChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the DuplicateSvgElementTool constructor. */ interface $DuplicateSvgElementToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Parent node for new elements. */ parentNode?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines a list of nodes to be duplicated. */ nodeList?: | any[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when the duplicated nodes are created. */ nodesCreated?: ( oEvent: DuplicateSvgElementTool$NodesCreatedEvent ) => void; } /** * Describes the settings that can be provided to the ExplodeItemGroup constructor. */ interface $ExplodeItemGroupSettings extends sap.ui.core.$ElementSettings { name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; magnitudeAdjustmentMultiplier?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; items?: | sap.ui.vk.NodeProxy[] | sap.ui.vk.NodeProxy | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ExplodeTool constructor. */ interface $ExplodeToolSettings extends sap.ui.vk.tools.$ToolSettings { type?: | sap.ui.vk.tools.ExplodeType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; axis?: | sap.ui.vk.tools.ExplodeAxis | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; direction?: | sap.ui.vk.tools.ExplodeDirection | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; magnitude?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; anchor?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; items?: | sap.ui.vk.tools.ExplodeItemGroup[] | sap.ui.vk.tools.ExplodeItemGroup | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; selectedItem?: sap.ui.vk.tools.ExplodeItemGroup | string; axisSelected?: (oEvent: ExplodeTool$AxisSelectedEvent) => void; magnitudeChanging?: ( oEvent: ExplodeTool$MagnitudeChangingEvent ) => void; magnitudeChanged?: ( oEvent: ExplodeTool$MagnitudeChangedEvent ) => void; itemSequenceChangePressed?: ( oEvent: ExplodeTool$ItemSequenceChangePressedEvent ) => void; itemPositionAdjusting?: ( oEvent: ExplodeTool$ItemPositionAdjustingEvent ) => void; itemPositionAdjusted?: ( oEvent: ExplodeTool$ItemPositionAdjustedEvent ) => void; } /** * Describes the settings that can be provided to the Gizmo constructor. */ interface $GizmoSettings extends sap.ui.core.$ControlSettings {} /** * Describes the settings that can be provided to the HitTestTool constructor. */ interface $HitTestToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Indicates what schema the tool should use to extract IDs from hit objects */ IdMode?: | sap.ui.vk.tools.HitTestIdMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when 3D object is detected under hit position. */ hit?: (oEvent: HitTestTool$HitEvent) => void; } /** * Describes the settings that can be provided to the MoveTool constructor. */ interface $MoveToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom */ coordinateSystem?: | sap.ui.vk.tools.CoordinateSystem | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the placement mode. Can be Default, ObjectCenter, or Custom */ placementMode?: | sap.ui.vk.tools.GizmoPlacementMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` values will change in round number increments instead of continual change */ enableStepping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if snapping when moving is enabled */ enableSnapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if auto reset values mode is enabled */ autoResetValues?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not to allow context menu on right-click */ allowContextMenu?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determine what set of nodes will be transformed with this tool */ nodeSet?: | sap.ui.vk.tools.ToolNodeSet | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates */ moving?: (oEvent: MoveTool$MovingEvent) => void; /** * This event will be fired when movement finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates */ moved?: (oEvent: MoveTool$MovedEvent) => void; /** * This event will be fired when the coordinate system changes. */ coordinateSystemChanged?: ( oEvent: MoveTool$CoordinateSystemChangedEvent ) => void; placementModeChanged?: ( oEvent: MoveTool$PlacementModeChangedEvent ) => void; } /** * Describes the settings that can be provided to the PointCloudSelectionTool constructor. */ interface $PointCloudSelectionToolSettings extends sap.ui.vk.tools.$ToolSettings { selectionColor?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; groupAdded?: (oEvent: sap.ui.base.Event) => void; groupRemoved?: (oEvent: sap.ui.base.Event) => void; currentGroupChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the RectSelectTool constructor. */ interface $RectSelectToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * If set to true then this tool will remove selected nodes from the selection set. Default is to always * add them to the selection */ subtractMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineTool constructor. */ interface $RedlineToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Determines if elements editing is enabled */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The redline element/elements which will be rendered as soon as the redline tool is activated. */ redlineElements?: | sap.ui.vk.RedlineElement[] | sap.ui.vk.RedlineElement | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; elementCreated?: (oEvent: RedlineTool$ElementCreatedEvent) => void; elementClicked?: (oEvent: RedlineTool$ElementClickedEvent) => void; elementHovered?: (oEvent: RedlineTool$ElementHoveredEvent) => void; } /** * Describes the settings that can be provided to the RotateOrbitTool constructor. */ interface $RotateOrbitToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * This event will be fired when rotation occurs. */ rotate?: (oEvent: RotateOrbitTool$RotateEvent) => void; } /** * Describes the settings that can be provided to the RotateTool constructor. */ interface $RotateToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom */ coordinateSystem?: | sap.ui.vk.tools.CoordinateSystem | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls which axis are rotatable around. Can be All, X, Y, or Z */ axis?: | sap.ui.vk.tools.RotatableAxis | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` values will change in round number increments instead of continual change */ enableStepping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if snapping when rotating is enabled */ enableSnapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if auto reset values mode is enabled */ autoResetValues?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not to allow context menu on right-click */ allowContextMenu?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determine what set of nodes will be transformed with this tool */ nodeSet?: | sap.ui.vk.tools.ToolNodeSet | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the placement mode. Can be Default, ObjectCenter, or Custom */ placementMode?: | sap.ui.vk.tools.GizmoPlacementMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates */ rotating?: (oEvent: RotateTool$RotatingEvent) => void; /** * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates */ rotated?: (oEvent: RotateTool$RotatedEvent) => void; axisChanged?: (oEvent: RotateTool$AxisChangedEvent) => void; /** * This event will be fired when the coordinate system changes. */ coordinateSystemChanged?: ( oEvent: RotateTool$CoordinateSystemChangedEvent ) => void; placementModeChanged?: ( oEvent: RotateTool$PlacementModeChangedEvent ) => void; } /** * Describes the settings that can be provided to the RotateTurntableTool constructor. */ interface $RotateTurntableToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * This event will be fired when rotation occurs. */ rotate?: (oEvent: RotateTurntableTool$RotateEvent) => void; } /** * Describes the settings that can be provided to the ScaleTool constructor. */ interface $ScaleToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom */ coordinateSystem?: | sap.ui.vk.tools.CoordinateSystem | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` then this tool will enable scaling along a single axis, otherwise it will scale objects * along all three axes proportionally */ nonUniformScaleEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` values will change in round number increments instead of continual change */ enableStepping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enable snapping if set true */ enableSnapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Display text box with current value, which can also be used to directly modify the value */ showEditingUI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if auto reset values mode is enabled */ autoResetValues?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not to allow context menu on right-click */ allowContextMenu?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determine what set of nodes will be transformed with this tool */ nodeSet?: | sap.ui.vk.tools.ToolNodeSet | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the placement mode. Can be Default, ObjectCenter, or Custom */ placementMode?: | sap.ui.vk.tools.GizmoPlacementMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when scaling occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates */ scaling?: (oEvent: ScaleTool$ScalingEvent) => void; /** * This event will be fired when scaling finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates */ scaled?: (oEvent: ScaleTool$ScaledEvent) => void; /** * This event will be fired when the coordinate system changes. */ coordinateSystemChanged?: ( oEvent: ScaleTool$CoordinateSystemChangedEvent ) => void; placementModeChanged?: ( oEvent: ScaleTool$PlacementModeChangedEvent ) => void; } /** * Describes the settings that can be provided to the SceneOrientationTool constructor. */ interface $SceneOrientationToolSettings extends sap.ui.vk.tools.$ToolSettings { enablePredefinedViews?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; enableInitialView?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Tool constructor. */ interface $ToolSettings extends sap.ui.core.$ElementSettings { targetViewportType?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * GUID identifier for the tool to prevent naming conflicts. */ toolid?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Used to control the tool rendering and interaction pipeline. */ active?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Used to decide whether this tool should be enabled for the target viewport. */ footprint?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI */ gizmo?: sap.ui.vk.tools.Gizmo; /** * Control into which the gizmo is intended to render . */ gizmoContainer?: sap.ui.core.Control | string; enabled?: (oEvent: Tool$EnabledEvent) => void; } /** * Describes the settings that can be provided to the TooltipTool constructor. */ interface $TooltipToolSettings extends sap.ui.vk.tools.$ToolSettings { followCursor?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; animate?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; offsetX?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; offsetY?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; timeout?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when mouse hover occurs. */ hover?: (oEvent: TooltipTool$HoverEvent) => void; } /** * Describes the settings that can be provided to the TransformSvgElementTool constructor. */ interface $TransformSvgElementToolSettings extends sap.ui.vk.tools.$ToolSettings { /** * Determine what set of nodes will be transformed with this tool */ nodeSet?: | sap.ui.vk.tools.ToolNodeSet | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` then this tool will enable uniform scaling. */ uniformScaleEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event will be fired when movement occurs. */ moving?: (oEvent: TransformSvgElementTool$MovingEvent) => void; /** * This event will be fired when movement finished. */ moved?: (oEvent: TransformSvgElementTool$MovedEvent) => void; /** * This event will be fired when rotation occurs. */ rotating?: (oEvent: TransformSvgElementTool$RotatingEvent) => void; /** * This event will be fired when rotation finished. */ rotated?: (oEvent: TransformSvgElementTool$RotatedEvent) => void; /** * This event will be fired when scaling occurs. */ scaling?: (oEvent: TransformSvgElementTool$ScalingEvent) => void; /** * This event will be fired when scaling finished. */ scaled?: (oEvent: TransformSvgElementTool$ScaledEvent) => void; } /** * Parameters of the AnchorPointTool#moved event. */ interface AnchorPointTool$MovedEventParameters { x?: float; y?: float; z?: float; } /** * Parameters of the AnchorPointTool#moving event. */ interface AnchorPointTool$MovingEventParameters { x?: float; y?: float; z?: float; } /** * Parameters of the AnchorPointTool#rotated event. */ interface AnchorPointTool$RotatedEventParameters { x?: float; y?: float; z?: float; } /** * Parameters of the AnchorPointTool#rotating event. */ interface AnchorPointTool$RotatingEventParameters { x?: float; y?: float; z?: float; } /** * Parameters of the AxisAngleRotationTool#rotated event. */ interface AxisAngleRotationTool$RotatedEventParameters { nodesProperties?: object[]; } /** * Parameters of the AxisAngleRotationTool#rotating event. */ interface AxisAngleRotationTool$RotatingEventParameters { nodesProperties?: object[]; } /** * Parameters of the CreateEllipseTool#completed event. */ interface CreateEllipseTool$CompletedEventParameters { /** * Created node. * * node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid * node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric * object in parametrics array */ node?: any; /** * Request payload for a storage server to create a parametric primitive. */ request?: any; } /** * Parameters of the CreatePathTool#completed event. */ interface CreatePathTool$CompletedEventParameters { /** * Created node. * * node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid * node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric * object in parametrics array */ node?: any; /** * Request payload for a storage server to create a parametric primitive. */ request?: any; /** * Indicates whether the created path is closed. */ closed?: boolean; } /** * Parameters of the CreateRectangleTool#completed event. */ interface CreateRectangleTool$CompletedEventParameters { /** * Created node. * * node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid * node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric * object in parametrics array */ node?: any; /** * Request payload for a storage server to create a parametric primitive. */ request?: any; } /** * Parameters of the CreateTextTool#completed event. */ interface CreateTextTool$CompletedEventParameters { /** * Created node. * * node.sid - node's sid node.nodeContentType - node content type node.materialId - assigned material sid * node.name - node's name node.matrix - node transformation matrix node.parametric - index of created parametric * object in parametrics array */ node?: any; /** * Request payload for a storage server to create a parametric primitive. */ request?: any; } /** * Parameters of the CrossSectionTool#stateChanged event. */ interface CrossSectionTool$StateChangedEventParameters {} /** * Parameters of the DuplicateSvgElementTool#nodesCreated event. */ interface DuplicateSvgElementTool$NodesCreatedEventParameters { /** * Offset in x direction */ x?: float; /** * Offset in y direction */ y?: float; /** * Created nodes. */ nodes?: any[]; /** * Request payload for a storage server to create a parametric primitive. */ request?: object; } /** * Parameters of the ExplodeTool#axisSelected event. */ interface ExplodeTool$AxisSelectedEventParameters { axis?: sap.ui.vk.tools.ExplodeAxis; direction?: sap.ui.vk.tools.ExplodeDirection; } /** * Parameters of the ExplodeTool#itemPositionAdjusted event. */ interface ExplodeTool$ItemPositionAdjustedEventParameters { item?: sap.ui.vk.tools.ExplodeItemGroup; magnitudeAdjustmentMultiplier?: float; } /** * Parameters of the ExplodeTool#itemPositionAdjusting event. */ interface ExplodeTool$ItemPositionAdjustingEventParameters { item?: sap.ui.vk.tools.ExplodeItemGroup; magnitudeAdjustmentMultiplier?: float; } /** * Parameters of the ExplodeTool#itemSequenceChangePressed event. */ interface ExplodeTool$ItemSequenceChangePressedEventParameters { item?: sap.ui.vk.tools.ExplodeItemGroup; moveUp?: boolean; } /** * Parameters of the ExplodeTool#magnitudeChanged event. */ interface ExplodeTool$MagnitudeChangedEventParameters { type?: sap.ui.vk.tools.ExplodeType; axis?: sap.ui.vk.tools.ExplodeAxis; direction?: sap.ui.vk.tools.ExplodeDirection; magnitude?: float; } /** * Parameters of the ExplodeTool#magnitudeChanging event. */ interface ExplodeTool$MagnitudeChangingEventParameters { type?: sap.ui.vk.tools.ExplodeType; axis?: sap.ui.vk.tools.ExplodeAxis; direction?: sap.ui.vk.tools.ExplodeDirection; magnitude?: float; } /** * Parameters of the HitTestTool#hit event. */ interface HitTestTool$HitEventParameters { id?: any; object?: any; point?: any; clickType?: sap.ui.vk.tools.HitTestClickType; } /** * Parameters of the MoveTool#coordinateSystemChanged event. */ interface MoveTool$CoordinateSystemChangedEventParameters { coordinateSystem?: sap.ui.vk.tools.CoordinateSystem; } /** * Parameters of the MoveTool#moved event. */ interface MoveTool$MovedEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the MoveTool#moving event. */ interface MoveTool$MovingEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the MoveTool#placementModeChanged event. */ interface MoveTool$PlacementModeChangedEventParameters { placementMode?: sap.ui.vk.tools.GizmoPlacementMode; } /** * Parameters of the PointCloudSelectionTool#currentGroupChanged event. */ interface PointCloudSelectionTool$CurrentGroupChangedEventParameters {} /** * Parameters of the PointCloudSelectionTool#groupAdded event. */ interface PointCloudSelectionTool$GroupAddedEventParameters {} /** * Parameters of the PointCloudSelectionTool#groupRemoved event. */ interface PointCloudSelectionTool$GroupRemovedEventParameters {} /** * Parameters of the RedlineTool#elementClicked event. */ interface RedlineTool$ElementClickedEventParameters { elementId?: string; } /** * Parameters of the RedlineTool#elementCreated event. */ interface RedlineTool$ElementCreatedEventParameters { element?: object; } /** * Parameters of the RedlineTool#elementHovered event. */ interface RedlineTool$ElementHoveredEventParameters { elementId?: string; } /** * Parameters of the RotateOrbitTool#rotate event. */ interface RotateOrbitTool$RotateEventParameters { dx?: int; dy?: int; } /** * Parameters of the RotateTool#axisChanged event. */ interface RotateTool$AxisChangedEventParameters { axis?: sap.ui.vk.tools.RotatableAxis; } /** * Parameters of the RotateTool#coordinateSystemChanged event. */ interface RotateTool$CoordinateSystemChangedEventParameters { coordinateSystem?: sap.ui.vk.tools.CoordinateSystem; } /** * Parameters of the RotateTool#placementModeChanged event. */ interface RotateTool$PlacementModeChangedEventParameters { placementMode?: sap.ui.vk.tools.GizmoPlacementMode; } /** * Parameters of the RotateTool#rotated event. */ interface RotateTool$RotatedEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the RotateTool#rotating event. */ interface RotateTool$RotatingEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the RotateTurntableTool#rotate event. */ interface RotateTurntableTool$RotateEventParameters { dx?: int; dy?: int; } /** * Parameters of the ScaleTool#coordinateSystemChanged event. */ interface ScaleTool$CoordinateSystemChangedEventParameters { coordinateSystem?: sap.ui.vk.tools.CoordinateSystem; } /** * Parameters of the ScaleTool#placementModeChanged event. */ interface ScaleTool$PlacementModeChangedEventParameters { placementMode?: sap.ui.vk.tools.GizmoPlacementMode; } /** * Parameters of the ScaleTool#scaled event. */ interface ScaleTool$ScaledEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the ScaleTool#scaling event. */ interface ScaleTool$ScalingEventParameters { x?: float; y?: float; z?: float; nodesProperties?: any[]; } /** * Parameters of the Tool#enabled event. */ interface Tool$EnabledEventParameters { /** * Returns the true or false to indicated that the tool is enabled or not. This event is fired by the tool * under various conditions, including an attempt to set an activeViewport that is incompatible with the * tool. use getActive / setActive to turn the tool on or off */ enabled?: boolean; reason?: string; } /** * Parameters of the TooltipTool#hover event. */ interface TooltipTool$HoverEventParameters { x?: int; y?: int; nodeRef?: any; } /** * Parameters of the TransformSvgElementTool#moved event. */ interface TransformSvgElementTool$MovedEventParameters { x?: float; y?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} x - offset in x direction {float} y - offset in y direction */ nodesProperties?: any[]; } /** * Parameters of the TransformSvgElementTool#moving event. */ interface TransformSvgElementTool$MovingEventParameters { x?: float; y?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} x - offset in x direction {float} y - offset in y direction */ nodesProperties?: any[]; } /** * Parameters of the TransformSvgElementTool#rotated event. */ interface TransformSvgElementTool$RotatedEventParameters { angle?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} angle - angle of rotation */ nodesProperties?: any[]; } /** * Parameters of the TransformSvgElementTool#rotating event. */ interface TransformSvgElementTool$RotatingEventParameters { angle?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} angle - angle of rotation */ nodesProperties?: any[]; } /** * Parameters of the TransformSvgElementTool#scaled event. */ interface TransformSvgElementTool$ScaledEventParameters { x?: float; y?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} x - scale in x direction {float} y - scale in y direction */ nodesProperties?: any[]; } /** * Parameters of the TransformSvgElementTool#scaling event. */ interface TransformSvgElementTool$ScalingEventParameters { x?: float; y?: float; /** * Array of affected nodes properties. Each object contains following properties: {any} node - node reference * {float} x - scale in x direction {float} y - scale in y direction */ nodesProperties?: any[]; } /** * Tool used to define an anchor point and orientation in 3D space which can be used to rotate, move or * scale one or more selected objects */ class AnchorPointTool extends sap.ui.vk.tools.Tool { /** * Constructor for an AnchorPointTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$AnchorPointToolSettings ); /** * Constructor for an AnchorPointTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$AnchorPointToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.AnchorPointTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.AnchorPointTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Aligns the anchor point rotation to the object rotation. * * * @returns `this` to allow method chaining. */ alignTo( /** * The node reference or Matrix4. */ target: any ): this; /** * Aligns the anchor point rotation to the camera rotation. * * * @returns `this` to allow method chaining. */ alignToScreen(): this; /** * Aligns the anchor point rotation to the world coordinate system. * * * @returns `this` to allow method chaining. */ alignToWorld(): this; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when movement finished. * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * 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: AnchorPointTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when movement finished. * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * The function to be called when the event occurs */ fnFunction: (p1: AnchorPointTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when movement occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * 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: AnchorPointTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when movement occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * The function to be called when the event occurs */ fnFunction: (p1: AnchorPointTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when rotation finished. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * 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: AnchorPointTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when rotation finished. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * The function to be called when the event occurs */ fnFunction: (p1: AnchorPointTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * 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: AnchorPointTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AnchorPointTool`. * * 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.tools.AnchorPointTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * The function to be called when the event occurs */ fnFunction: (p1: AnchorPointTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AnchorPointTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moved moved} event of this `sap.ui.vk.tools.AnchorPointTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoved( /** * The function to be called, when the event occurs */ fnFunction: (p1: AnchorPointTool$MovedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moving moving} event of this `sap.ui.vk.tools.AnchorPointTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoving( /** * The function to be called, when the event occurs */ fnFunction: (p1: AnchorPointTool$MovingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AnchorPointTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotated( /** * The function to be called, when the event occurs */ fnFunction: (p1: AnchorPointTool$RotatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AnchorPointTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotating( /** * The function to be called, when the event occurs */ fnFunction: (p1: AnchorPointTool$RotatingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:moved moved} 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 */ fireMoved( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AnchorPointTool$MovedEventParameters ): this; /** * Fires event {@link #event:moving moving} 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 */ fireMoving( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AnchorPointTool$MovingEventParameters ): this; /** * Fires event {@link #event:rotated rotated} 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 */ fireRotated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AnchorPointTool$RotatedEventParameters ): this; /** * Fires event {@link #event:rotating rotating} 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 */ fireRotating( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AnchorPointTool$RotatingEventParameters ): this; /** * Gets current value of property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * Default value is `true`. * * * @returns Value of property `allowContextMenu` */ getAllowContextMenu(): boolean; /** * Gets current value of property {@link #getAllowOperation allowOperation}. * * Indicates the type of allowed operations * * Default value is `All`. * * * @returns Value of property `allowOperation` */ getAllowOperation(): sap.ui.vk.tools.AnchorPointToolOperation; /** * Gets current value of property {@link #getEnableStepping enableStepping}. * * If set to true values will change in round number increments instead of continual change * * Default value is `false`. * * * @returns Value of property `enableStepping` */ getEnableStepping(): boolean; /** * Gets current value of property {@link #getPosition position}. * * The anchor point tool position in the world coordinate system. This property is read-only. * * * @returns Value of property `position` */ getPosition(): any; /** * Gets current value of property {@link #getQuaternion quaternion}. * * The anchor point tool quaternion. This property is read-only. * * * @returns Value of property `quaternion` */ getQuaternion(): any; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * Performs movement of the anchor point. * * * @returns `this` to allow method chaining. */ move( /** * Movement offset along x axis. */ x?: float, /** * Movement offset along y axis. */ y?: float, /** * Movement offset along z axis. */ z?: float ): this; /** * Moves the anchor point to the center of objects or object's origin. * * * @returns `this` to allow method chaining. */ moveTo( /** * The node reference or the array of node references or Matrix4. */ target: any | any[], /** * Use the object's origin if true or the center of objects if false. */ useObjectsOrigin: boolean ): this; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Performs rotation of the anchor point. * * * @returns `this` to allow method chaining. */ rotate( /** * Rotation angle around x axis in degrees. */ x?: float, /** * Rotation angle around y axis in degrees. */ y?: float, /** * Rotation angle around z axis in degrees. */ z?: float ): this; /** * Sets a new value for property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowContextMenu( /** * New value for property `allowContextMenu` */ bAllowContextMenu?: boolean ): this; /** * Sets a new value for property {@link #getAllowOperation allowOperation}. * * Indicates the type of allowed operations * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `All`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowOperation( /** * New value for property `allowOperation` */ sAllowOperation?: sap.ui.vk.tools.AnchorPointToolOperation ): this; /** * Sets a new value for property {@link #getEnableStepping enableStepping}. * * If set to true values will change in round number increments instead of continual change * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepping( /** * New value for property `enableStepping` */ bEnableStepping?: boolean ): this; /** * Sets a new value for property {@link #getPosition position}. * * The anchor point tool position in the world coordinate system. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPosition( /** * New value for property `position` */ oPosition?: any ): this; /** * Sets a new value for property {@link #getQuaternion quaternion}. * * The anchor point tool quaternion. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setQuaternion( /** * New value for property `quaternion` */ oQuaternion?: any ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; } /** * Tool to rotate 3D objects in space */ class AxisAngleRotationTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new AxisAngleRotationTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$AxisAngleRotationToolSettings ); /** * Constructor for a new AxisAngleRotationTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$AxisAngleRotationToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.AxisAngleRotationTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vk.tools.AxisAngleRotationTool >, /** * 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.tools.AxisAngleRotationTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * 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.tools.AxisAngleRotationTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * 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: AxisAngleRotationTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AxisAngleRotationTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * 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.tools.AxisAngleRotationTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * The function to be called when the event occurs */ fnFunction: (p1: AxisAngleRotationTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AxisAngleRotationTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * 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.tools.AxisAngleRotationTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * 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: AxisAngleRotationTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AxisAngleRotationTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * 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.tools.AxisAngleRotationTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: * - `node: any` - A node reference. * - `angle: float` - An angle of rotation about the axis. * - `azimuth: float` - An azimuth of the axis of rotation in degrees in the parent's space. * - `elevation: float` - An elevation of the axis of rotation in degrees in the parent's space. * - `axis: float[]` - An axis of rotation in cartesian coordinates in the parent's space. An axis * of rotation in animation keys is stored in cartesian coordinates, in UI an axis of rotation is displayed * in polar coordinates using azimuth and elevation. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * The function to be called when the event occurs */ fnFunction: (p1: AxisAngleRotationTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.AxisAngleRotationTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotated( /** * The function to be called, when the event occurs */ fnFunction: (p1: AxisAngleRotationTool$RotatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.AxisAngleRotationTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotating( /** * The function to be called, when the event occurs */ fnFunction: (p1: AxisAngleRotationTool$RotatingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:rotated rotated} 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 */ fireRotated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AxisAngleRotationTool$RotatedEventParameters ): this; /** * Fires event {@link #event:rotating rotating} 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 */ fireRotating( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.AxisAngleRotationTool$RotatingEventParameters ): this; /** * Gets current value of property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * Default value is `true`. * * * @returns Value of property `allowContextMenu` */ getAllowContextMenu(): boolean; /** * Gets current value of property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when rotating is enabled * * Default value is `false`. * * * @returns Value of property `enableSnapping` */ getEnableSnapping(): boolean; /** * Gets current value of property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * Default value is `false`. * * * @returns Value of property `enableStepping` */ getEnableStepping(): boolean; /** * Gets current value of property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * Default value is `Highlight`. * * * @returns Value of property `nodeSet` */ getNodeSet(): sap.ui.vk.tools.ToolNodeSet; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowContextMenu( /** * New value for property `allowContextMenu` */ bAllowContextMenu?: boolean ): this; /** * Sets a new value for property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when rotating is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableSnapping( /** * New value for property `enableSnapping` */ bEnableSnapping?: boolean ): this; /** * Sets a new value for property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepping( /** * New value for property `enableStepping` */ bEnableStepping?: boolean ): this; /** * Sets a new value for property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeSet( /** * New value for property `nodeSet` */ sNodeSet?: sap.ui.vk.tools.ToolNodeSet ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; } /** * The CreateEllipseTool allows applications to create an ellipse/circle svg element. */ class CreateEllipseTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new CreateEllipseTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateEllipseToolSettings ); /** * Constructor for a new CreateEllipseTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateEllipseToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.CreateEllipseTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.CreateEllipseTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateEllipseTool`. * * 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.tools.CreateEllipseTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * 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: CreateEllipseTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateEllipseTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateEllipseTool`. * * 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.tools.CreateEllipseTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: CreateEllipseTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateEllipseTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateEllipseTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: CreateEllipseTool$CompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:completed completed} 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 */ fireCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.CreateEllipseTool$CompletedEventParameters ): this; /** * Gets current value of property {@link #getParentNode parentNode}. * * Parent node for new elements. * * * @returns Value of property `parentNode` */ getParentNode(): any; /** * Gets current value of property {@link #getUniformMode uniformMode}. * * Indicates that the tool creates a circle instead of an ellipse. * * Default value is `false`. * * * @returns Value of property `uniformMode` */ getUniformMode(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getParentNode parentNode}. * * Parent node for new elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setParentNode( /** * New value for property `parentNode` */ oParentNode?: any ): this; /** * Sets a new value for property {@link #getUniformMode uniformMode}. * * Indicates that the tool creates a circle instead of an ellipse. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setUniformMode( /** * New value for property `uniformMode` */ bUniformMode?: boolean ): this; } /** * The CreatePathTool allows applications to create a path svg element. */ class CreatePathTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new CreatePathTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreatePathToolSettings ); /** * Constructor for a new CreatePathTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreatePathToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.CreatePathTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.CreatePathTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreatePathTool`. * * 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.tools.CreatePathTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * 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: CreatePathTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreatePathTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreatePathTool`. * * 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.tools.CreatePathTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: CreatePathTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreatePathTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreatePathTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: CreatePathTool$CompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:completed completed} 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 */ fireCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.CreatePathTool$CompletedEventParameters ): this; /** * Gets current value of property {@link #getClosePath closePath}. * * Flag to always create closed path elements. * * Default value is `false`. * * * @returns Value of property `closePath` */ getClosePath(): boolean; /** * Gets current value of property {@link #getParentNode parentNode}. * * Parent node for new elements. * * * @returns Value of property `parentNode` */ getParentNode(): any; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getClosePath closePath}. * * Flag to always create closed path elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setClosePath( /** * New value for property `closePath` */ bClosePath?: boolean ): this; /** * Sets a new value for property {@link #getParentNode parentNode}. * * Parent node for new elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setParentNode( /** * New value for property `parentNode` */ oParentNode?: any ): this; } /** * The CreateRectangleTool allows applications to create a rectangle/square svg element. */ class CreateRectangleTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new CreateRectangleTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateRectangleToolSettings ); /** * Constructor for a new CreateRectangleTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateRectangleToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.CreateRectangleTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.CreateRectangleTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateRectangleTool`. * * 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.tools.CreateRectangleTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * 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: CreateRectangleTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateRectangleTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateRectangleTool`. * * 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.tools.CreateRectangleTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: CreateRectangleTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateRectangleTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateRectangleTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: CreateRectangleTool$CompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:completed completed} 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 */ fireCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.CreateRectangleTool$CompletedEventParameters ): this; /** * Gets current value of property {@link #getParentNode parentNode}. * * Parent node for the rectangle that will be created. * * * @returns Value of property `parentNode` */ getParentNode(): any; /** * Gets current value of property {@link #getUniformMode uniformMode}. * * Indicates that the tool creates a square instead of a rectangle. * * Default value is `false`. * * * @returns Value of property `uniformMode` */ getUniformMode(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getParentNode parentNode}. * * Parent node for the rectangle that will be created. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setParentNode( /** * New value for property `parentNode` */ oParentNode?: any ): this; /** * Sets a new value for property {@link #getUniformMode uniformMode}. * * Indicates that the tool creates a square instead of a rectangle. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setUniformMode( /** * New value for property `uniformMode` */ bUniformMode?: boolean ): this; } /** * The CreateTextTool allows applications to create a text svg element. */ class CreateTextTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new CreateTextTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateTextToolSettings ); /** * Constructor for a new CreateTextTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CreateTextToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.CreateTextTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.CreateTextTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateTextTool`. * * 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.tools.CreateTextTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * 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: CreateTextTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateTextTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateTextTool`. * * 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.tools.CreateTextTool` itself. * * Fired when a new element is created. * * * @returns Reference to `this` in order to allow method chaining */ attachCompleted( /** * The function to be called when the event occurs */ fnFunction: (p1: CreateTextTool$CompletedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CreateTextTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:completed completed} event of this `sap.ui.vk.tools.CreateTextTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCompleted( /** * The function to be called, when the event occurs */ fnFunction: (p1: CreateTextTool$CompletedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:completed completed} 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 */ fireCompleted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.CreateTextTool$CompletedEventParameters ): this; /** * Gets current value of property {@link #getFontFace fontFace}. * * Font face * * Default value is `"Verdana,Arial,Helvetica,sans-serif"`. * * * @returns Value of property `fontFace` */ getFontFace(): string; /** * Gets current value of property {@link #getFontSize fontSize}. * * Font size * * Default value is `"14"`. * * * @returns Value of property `fontSize` */ getFontSize(): string; /** * Gets current value of property {@link #getParentNode parentNode}. * * Parent node for new elements. * * * @returns Value of property `parentNode` */ getParentNode(): any; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getFontFace fontFace}. * * Font face * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Verdana,Arial,Helvetica,sans-serif"`. * * * @returns Reference to `this` in order to allow method chaining */ setFontFace( /** * New value for property `fontFace` */ sFontFace?: string ): this; /** * Sets a new value for property {@link #getFontSize fontSize}. * * Font size * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"14"`. * * * @returns Reference to `this` in order to allow method chaining */ setFontSize( /** * New value for property `fontSize` */ sFontSize?: string ): this; /** * Sets a new value for property {@link #getParentNode parentNode}. * * Parent node for new elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setParentNode( /** * New value for property `parentNode` */ oParentNode?: any ): this; } /** * The CrossSection tool can be used to cut all 3D objects along one of three spatial axis to expose their * internal structures. */ class CrossSectionTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new CrossSectionTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CrossSectionToolSettings ); /** * Constructor for a new CrossSectionTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$CrossSectionToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.CrossSectionTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.CrossSectionTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`. * * 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.tools.CrossSectionTool` itself. * * This event is fired when the tool's setState method is called and the new state is applied. The event * can be used to update of the UI. * * * @returns Reference to `this` in order to allow method chaining */ attachStateChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CrossSectionTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`. * * 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.tools.CrossSectionTool` itself. * * This event is fired when the tool's setState method is called and the new state is applied. The event * can be used to update of the UI. * * * @returns Reference to `this` in order to allow method chaining */ attachStateChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.CrossSectionTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.tools.CrossSectionTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachStateChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:stateChanged stateChanged} 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 */ fireStateChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets the clipping plane axis. * * * @returns Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z. */ getAxis(): number; /** * Gets current value of property {@link #getCappingColor cappingColor}. * * Default value is `"#ff0000"`. * * * @returns Value of property `cappingColor` */ getCappingColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getCappingOpacity cappingOpacity}. * * Default value is `0.9`. * * * @returns Value of property `cappingOpacity` */ getCappingOpacity(): float; /** * Gets current value of property {@link #getOutlineColor outlineColor}. * * Default value is `"#000000"`. * * * @returns Value of property `outlineColor` */ getOutlineColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getOutlineWidth outlineWidth}. * * Default value is `2`. * * * @returns Value of property `outlineWidth` */ getOutlineWidth(): float; /** * Gets current value of property {@link #getShowCapping showCapping}. * * Default value is `true`. * * * @returns Value of property `showCapping` */ getShowCapping(): boolean; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * Gets current value of property {@link #getShowOutline showOutline}. * * Default value is `true`. * * * @returns Value of property `showOutline` */ getShowOutline(): 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. * * * @returns this */ queueCommand( /** * The command to be executed. */ command: Function ): sap.ui.vk.Viewport; /** * Sets the clipping plane axis. * * * @returns `this` to allow method chaining. */ setAxis( /** * Axis index from 0 to 2: 0 - X, 1 - Y, 2 - Z. */ index?: number ): this; /** * Sets a new value for property {@link #getCappingColor cappingColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"#ff0000"`. * * * @returns Reference to `this` in order to allow method chaining */ setCappingColor( /** * New value for property `cappingColor` */ sCappingColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getCappingOpacity cappingOpacity}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.9`. * * * @returns Reference to `this` in order to allow method chaining */ setCappingOpacity( /** * New value for property `cappingOpacity` */ fCappingOpacity?: float ): this; /** * Flips the clipping plane. * * * @returns `this` to allow method chaining. */ setFlip( /** * If set to `true`, the clipping plane will be flipped. */ flip?: boolean ): this; /** * Sets a new value for property {@link #getOutlineColor outlineColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"#000000"`. * * * @returns Reference to `this` in order to allow method chaining */ setOutlineColor( /** * New value for property `outlineColor` */ sOutlineColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getOutlineWidth outlineWidth}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `2`. * * * @returns Reference to `this` in order to allow method chaining */ setOutlineWidth( /** * New value for property `outlineWidth` */ fOutlineWidth?: float ): this; /** * Sets a new value for property {@link #getShowCapping showCapping}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowCapping( /** * New value for property `showCapping` */ bShowCapping?: boolean ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; /** * Sets a new value for property {@link #getShowOutline showOutline}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowOutline( /** * New value for property `showOutline` */ bShowOutline?: 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 color of the outline defined as a CSS color string. */ outlineColor?: string; /** * The width of the outline defined as a float. */ outlineWidth?: number; /** * Specifies whether the outline should be shown. */ showOutline?: boolean; /** * The color of the capping defined as a CSS color string. */ cappingColor?: string; /** * The opacity of the capping defined as a float between 0 and 1. */ cappingOpacity?: number; /** * Specifies whether the capping should be shown. */ showCapping?: boolean; /** * Specifies whether the editing UI should be shown. */ showEditingUI?: boolean; }, /** * The viewport where the tool is used. */ viewport?: sap.ui.vk.Viewport ): this; } /** * The DuplicateSvgElementTool allows applications to duplicate svg elements. */ class DuplicateSvgElementTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new DuplicateSvgElementTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$DuplicateSvgElementToolSettings ); /** * Constructor for a new DuplicateSvgElementTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$DuplicateSvgElementToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.DuplicateSvgElementTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vk.tools.DuplicateSvgElementTool >, /** * 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.tools.DuplicateSvgElementTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:nodesCreated nodesCreated} event of this `sap.ui.vk.tools.DuplicateSvgElementTool`. * * 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.tools.DuplicateSvgElementTool` itself. * * Fired when the duplicated nodes are created. * * * @returns Reference to `this` in order to allow method chaining */ attachNodesCreated( /** * 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: DuplicateSvgElementTool$NodesCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.DuplicateSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodesCreated nodesCreated} event of this `sap.ui.vk.tools.DuplicateSvgElementTool`. * * 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.tools.DuplicateSvgElementTool` itself. * * Fired when the duplicated nodes are created. * * * @returns Reference to `this` in order to allow method chaining */ attachNodesCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: DuplicateSvgElementTool$NodesCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.DuplicateSvgElementTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodesCreated nodesCreated} event of this `sap.ui.vk.tools.DuplicateSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodesCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: DuplicateSvgElementTool$NodesCreatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:nodesCreated nodesCreated} 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 */ fireNodesCreated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.DuplicateSvgElementTool$NodesCreatedEventParameters ): this; /** * Gets current value of property {@link #getNodeList nodeList}. * * Defines a list of nodes to be duplicated. * * Default value is `[]`. * * * @returns Value of property `nodeList` */ getNodeList(): any[]; /** * Gets current value of property {@link #getParentNode parentNode}. * * Parent node for new elements. * * * @returns Value of property `parentNode` */ getParentNode(): any; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getNodeList nodeList}. * * Defines a list of nodes to be duplicated. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeList( /** * New value for property `nodeList` */ sNodeList?: any[] ): this; /** * Sets a new value for property {@link #getParentNode parentNode}. * * Parent node for new elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setParentNode( /** * New value for property `parentNode` */ oParentNode?: any ): this; } /** * Aggregation element for the output settings of the Viewport * * @since 1.82.0 */ class ExplodeItemGroup extends sap.ui.core.Element { /** * Constructor for a new ExplodeItemGroup. * * 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?: sap.ui.vk.tools.$ExplodeItemGroupSettings ); /** * Constructor for a new ExplodeItemGroup. * * 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?: sap.ui.vk.tools.$ExplodeItemGroupSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.ExplodeItemGroup 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.ExplodeItemGroup. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: sap.ui.vk.NodeProxy ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Gets content of aggregation {@link #getItems items}. */ getItems(): sap.ui.vk.NodeProxy[]; /** * Gets current value of property {@link #getMagnitudeAdjustmentMultiplier magnitudeAdjustmentMultiplier}. * * Default value is `0.0`. * * * @returns Value of property `magnitudeAdjustmentMultiplier` */ getMagnitudeAdjustmentMultiplier(): float; /** * Gets current value of property {@link #getName name}. * * * @returns Value of property `name` */ getName(): string; /** * Checks for the provided `sap.ui.vk.NodeProxy` in the aggregation {@link #getItems items}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: sap.ui.vk.NodeProxy ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: sap.ui.vk.NodeProxy, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): sap.ui.vk.NodeProxy[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | sap.ui.vk.NodeProxy ): sap.ui.vk.NodeProxy | null; /** * Sets a new value for property {@link #getMagnitudeAdjustmentMultiplier magnitudeAdjustmentMultiplier}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setMagnitudeAdjustmentMultiplier( /** * New value for property `magnitudeAdjustmentMultiplier` */ fMagnitudeAdjustmentMultiplier?: float ): this; /** * Sets a new value for property {@link #getName name}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; } /** * Tool used to move objects in 3D space */ class ExplodeTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new ExplodeTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ExplodeToolSettings ); /** * Constructor for a new ExplodeTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ExplodeToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.ExplodeTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.ExplodeTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: sap.ui.vk.tools.ExplodeItemGroup ): this; /** * Attaches event handler `fnFunction` to the {@link #event:axisSelected axisSelected} event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachAxisSelected( /** * 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: ExplodeTool$AxisSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:axisSelected axisSelected} event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachAxisSelected( /** * The function to be called when the event occurs */ fnFunction: (p1: ExplodeTool$AxisSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPositionAdjusted itemPositionAdjusted} event * of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPositionAdjusted( /** * 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: ExplodeTool$ItemPositionAdjustedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPositionAdjusted itemPositionAdjusted} event * of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPositionAdjusted( /** * The function to be called when the event occurs */ fnFunction: (p1: ExplodeTool$ItemPositionAdjustedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPositionAdjusting itemPositionAdjusting } * event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPositionAdjusting( /** * 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: ExplodeTool$ItemPositionAdjustingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPositionAdjusting itemPositionAdjusting } * event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPositionAdjusting( /** * The function to be called when the event occurs */ fnFunction: (p1: ExplodeTool$ItemPositionAdjustingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSequenceChangePressed itemSequenceChangePressed } * event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSequenceChangePressed( /** * 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: ExplodeTool$ItemSequenceChangePressedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSequenceChangePressed itemSequenceChangePressed } * event of this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSequenceChangePressed( /** * The function to be called when the event occurs */ fnFunction: ( p1: ExplodeTool$ItemSequenceChangePressedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:magnitudeChanged magnitudeChanged} event of * this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachMagnitudeChanged( /** * 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: ExplodeTool$MagnitudeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:magnitudeChanged magnitudeChanged} event of * this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachMagnitudeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ExplodeTool$MagnitudeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:magnitudeChanging magnitudeChanging} event of * this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachMagnitudeChanging( /** * 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: ExplodeTool$MagnitudeChangingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:magnitudeChanging magnitudeChanging} event of * this `sap.ui.vk.tools.ExplodeTool`. * * 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.tools.ExplodeTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachMagnitudeChanging( /** * The function to be called when the event occurs */ fnFunction: (p1: ExplodeTool$MagnitudeChangingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ExplodeTool` itself */ oListener?: object ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:axisSelected axisSelected} event of this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAxisSelected( /** * The function to be called, when the event occurs */ fnFunction: (p1: ExplodeTool$AxisSelectedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemPositionAdjusted itemPositionAdjusted } * event of this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemPositionAdjusted( /** * The function to be called, when the event occurs */ fnFunction: (p1: ExplodeTool$ItemPositionAdjustedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemPositionAdjusting itemPositionAdjusting } * event of this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemPositionAdjusting( /** * The function to be called, when the event occurs */ fnFunction: (p1: ExplodeTool$ItemPositionAdjustingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemSequenceChangePressed itemSequenceChangePressed } * event of this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemSequenceChangePressed( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ExplodeTool$ItemSequenceChangePressedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:magnitudeChanged magnitudeChanged} event of * this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMagnitudeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ExplodeTool$MagnitudeChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:magnitudeChanging magnitudeChanging} event * of this `sap.ui.vk.tools.ExplodeTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMagnitudeChanging( /** * The function to be called, when the event occurs */ fnFunction: (p1: ExplodeTool$MagnitudeChangingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:axisSelected axisSelected} 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 */ fireAxisSelected( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$AxisSelectedEventParameters ): this; /** * Fires event {@link #event:itemPositionAdjusted itemPositionAdjusted} 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 */ fireItemPositionAdjusted( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$ItemPositionAdjustedEventParameters ): this; /** * Fires event {@link #event:itemPositionAdjusting itemPositionAdjusting} 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 */ fireItemPositionAdjusting( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$ItemPositionAdjustingEventParameters ): this; /** * Fires event {@link #event:itemSequenceChangePressed itemSequenceChangePressed} 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 */ fireItemSequenceChangePressed( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$ItemSequenceChangePressedEventParameters ): this; /** * Fires event {@link #event:magnitudeChanged magnitudeChanged} 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 */ fireMagnitudeChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$MagnitudeChangedEventParameters ): this; /** * Fires event {@link #event:magnitudeChanging magnitudeChanging} 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 */ fireMagnitudeChanging( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ExplodeTool$MagnitudeChangingEventParameters ): this; /** * Gets current value of property {@link #getAnchor anchor}. * * Default value is `[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]`. * * * @returns Value of property `anchor` */ getAnchor(): float[]; /** * Gets current value of property {@link #getAxis axis}. * * * @returns Value of property `axis` */ getAxis(): sap.ui.vk.tools.ExplodeAxis; /** * Gets current value of property {@link #getDirection direction}. * * * @returns Value of property `direction` */ getDirection(): sap.ui.vk.tools.ExplodeDirection; /** * Gets content of aggregation {@link #getItems items}. */ getItems(): sap.ui.vk.tools.ExplodeItemGroup[]; /** * Gets current value of property {@link #getMagnitude magnitude}. * * Default value is `0.0`. * * * @returns Value of property `magnitude` */ getMagnitude(): float; /** * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, * or `null`. */ getSelectedItem(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getType type}. * * Default value is `Linear`. * * * @returns Value of property `type` */ getType(): sap.ui.vk.tools.ExplodeType; /** * Checks for the provided `sap.ui.vk.tools.ExplodeItemGroup` in the aggregation {@link #getItems items}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: sap.ui.vk.tools.ExplodeItemGroup ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: sap.ui.vk.tools.ExplodeItemGroup, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): sap.ui.vk.tools.ExplodeItemGroup[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | sap.ui.vk.tools.ExplodeItemGroup ): sap.ui.vk.tools.ExplodeItemGroup | null; /** * Sets a new value for property {@link #getAnchor anchor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]`. * * * @returns Reference to `this` in order to allow method chaining */ setAnchor( /** * New value for property `anchor` */ sAnchor?: float[] ): this; /** * Sets a new value for property {@link #getAxis axis}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setAxis( /** * New value for property `axis` */ sAxis: sap.ui.vk.tools.ExplodeAxis ): this; /** * Sets a new value for property {@link #getDirection direction}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDirection( /** * New value for property `direction` */ sDirection: sap.ui.vk.tools.ExplodeDirection ): this; /** * Sets a new value for property {@link #getMagnitude magnitude}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setMagnitude( /** * New value for property `magnitude` */ fMagnitude?: float ): this; /** * Sets the associated {@link #getSelectedItem selectedItem}. * * * @returns Reference to `this` in order to allow method chaining */ setSelectedItem( /** * ID of an element which becomes the new target of this selectedItem association; alternatively, an element * instance may be given */ oSelectedItem: sap.ui.core.ID | sap.ui.vk.tools.ExplodeItemGroup ): this; /** * Sets a new value for property {@link #getType type}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Linear`. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType?: sap.ui.vk.tools.ExplodeType ): this; } /** * Provides buttons to hide or show certain sap.ui.vk controls. */ class Gizmo extends sap.ui.core.Control { /** * Constructor for base of all Gizmo Controls. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.vk.tools.$GizmoSettings ); /** * Constructor for base of all Gizmo Controls. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Control#constructor sap.ui.core.Control } * can be used. */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.vk.tools.$GizmoSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.Gizmo 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.Gizmo. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * When user clicks/taps inside of 3D Viewport this tool can be used to find if there is an object at this * point */ class HitTestTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new HitTestTool tool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$HitTestToolSettings ); /** * Constructor for a new HitTestTool tool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$HitTestToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.HitTestTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.HitTestTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:hit hit} event of this `sap.ui.vk.tools.HitTestTool`. * * 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.tools.HitTestTool` itself. * * This event will be fired when 3D object is detected under hit position. * * * @returns Reference to `this` in order to allow method chaining */ attachHit( /** * 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: HitTestTool$HitEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.HitTestTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hit hit} event of this `sap.ui.vk.tools.HitTestTool`. * * 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.tools.HitTestTool` itself. * * This event will be fired when 3D object is detected under hit position. * * * @returns Reference to `this` in order to allow method chaining */ attachHit( /** * The function to be called when the event occurs */ fnFunction: (p1: HitTestTool$HitEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.HitTestTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:hit hit} event of this `sap.ui.vk.tools.HitTestTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHit( /** * The function to be called, when the event occurs */ fnFunction: (p1: HitTestTool$HitEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:hit hit} 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 */ fireHit( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.HitTestTool$HitEventParameters ): this; /** * Gets current value of property {@link #getIdMode IdMode}. * * Indicates what schema the tool should use to extract IDs from hit objects * * Default value is `ThreeJS`. * * * @returns Value of property `IdMode` */ getIdMode(): sap.ui.vk.tools.HitTestIdMode; /** * Figure out which helper is needed and execute hit test * * * @returns Structure with hit object, its id and screen point where hit test is performed. Null if hit * test didn't detect any object. */ hitTest( /** * The tap gesture's x-coordinate. */ x: int, /** * The tap gesture's y-coordinate. */ y: int, /** * Scene object used in current viewport. */ scene: sap.ui.vk.Scene, /** * Current viewport's camera. */ camera: sap.ui.vk.Camera, /** * One of predefined click types, this is passed to the hit event */ clickType: sap.ui.vk.tools.HitTestClickType ): any; /** * Queues a command for execution during the rendering cycle. All gesture operations should be called using * this method. * * * @returns this */ queueCommand( /** * The command to be executed. */ command: Function ): sap.ui.vk.Viewport; /** * Sets a new value for property {@link #getIdMode IdMode}. * * Indicates what schema the tool should use to extract IDs from hit objects * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `ThreeJS`. * * * @returns Reference to `this` in order to allow method chaining */ setIdMode( /** * New value for property `IdMode` */ sIdMode?: sap.ui.vk.tools.HitTestIdMode ): this; } /** * Tool used to move objects in 3D space */ class MoveTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new MoveTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$MoveToolSettings ); /** * Constructor for a new MoveTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$MoveToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.MoveTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.MoveTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * 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: MoveTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: MoveTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when movement finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * 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: MoveTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when movement finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * The function to be called when the event occurs */ fnFunction: (p1: MoveTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * 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: MoveTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * This event will be fired when movement occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * translate relative to rest position in local coordinates {float[]} offsetToPrevious, translate relative * to end position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, translate in parent coordinates {float[]} world, translate in world coordinates {float[]} restDifference, * change of rest position translation in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position translation in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * The function to be called when the event occurs */ fnFunction: (p1: MoveTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * 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: MoveTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.MoveTool`. * * 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.tools.MoveTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: MoveTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.MoveTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.MoveTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCoordinateSystemChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: MoveTool$CoordinateSystemChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moved moved} event of this `sap.ui.vk.tools.MoveTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoved( /** * The function to be called, when the event occurs */ fnFunction: (p1: MoveTool$MovedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moving moving} event of this `sap.ui.vk.tools.MoveTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoving( /** * The function to be called, when the event occurs */ fnFunction: (p1: MoveTool$MovingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:placementModeChanged placementModeChanged } * event of this `sap.ui.vk.tools.MoveTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPlacementModeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: MoveTool$PlacementModeChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:coordinateSystemChanged coordinateSystemChanged} 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 */ fireCoordinateSystemChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.MoveTool$CoordinateSystemChangedEventParameters ): this; /** * Fires event {@link #event:moved moved} 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 */ fireMoved( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.MoveTool$MovedEventParameters ): this; /** * Fires event {@link #event:moving moving} 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 */ fireMoving( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.MoveTool$MovingEventParameters ): this; /** * Fires event {@link #event:placementModeChanged placementModeChanged} 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 */ firePlacementModeChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.MoveTool$PlacementModeChangedEventParameters ): this; /** * Gets current value of property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * Default value is `true`. * * * @returns Value of property `allowContextMenu` */ getAllowContextMenu(): boolean; /** * Gets current value of property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * Default value is `true`. * * * @returns Value of property `autoResetValues` */ getAutoResetValues(): boolean; /** * Gets current value of property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * Default value is `World`. * * * @returns Value of property `coordinateSystem` */ getCoordinateSystem(): sap.ui.vk.tools.CoordinateSystem; /** * Gets current value of property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when moving is enabled * * Default value is `false`. * * * @returns Value of property `enableSnapping` */ getEnableSnapping(): boolean; /** * Gets current value of property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * Default value is `false`. * * * @returns Value of property `enableStepping` */ getEnableStepping(): boolean; /** * Gets current value of property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * Default value is `Highlight`. * * * @returns Value of property `nodeSet` */ getNodeSet(): sap.ui.vk.tools.ToolNodeSet; /** * Gets current value of property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * Default value is `ObjectCenter`. * * * @returns Value of property `placementMode` */ getPlacementMode(): sap.ui.vk.tools.GizmoPlacementMode; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * Performs movement of selected objects. * * * @returns `this` to allow method chaining. */ move( /** * Movement offset of x component in currently selected coordinate system. */ x: float, /** * Movement offset of y component in currently selected coordinate system. */ y: float, /** * Movement offset of z component in currently selected coordinate system. */ z: float, /** * Optional parameter to define coordinate system to be used when these coordinates are applied. If not * specified then currently set coordinate system will be used. */ coordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowContextMenu( /** * New value for property `allowContextMenu` */ bAllowContextMenu?: boolean ): this; /** * Sets a new value for property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoResetValues( /** * New value for property `autoResetValues` */ bAutoResetValues?: boolean ): this; /** * Sets a new value for property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `World`. * * * @returns Reference to `this` in order to allow method chaining */ setCoordinateSystem( /** * New value for property `coordinateSystem` */ sCoordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * Sets a new value for property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when moving is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableSnapping( /** * New value for property `enableSnapping` */ bEnableSnapping?: boolean ): this; /** * Sets a new value for property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepping( /** * New value for property `enableStepping` */ bEnableStepping?: boolean ): this; /** * Sets a new value for property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeSet( /** * New value for property `nodeSet` */ sNodeSet?: sap.ui.vk.tools.ToolNodeSet ): this; /** * Sets a new value for property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `ObjectCenter`. * * * @returns Reference to `this` in order to allow method chaining */ setPlacementMode( /** * New value for property `placementMode` */ sPlacementMode?: sap.ui.vk.tools.GizmoPlacementMode ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; } /** * Tool used to select points * * @since 1.118.0 */ class PointCloudSelectionTool extends sap.ui.vk.tools.Tool { /** * Constructor for a PointCloudSelectionTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$PointCloudSelectionToolSettings ); /** * Constructor for a PointCloudSelectionTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$PointCloudSelectionToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.PointCloudSelectionTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vk.tools.PointCloudSelectionTool >, /** * 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.tools.PointCloudSelectionTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:currentGroupChanged currentGroupChanged} event * of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCurrentGroupChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:currentGroupChanged currentGroupChanged} event * of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachCurrentGroupChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:groupAdded groupAdded} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachGroupAdded( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:groupAdded groupAdded} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachGroupAdded( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:groupRemoved groupRemoved} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachGroupRemoved( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:groupRemoved groupRemoved} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * 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.tools.PointCloudSelectionTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachGroupRemoved( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.PointCloudSelectionTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:currentGroupChanged currentGroupChanged} event * of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCurrentGroupChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:groupAdded groupAdded} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachGroupAdded( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:groupRemoved groupRemoved} event of this `sap.ui.vk.tools.PointCloudSelectionTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachGroupRemoved( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:currentGroupChanged currentGroupChanged} 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 */ fireCurrentGroupChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:groupAdded groupAdded} 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 */ fireGroupAdded( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:groupRemoved groupRemoved} 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 */ fireGroupRemoved( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getSelectionColor selectionColor}. * * Default value is `[0, 1, 0, 1]`. * * * @returns Value of property `selectionColor` */ getSelectionColor(): float[]; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getSelectionColor selectionColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[0, 1, 0, 1]`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionColor( /** * New value for property `selectionColor` */ sSelectionColor?: float[] ): this; } /** * This tool provides rectangular selection */ class RectSelectTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new RectSelectTool tool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RectSelectToolSettings ); /** * Constructor for a new RectSelectTool tool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RectSelectToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.RectSelectTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.RectSelectTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getSubtractMode subtractMode}. * * If set to true then this tool will remove selected nodes from the selection set. Default is to always * add them to the selection * * Default value is `false`. * * * @returns Value of property `subtractMode` */ getSubtractMode(): boolean; /** * Find all objects fully contained inside of specified rectangle * * * @returns The array of node references that are selected. */ select( /** * x coordinate of top-left/bottom-right corner of selection rectangle. */ x1: int, /** * y coordinate of top-left/bottom-right corner of selection rectangle. */ y1: int, /** * x coordinate of bottom-right/top-left corner of selection rectangle. */ x2: int, /** * y coordinate of bottom-right/top-left corner of selection rectangle. */ y2: int, /** * Scene object used in current viewport. */ scene: sap.ui.vk.Scene, /** * Current viewport's camera. */ camera: sap.ui.vk.Camera ): any[]; /** * Sets a new value for property {@link #getSubtractMode subtractMode}. * * If set to true then this tool will remove selected nodes from the selection set. Default is to always * add them to the selection * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSubtractMode( /** * New value for property `subtractMode` */ bSubtractMode?: boolean ): this; } /** * The RedlineTool allows applications to display custom tooltip text on top of 3D object over which pointer * is hovering */ class RedlineTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new RedlineTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RedlineToolSettings ); /** * Constructor for a new RedlineTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RedlineToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.RedlineTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.RedlineTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some redlineElement to the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ addRedlineElement( /** * The redlineElement to add; if empty, nothing is inserted */ oRedlineElement: sap.ui.vk.RedlineElement ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementClicked( /** * 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: RedlineTool$ElementClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineTool$ElementClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * 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: RedlineTool$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineTool$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementHovered( /** * 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: RedlineTool$ElementHoveredEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.tools.RedlineTool`. * * 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.tools.RedlineTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementHovered( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineTool$ElementHoveredEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RedlineTool` itself */ oListener?: object ): this; /** * Destroys all the redlineElements in the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRedlineElements(): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.tools.RedlineTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineTool$ElementClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.tools.RedlineTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineTool$ElementCreatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.tools.RedlineTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementHovered( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineTool$ElementHoveredEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Exports all the current redline elements as an array of JSON objects. * * * @returns An array of JSON objects. */ exportJSON(): object[]; /** * Exports all the current redline elements as an array of SVG objects. * * * @returns An array of SVG objects. */ exportSVG(): object[]; /** * Fires event {@link #event:elementClicked elementClicked} 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 */ fireElementClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RedlineTool$ElementClickedEventParameters ): this; /** * Fires event {@link #event:elementCreated elementCreated} 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 */ fireElementCreated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RedlineTool$ElementCreatedEventParameters ): this; /** * Fires event {@link #event:elementHovered elementHovered} 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 */ fireElementHovered( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RedlineTool$ElementHoveredEventParameters ): this; /** * Gets current value of property {@link #getEditable editable}. * * Determines if elements editing is enabled * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets content of aggregation {@link #getRedlineElements redlineElements}. * * The redline element/elements which will be rendered as soon as the redline tool is activated. */ getRedlineElements(): sap.ui.vk.RedlineElement[]; /** * Iterates through all JSON objects from the array passed as parameter, and creates and restores the redline * elements serialized in the array. * * * @returns `this` to allow method chaining. */ importJSON( /** * An array of serialized redline elements. */ jsonElements: object[] ): this; /** * Iterates through all SVG objects from the array passed as parameter, and creates and restores the redline * elements in the array. * * * @returns `this` to allow method chaining. */ importSVG( /** * An array of redline elements in SVG format. */ svg: object[] ): this; /** * Checks for the provided `sap.ui.vk.RedlineElement` in the aggregation {@link #getRedlineElements redlineElements}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRedlineElement( /** * The redlineElement whose index is looked for */ oRedlineElement: sap.ui.vk.RedlineElement ): int; /** * Inserts a redlineElement into the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ insertRedlineElement( /** * The redlineElement to insert; if empty, nothing is inserted */ oRedlineElement: sap.ui.vk.RedlineElement, /** * The `0`-based index the redlineElement should be inserted at; for a negative value of `iIndex`, the redlineElement * is inserted at position 0; for a value greater than the current size of the aggregation, the redlineElement * is inserted at the last position */ iIndex: int ): this; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Removes all the controls from the aggregation {@link #getRedlineElements redlineElements}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRedlineElements(): sap.ui.vk.RedlineElement[]; /** * Removes a redlineElement from the aggregation {@link #getRedlineElements redlineElements}. * * * @returns The removed redlineElement or `null` */ removeRedlineElement( /** * The redlineElement to remove or its index or id */ vRedlineElement: int | string | sap.ui.vk.RedlineElement ): sap.ui.vk.RedlineElement | null; /** * Sets a new value for property {@link #getEditable editable}. * * Determines if elements editing is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Prepares the RedlineTool control for adding a new instance of {sap.ui.vk.RedlineElement}. * * * @returns `this` to allow method chaining. */ startAdding( /** * The redlining element which needs to be added. */ elementInstance: sap.ui.vk.RedlineElement ): this; /** * Stops the mode for adding redlining, which begins when the {@link sap.ui.vk.RedlineTool#startAdding startAdding } * method is called. * * * @returns `this` to allow method chaining. */ stopAdding(): this; } /** * Tool to rotate scene in orbit mode */ class RotateOrbitTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new RotateOrbitTool tool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateOrbitToolSettings ); /** * Constructor for a new RotateOrbitTool tool. * * 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 of the new content resource. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateOrbitToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.RotateOrbitTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.RotateOrbitTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateOrbitTool`. * * 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.tools.RotateOrbitTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * 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: RotateOrbitTool$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateOrbitTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateOrbitTool`. * * 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.tools.RotateOrbitTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateOrbitTool$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateOrbitTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateOrbitTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotate( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateOrbitTool$RotateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:rotate rotate} 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 */ fireRotate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateOrbitTool$RotateEventParameters ): this; /** * Executes Orbit rotation for the target Viewport. */ rotate( /** * The change in x-coordinate used to define the desired rotation. */ dx: int, /** * The change in y-coordinate used to define the desired rotation. */ dy: int ): void; } /** * Tool to rotate 3D objects in space */ class RotateTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new RotateTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateToolSettings ); /** * Constructor for a new RotateTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.RotateTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.RotateTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:axisChanged axisChanged} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachAxisChanged( /** * 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: RotateTool$AxisChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:axisChanged axisChanged} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachAxisChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTool$AxisChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * 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: RotateTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * 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: RotateTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * 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: RotateTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * 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: RotateTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.RotateTool`. * * 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.tools.RotateTool` itself. * * This event will be fired when rotation finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has five properties: {any} node: node reference, {float[]} offsetToRest, * quaternion relative to rest position in parent coordinates {float[]} offsetToPrevious, euler rotation * relative to end position of previous sequence, or euler rotation relative to rest position if no previous * sequence in parent coordinates {float[]} absolute, quaternion in parent coordinates {float[]} world, * quaternion in world coordinates {float[]} restDifference, change of rest position quaternion in parent * coordinates {float[]} restDifferenceInCoordinates, change of rest position in euler rotation in current * coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:axisChanged axisChanged} event of this `sap.ui.vk.tools.RotateTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAxisChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTool$AxisChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.RotateTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCoordinateSystemChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTool$CoordinateSystemChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:placementModeChanged placementModeChanged } * event of this `sap.ui.vk.tools.RotateTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPlacementModeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTool$PlacementModeChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.RotateTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotated( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTool$RotatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.RotateTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotating( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTool$RotatingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:axisChanged axisChanged} 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 */ fireAxisChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTool$AxisChangedEventParameters ): this; /** * Fires event {@link #event:coordinateSystemChanged coordinateSystemChanged} 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 */ fireCoordinateSystemChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTool$CoordinateSystemChangedEventParameters ): this; /** * Fires event {@link #event:placementModeChanged placementModeChanged} 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 */ firePlacementModeChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTool$PlacementModeChangedEventParameters ): this; /** * Fires event {@link #event:rotated rotated} 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 */ fireRotated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTool$RotatedEventParameters ): this; /** * Fires event {@link #event:rotating rotating} 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 */ fireRotating( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTool$RotatingEventParameters ): this; /** * Gets current value of property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * Default value is `true`. * * * @returns Value of property `allowContextMenu` */ getAllowContextMenu(): boolean; /** * Gets current value of property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * Default value is `true`. * * * @returns Value of property `autoResetValues` */ getAutoResetValues(): boolean; /** * Gets current value of property {@link #getAxis axis}. * * Controls which axis are rotatable around. Can be All, X, Y, or Z * * Default value is `All`. * * * @returns Value of property `axis` */ getAxis(): sap.ui.vk.tools.RotatableAxis; /** * Gets current value of property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * Default value is `World`. * * * @returns Value of property `coordinateSystem` */ getCoordinateSystem(): sap.ui.vk.tools.CoordinateSystem; /** * Gets current value of property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when rotating is enabled * * Default value is `false`. * * * @returns Value of property `enableSnapping` */ getEnableSnapping(): boolean; /** * Gets current value of property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * Default value is `false`. * * * @returns Value of property `enableStepping` */ getEnableStepping(): boolean; /** * Gets current value of property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * Default value is `Highlight`. * * * @returns Value of property `nodeSet` */ getNodeSet(): sap.ui.vk.tools.ToolNodeSet; /** * Gets current value of property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * Default value is `Default`. * * * @returns Value of property `placementMode` */ getPlacementMode(): sap.ui.vk.tools.GizmoPlacementMode; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Performs rotation of selected objects. If coordinate system is specified a moved event is fired * * * @returns `this` to allow method chaining. */ rotate( /** * Euler rotation x axis angle in degrees. */ x: float, /** * Euler rotation y axis angle in degrees. */ y: float, /** * Euler rotation z axis angle in degrees. */ z: float, /** * Optional parameter to define coordinate system to be used when these coordinates are applied. If not * specified then currently set coordinate system will be used. */ coordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * Sets a new value for property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowContextMenu( /** * New value for property `allowContextMenu` */ bAllowContextMenu?: boolean ): this; /** * Sets a new value for property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoResetValues( /** * New value for property `autoResetValues` */ bAutoResetValues?: boolean ): this; /** * Sets a new value for property {@link #getAxis axis}. * * Controls which axis are rotatable around. Can be All, X, Y, or Z * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `All`. * * * @returns Reference to `this` in order to allow method chaining */ setAxis( /** * New value for property `axis` */ sAxis?: sap.ui.vk.tools.RotatableAxis ): this; /** * Sets a new value for property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `World`. * * * @returns Reference to `this` in order to allow method chaining */ setCoordinateSystem( /** * New value for property `coordinateSystem` */ sCoordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * Sets a new value for property {@link #getEnableSnapping enableSnapping}. * * Determines if snapping when rotating is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableSnapping( /** * New value for property `enableSnapping` */ bEnableSnapping?: boolean ): this; /** * Sets a new value for property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepping( /** * New value for property `enableStepping` */ bEnableStepping?: boolean ): this; /** * Sets a new value for property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeSet( /** * New value for property `nodeSet` */ sNodeSet?: sap.ui.vk.tools.ToolNodeSet ): this; /** * Sets a new value for property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setPlacementMode( /** * New value for property `placementMode` */ sPlacementMode?: sap.ui.vk.tools.GizmoPlacementMode ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; } /** * Tool to rotate scene in turntable mode */ class RotateTurntableTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new RotateTurntableTool tool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateTurntableToolSettings ); /** * Constructor for a new RotateTurntableTool tool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$RotateTurntableToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.RotateTurntableTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.RotateTurntableTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateTurntableTool`. * * 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.tools.RotateTurntableTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * 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: RotateTurntableTool$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTurntableTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateTurntableTool`. * * 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.tools.RotateTurntableTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotate( /** * The function to be called when the event occurs */ fnFunction: (p1: RotateTurntableTool$RotateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.RotateTurntableTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotate rotate} event of this `sap.ui.vk.tools.RotateTurntableTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotate( /** * The function to be called, when the event occurs */ fnFunction: (p1: RotateTurntableTool$RotateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:rotate rotate} 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 */ fireRotate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.RotateTurntableTool$RotateEventParameters ): this; /** * Executes Turntable rotation for the target Viewport. */ rotate( /** * The change in x-coordinate used to define the desired rotation. */ dx: int, /** * The change in y-coordinate used to define the desired rotation. */ dy: int ): void; } /** * Tool to scale 3D objects */ class ScaleTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new ScaleTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ScaleToolSettings ); /** * Constructor for a new ScaleTool. * * 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 of the new content resource. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ScaleToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.ScaleTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.ScaleTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * 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: ScaleTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when the coordinate system changes. * * * @returns Reference to `this` in order to allow method chaining */ attachCoordinateSystemChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ScaleTool$CoordinateSystemChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * 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: ScaleTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:placementModeChanged placementModeChanged} event * of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPlacementModeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ScaleTool$PlacementModeChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when scaling finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachScaled( /** * 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: ScaleTool$ScaledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when scaling finished. This event contains parameter 'nodesProperties' that * is array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachScaled( /** * The function to be called when the event occurs */ fnFunction: (p1: ScaleTool$ScaledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when scaling occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachScaling( /** * 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: ScaleTool$ScalingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.ScaleTool`. * * 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.tools.ScaleTool` itself. * * This event will be fired when scaling occurs. This event contains parameter 'nodesProperties' that is * array of objects, each object has four properties: {any} node: node reference, {float[]} offsetToRest, * scale relative to rest position in local coordinates {float[]} offsetToPrevious, scale relative to end * position of previous sequence or rest position if no previous sequence in local coordinates {float[] } * absolute, scale in parent coordinates {float[]} world, scale in world coordinate {float[]} restDifference, * change of rest position scale in ratio in parent coordinates {float[]} restDifferenceInCoordinates, change * of rest position scale in ratio in current coordinates * * * @returns Reference to `this` in order to allow method chaining */ attachScaling( /** * The function to be called when the event occurs */ fnFunction: (p1: ScaleTool$ScalingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.ScaleTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:coordinateSystemChanged coordinateSystemChanged } * event of this `sap.ui.vk.tools.ScaleTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCoordinateSystemChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ScaleTool$CoordinateSystemChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:placementModeChanged placementModeChanged } * event of this `sap.ui.vk.tools.ScaleTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPlacementModeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ScaleTool$PlacementModeChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.ScaleTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachScaled( /** * The function to be called, when the event occurs */ fnFunction: (p1: ScaleTool$ScaledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.ScaleTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachScaling( /** * The function to be called, when the event occurs */ fnFunction: (p1: ScaleTool$ScalingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:coordinateSystemChanged coordinateSystemChanged} 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 */ fireCoordinateSystemChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ScaleTool$CoordinateSystemChangedEventParameters ): this; /** * Fires event {@link #event:placementModeChanged placementModeChanged} 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 */ firePlacementModeChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ScaleTool$PlacementModeChangedEventParameters ): this; /** * Fires event {@link #event:scaled scaled} 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 */ fireScaled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ScaleTool$ScaledEventParameters ): this; /** * Fires event {@link #event:scaling scaling} 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 */ fireScaling( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.ScaleTool$ScalingEventParameters ): this; /** * Gets current value of property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * Default value is `true`. * * * @returns Value of property `allowContextMenu` */ getAllowContextMenu(): boolean; /** * Gets current value of property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * Default value is `true`. * * * @returns Value of property `autoResetValues` */ getAutoResetValues(): boolean; /** * Gets current value of property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * Default value is `World`. * * * @returns Value of property `coordinateSystem` */ getCoordinateSystem(): sap.ui.vk.tools.CoordinateSystem; /** * Gets current value of property {@link #getEnableSnapping enableSnapping}. * * Enable snapping if set true * * Default value is `false`. * * * @returns Value of property `enableSnapping` */ getEnableSnapping(): boolean; /** * Gets current value of property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * Default value is `false`. * * * @returns Value of property `enableStepping` */ getEnableStepping(): boolean; /** * Gets current value of property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * Default value is `Highlight`. * * * @returns Value of property `nodeSet` */ getNodeSet(): sap.ui.vk.tools.ToolNodeSet; /** * Gets current value of property {@link #getNonUniformScaleEnabled nonUniformScaleEnabled}. * * If set to `true` then this tool will enable scaling along a single axis, otherwise it will scale objects * along all three axes proportionally * * Default value is `false`. * * * @returns Value of property `nonUniformScaleEnabled` */ getNonUniformScaleEnabled(): boolean; /** * Gets current value of property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * Default value is `Default`. * * * @returns Value of property `placementMode` */ getPlacementMode(): sap.ui.vk.tools.GizmoPlacementMode; /** * Gets current value of property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * Default value is `false`. * * * @returns Value of property `showEditingUI` */ getShowEditingUI(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Performs scaling of selected objects. * * * @returns `this` to allow method chaining. */ scale( /** * Scaling value for x axis. */ x: float, /** * Scaling value for y axis. */ y: float, /** * Scaling value for z axis. */ z: float, /** * Optional parameter to define coordinate system to be used when these coordinates are applied. If not * specified then currently set coordinate system will be used. */ coordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * Sets a new value for property {@link #getAllowContextMenu allowContextMenu}. * * Whether or not to allow context menu on right-click * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowContextMenu( /** * New value for property `allowContextMenu` */ bAllowContextMenu?: boolean ): this; /** * Sets a new value for property {@link #getAutoResetValues autoResetValues}. * * Determines if auto reset values mode is enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoResetValues( /** * New value for property `autoResetValues` */ bAutoResetValues?: boolean ): this; /** * Sets a new value for property {@link #getCoordinateSystem coordinateSystem}. * * Select coordinate system in which this tool operates. Can be Local, World, Parent, Screen or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `World`. * * * @returns Reference to `this` in order to allow method chaining */ setCoordinateSystem( /** * New value for property `coordinateSystem` */ sCoordinateSystem?: sap.ui.vk.tools.CoordinateSystem ): this; /** * Sets a new value for property {@link #getEnableSnapping enableSnapping}. * * Enable snapping if set true * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableSnapping( /** * New value for property `enableSnapping` */ bEnableSnapping?: boolean ): this; /** * Sets a new value for property {@link #getEnableStepping enableStepping}. * * If set to `true` values will change in round number increments instead of continual change * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepping( /** * New value for property `enableStepping` */ bEnableStepping?: boolean ): this; /** * Sets a new value for property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeSet( /** * New value for property `nodeSet` */ sNodeSet?: sap.ui.vk.tools.ToolNodeSet ): this; /** * Sets a new value for property {@link #getNonUniformScaleEnabled nonUniformScaleEnabled}. * * If set to `true` then this tool will enable scaling along a single axis, otherwise it will scale objects * along all three axes proportionally * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setNonUniformScaleEnabled( /** * New value for property `nonUniformScaleEnabled` */ bNonUniformScaleEnabled?: boolean ): this; /** * Sets a new value for property {@link #getPlacementMode placementMode}. * * Sets the placement mode. Can be Default, ObjectCenter, or Custom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setPlacementMode( /** * New value for property `placementMode` */ sPlacementMode?: sap.ui.vk.tools.GizmoPlacementMode ): this; /** * Sets a new value for property {@link #getShowEditingUI showEditingUI}. * * Display text box with current value, which can also be used to directly modify the value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowEditingUI( /** * New value for property `showEditingUI` */ bShowEditingUI?: boolean ): this; } /** * Tool to display current scene orientation and to provide pre-defined camera positions */ class SceneOrientationTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new SceneOrientationTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$SceneOrientationToolSettings ); /** * Constructor for a new SceneOrientationTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$SceneOrientationToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.SceneOrientationTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.SceneOrientationTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableInitialView enableInitialView}. * * Default value is `true`. * * * @returns Value of property `enableInitialView` */ getEnableInitialView(): boolean; /** * Gets current value of property {@link #getEnablePredefinedViews enablePredefinedViews}. * * Default value is `true`. * * * @returns Value of property `enablePredefinedViews` */ getEnablePredefinedViews(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getEnableInitialView enableInitialView}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableInitialView( /** * New value for property `enableInitialView` */ bEnableInitialView?: boolean ): this; /** * Sets a new value for property {@link #getEnablePredefinedViews enablePredefinedViews}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnablePredefinedViews( /** * New value for property `enablePredefinedViews` */ bEnablePredefinedViews?: boolean ): this; /** * Performs camera "fly to" animation to the predefined view. * * * @returns `this` to allow method chaining. */ setView( /** * Predefined view. */ view?: sap.ui.vk.tools.PredefinedView, /** * Time to perform the "fly to" animation. */ milliseconds?: number ): this; } /** * Specifies base for all tools to extend */ class Tool extends sap.ui.core.Element { /** * Base for all tool controls. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ToolSettings, /** * scope An object for resolving string-based type and formatter references in bindings. */ oScope?: object ); /** * Base for all tool controls. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$ToolSettings, /** * scope An object for resolving string-based type and formatter references in bindings. */ oScope?: object ); /** * Creates a new subclass of class sap.ui.vk.tools.Tool 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.Tool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:enabled enabled} event of this `sap.ui.vk.tools.Tool`. * * 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.tools.Tool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachEnabled( /** * 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: Tool$EnabledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.Tool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:enabled enabled} event of this `sap.ui.vk.tools.Tool`. * * 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.tools.Tool` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachEnabled( /** * The function to be called when the event occurs */ fnFunction: (p1: Tool$EnabledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.Tool` itself */ oListener?: object ): this; /** * Destroys the gizmo in the aggregation {@link #getGizmo gizmo}. * * * @returns Reference to `this` in order to allow method chaining */ destroyGizmo(): this; /** * Detaches event handler `fnFunction` from the {@link #event:enabled enabled} event of this `sap.ui.vk.tools.Tool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEnabled( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tool$EnabledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:enabled enabled} 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 */ fireEnabled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.Tool$EnabledEventParameters ): this; /** * Gets current value of property {@link #getActive active}. * * Used to control the tool rendering and interaction pipeline. * * Default value is `false`. * * * @returns Value of property `active` */ getActive(): boolean; /** * Gets current value of property {@link #getFootprint footprint}. * * Used to decide whether this tool should be enabled for the target viewport. * * * @returns Value of property `footprint` */ getFootprint(): string[]; /** * Gets content of aggregation {@link #getGizmo gizmo}. * * sap.ui.vk.tools.Gizmo owned by this control and used for rendering floating UI */ getGizmo(): sap.ui.vk.tools.Gizmo; /** * ID of the element which is the current target of the association {@link #getGizmoContainer gizmoContainer}, * or `null`. */ getGizmoContainer(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getTargetViewportType targetViewportType}. * * * @returns Value of property `targetViewportType` */ getTargetViewportType(): any; /** * Gets current value of property {@link #getToolid toolid}. * * GUID identifier for the tool to prevent naming conflicts. * * * @returns Value of property `toolid` */ getToolid(): string; /** * Manages the 'active' flag for this tool and any other internals required */ setActive( /** * indicates whether this tools is active or not */ value?: boolean, /** * the tool target is used by the tool to carry out its operations */ activeTarget?: object, /** * used to evaluate whether a tool should be rendered as part of the activeTarget */ gizmoContainer?: object ): void; /** * Sets a new value for property {@link #getFootprint footprint}. * * Used to decide whether this tool should be enabled for the target viewport. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setFootprint( /** * New value for property `footprint` */ sFootprint: string[] ): this; /** * Sets the aggregated {@link #getGizmo gizmo}. * * * @returns Reference to `this` in order to allow method chaining */ setGizmo( /** * The gizmo to set */ oGizmo: sap.ui.vk.tools.Gizmo ): this; /** * Sets the associated {@link #getGizmoContainer gizmoContainer}. * * * @returns Reference to `this` in order to allow method chaining */ setGizmoContainer( /** * ID of an element which becomes the new target of this gizmoContainer association; alternatively, an element * instance may be given */ oGizmoContainer: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getTargetViewportType targetViewportType}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTargetViewportType( /** * New value for property `targetViewportType` */ oTargetViewportType: any ): this; /** * Sets a new value for property {@link #getToolid toolid}. * * GUID identifier for the tool to prevent naming conflicts. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setToolid( /** * New value for property `toolid` */ sToolid: string ): this; } /** * The TooltipTool allows applications to display custom tooltip text on top of 3D object over which pointer * is hovering */ class TooltipTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new TooltipTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$TooltipToolSettings ); /** * Constructor for a new TooltipTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$TooltipToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.TooltipTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.tools.TooltipTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:hover hover} event of this `sap.ui.vk.tools.TooltipTool`. * * 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.tools.TooltipTool` itself. * * This event will be fired when mouse hover occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachHover( /** * 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: TooltipTool$HoverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TooltipTool` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:hover hover} event of this `sap.ui.vk.tools.TooltipTool`. * * 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.tools.TooltipTool` itself. * * This event will be fired when mouse hover occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachHover( /** * The function to be called when the event occurs */ fnFunction: (p1: TooltipTool$HoverEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TooltipTool` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:hover hover} event of this `sap.ui.vk.tools.TooltipTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHover( /** * The function to be called, when the event occurs */ fnFunction: (p1: TooltipTool$HoverEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:hover hover} 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 */ fireHover( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TooltipTool$HoverEventParameters ): this; /** * Gets current value of property {@link #getAnimate animate}. * * Default value is `false`. * * * @returns Value of property `animate` */ getAnimate(): boolean; /** * Gets current value of property {@link #getFollowCursor followCursor}. * * Default value is `true`. * * * @returns Value of property `followCursor` */ getFollowCursor(): boolean; /** * Gets current value of property {@link #getOffsetX offsetX}. * * Default value is `10`. * * * @returns Value of property `offsetX` */ getOffsetX(): float; /** * Gets current value of property {@link #getOffsetY offsetY}. * * Default value is `15`. * * * @returns Value of property `offsetY` */ getOffsetY(): float; /** * Gets current value of property {@link #getTimeout timeout}. * * Default value is `0`. * * * @returns Value of property `timeout` */ getTimeout(): int; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getAnimate animate}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setAnimate( /** * New value for property `animate` */ bAnimate?: boolean ): this; /** * Sets a new value for property {@link #getFollowCursor followCursor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setFollowCursor( /** * New value for property `followCursor` */ bFollowCursor?: boolean ): this; /** * Sets a new value for property {@link #getOffsetX offsetX}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `10`. * * * @returns Reference to `this` in order to allow method chaining */ setOffsetX( /** * New value for property `offsetX` */ fOffsetX?: float ): this; /** * Sets a new value for property {@link #getOffsetY offsetY}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `15`. * * * @returns Reference to `this` in order to allow method chaining */ setOffsetY( /** * New value for property `offsetY` */ fOffsetY?: float ): this; /** * Sets a new value for property {@link #getTimeout timeout}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setTimeout( /** * New value for property `timeout` */ iTimeout?: int ): this; /** * Sets the tooltip title * * * @returns `this` to allow method chaining. */ setTitle( /** * Title */ title?: string ): this; } /** * The TransformSvgElementTool allows applications to transform an svg element. */ class TransformSvgElementTool extends sap.ui.vk.tools.Tool { /** * Constructor for a new TransformSvgElementTool. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$TransformSvgElementToolSettings ); /** * Constructor for a new TransformSvgElementTool. * * 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 of the new tool instance. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new tool instance. */ mSettings?: sap.ui.vk.tools.$TransformSvgElementToolSettings ); /** * Creates a new subclass of class sap.ui.vk.tools.TransformSvgElementTool 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.vk.tools.Tool.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.vk.tools.TransformSvgElementTool >, /** * 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.tools.TransformSvgElementTool. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when movement finished. * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * 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: TransformSvgElementTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moved moved} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when movement finished. * * * @returns Reference to `this` in order to allow method chaining */ attachMoved( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$MovedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when movement occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * 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: TransformSvgElementTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:moving moving} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when movement occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachMoving( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$MovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when rotation finished. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * 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: TransformSvgElementTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when rotation finished. * * * @returns Reference to `this` in order to allow method chaining */ attachRotated( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$RotatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * 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: TransformSvgElementTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when rotation occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachRotating( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$RotatingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when scaling finished. * * * @returns Reference to `this` in order to allow method chaining */ attachScaled( /** * 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: TransformSvgElementTool$ScaledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when scaling finished. * * * @returns Reference to `this` in order to allow method chaining */ attachScaled( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$ScaledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when scaling occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachScaling( /** * 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: TransformSvgElementTool$ScalingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * 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.tools.TransformSvgElementTool` itself. * * This event will be fired when scaling occurs. * * * @returns Reference to `this` in order to allow method chaining */ attachScaling( /** * The function to be called when the event occurs */ fnFunction: (p1: TransformSvgElementTool$ScalingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.tools.TransformSvgElementTool` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moved moved} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoved( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$MovedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:moving moving} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMoving( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$MovingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotated rotated} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotated( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$RotatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:rotating rotating} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRotating( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$RotatingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:scaled scaled} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachScaled( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$ScaledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:scaling scaling} event of this `sap.ui.vk.tools.TransformSvgElementTool`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachScaling( /** * The function to be called, when the event occurs */ fnFunction: (p1: TransformSvgElementTool$ScalingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:moved moved} 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 */ fireMoved( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$MovedEventParameters ): this; /** * Fires event {@link #event:moving moving} 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 */ fireMoving( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$MovingEventParameters ): this; /** * Fires event {@link #event:rotated rotated} 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 */ fireRotated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$RotatedEventParameters ): this; /** * Fires event {@link #event:rotating rotating} 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 */ fireRotating( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$RotatingEventParameters ): this; /** * Fires event {@link #event:scaled scaled} 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 */ fireScaled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$ScaledEventParameters ): this; /** * Fires event {@link #event:scaling scaling} 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 */ fireScaling( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.tools.TransformSvgElementTool$ScalingEventParameters ): this; /** * Gets current value of property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * Default value is `Highlight`. * * * @returns Value of property `nodeSet` */ getNodeSet(): sap.ui.vk.tools.ToolNodeSet; /** * Gets current value of property {@link #getUniformScaleEnabled uniformScaleEnabled}. * * If set to `true` then this tool will enable uniform scaling. * * Default value is `false`. * * * @returns Value of property `uniformScaleEnabled` */ getUniformScaleEnabled(): boolean; /** * MOVE TO BASE Queues a command for execution during the rendering cycle. All gesture operations should * be called using this method. * * * @returns `this` to allow method chaining. */ queueCommand( /** * The command to be executed. */ command: Function ): this; /** * Sets a new value for property {@link #getNodeSet nodeSet}. * * Determine what set of nodes will be transformed with this tool * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setNodeSet( /** * New value for property `nodeSet` */ sNodeSet?: sap.ui.vk.tools.ToolNodeSet ): this; /** * Sets a new value for property {@link #getUniformScaleEnabled uniformScaleEnabled}. * * If set to `true` then this tool will enable uniform scaling. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setUniformScaleEnabled( /** * New value for property `uniformScaleEnabled` */ bUniformScaleEnabled?: boolean ): this; } /** * Sets the allowed operations on the anchor point tool */ enum AnchorPointToolOperation { /** * Allow both rotation and move */ All = "All", /** * Allow only move */ Move = "Move", /** * Allow only rotation */ Rotate = "Rotate", } /** * Defines the coordinate system type. */ enum CoordinateSystem { /** * Custom coordinate system, defined by anchor point tool */ Custom = "Custom", /** * Local coordinate system */ Local = "Local", /** * Parent coordinate system */ Parent = "Parent", /** * Screen coordinate system */ Screen = "Screen", /** * World coordinate system */ World = "World", } /** * Defines the explode axis type. */ enum ExplodeAxis { X = "X", Y = "Y", Z = "Z", } /** * Defines the explode direction type. */ enum ExplodeDirection { Negative = "Negative", Positive = "Positive", } /** * Defines the explode type. */ enum ExplodeType { Linear = "Linear", Radial = "Radial", } /** * Sets the placement mode for move tool. */ enum GizmoPlacementMode { /** * Default PlacementMode */ Default = "Default", /** * Object(s) center PlacementMode */ ObjectCenter = "ObjectCenter", } /** * Describes the type of click or tap event that triggered the hitTest. */ enum HitTestClickType { /** * Right click or context event */ Context = "Context", /** * Double click or tap */ Double = "Double", /** * Single click or tap event */ Single = "Single", } /** * Sets the expected schema for the extraction of ids for hit nodes . */ enum HitTestIdMode { /** * HitTest will call an application supplied method to extract Id */ Callback = "Callback", /** * ThreeJS Id mode. HitTest result returns a threejs Id for the object */ ThreeJS = "ThreeJS", /** * HitTest result and event extracts an id for hit nodes based on VE Cloud Service Data Model */ VEsID = "VEsID", } /** * Sets the predefined view type. */ enum PredefinedView { /** * Back view */ Back = "Back", /** * Bottom view */ Bottom = "Bottom", /** * Front view */ Front = "Front", /** * Initial view */ Initial = "Initial", /** * Left view */ Left = "Left", /** * Right view */ Right = "Right", /** * Top view */ Top = "Top", } /** * Sets the Rotatable Axis type. */ enum RotatableAxis { /** * All three axises rotatable */ All = "All", /** * X axis rotatable */ X = "X", /** * Y axis rotatable */ Y = "Y", /** * Z axis rotatable */ Z = "Z", } /** * Selection display options. */ enum ToolNodeSet { Highlight = "Highlight", Outline = "Outline", } /** * Event object of the AnchorPointTool#moved event. */ type AnchorPointTool$MovedEvent = sap.ui.base.Event< AnchorPointTool$MovedEventParameters, AnchorPointTool >; /** * Event object of the AnchorPointTool#moving event. */ type AnchorPointTool$MovingEvent = sap.ui.base.Event< AnchorPointTool$MovingEventParameters, AnchorPointTool >; /** * Event object of the AnchorPointTool#rotated event. */ type AnchorPointTool$RotatedEvent = sap.ui.base.Event< AnchorPointTool$RotatedEventParameters, AnchorPointTool >; /** * Event object of the AnchorPointTool#rotating event. */ type AnchorPointTool$RotatingEvent = sap.ui.base.Event< AnchorPointTool$RotatingEventParameters, AnchorPointTool >; /** * Event object of the AxisAngleRotationTool#rotated event. */ type AxisAngleRotationTool$RotatedEvent = sap.ui.base.Event< AxisAngleRotationTool$RotatedEventParameters, AxisAngleRotationTool >; /** * Event object of the AxisAngleRotationTool#rotating event. */ type AxisAngleRotationTool$RotatingEvent = sap.ui.base.Event< AxisAngleRotationTool$RotatingEventParameters, AxisAngleRotationTool >; /** * Event object of the CreateEllipseTool#completed event. */ type CreateEllipseTool$CompletedEvent = sap.ui.base.Event< CreateEllipseTool$CompletedEventParameters, CreateEllipseTool >; /** * Event object of the CreatePathTool#completed event. */ type CreatePathTool$CompletedEvent = sap.ui.base.Event< CreatePathTool$CompletedEventParameters, CreatePathTool >; /** * Event object of the CreateRectangleTool#completed event. */ type CreateRectangleTool$CompletedEvent = sap.ui.base.Event< CreateRectangleTool$CompletedEventParameters, CreateRectangleTool >; /** * Event object of the CreateTextTool#completed event. */ type CreateTextTool$CompletedEvent = sap.ui.base.Event< CreateTextTool$CompletedEventParameters, CreateTextTool >; /** * Event object of the CrossSectionTool#stateChanged event. */ type CrossSectionTool$StateChangedEvent = sap.ui.base.Event< CrossSectionTool$StateChangedEventParameters, CrossSectionTool >; /** * Event object of the DuplicateSvgElementTool#nodesCreated event. */ type DuplicateSvgElementTool$NodesCreatedEvent = sap.ui.base.Event< DuplicateSvgElementTool$NodesCreatedEventParameters, DuplicateSvgElementTool >; /** * Event object of the ExplodeTool#axisSelected event. */ type ExplodeTool$AxisSelectedEvent = sap.ui.base.Event< ExplodeTool$AxisSelectedEventParameters, ExplodeTool >; /** * Event object of the ExplodeTool#itemPositionAdjusted event. */ type ExplodeTool$ItemPositionAdjustedEvent = sap.ui.base.Event< ExplodeTool$ItemPositionAdjustedEventParameters, ExplodeTool >; /** * Event object of the ExplodeTool#itemPositionAdjusting event. */ type ExplodeTool$ItemPositionAdjustingEvent = sap.ui.base.Event< ExplodeTool$ItemPositionAdjustingEventParameters, ExplodeTool >; /** * Event object of the ExplodeTool#itemSequenceChangePressed event. */ type ExplodeTool$ItemSequenceChangePressedEvent = sap.ui.base.Event< ExplodeTool$ItemSequenceChangePressedEventParameters, ExplodeTool >; /** * Event object of the ExplodeTool#magnitudeChanged event. */ type ExplodeTool$MagnitudeChangedEvent = sap.ui.base.Event< ExplodeTool$MagnitudeChangedEventParameters, ExplodeTool >; /** * Event object of the ExplodeTool#magnitudeChanging event. */ type ExplodeTool$MagnitudeChangingEvent = sap.ui.base.Event< ExplodeTool$MagnitudeChangingEventParameters, ExplodeTool >; /** * Event object of the HitTestTool#hit event. */ type HitTestTool$HitEvent = sap.ui.base.Event< HitTestTool$HitEventParameters, HitTestTool >; /** * Event object of the MoveTool#coordinateSystemChanged event. */ type MoveTool$CoordinateSystemChangedEvent = sap.ui.base.Event< MoveTool$CoordinateSystemChangedEventParameters, MoveTool >; /** * Event object of the MoveTool#moved event. */ type MoveTool$MovedEvent = sap.ui.base.Event< MoveTool$MovedEventParameters, MoveTool >; /** * Event object of the MoveTool#moving event. */ type MoveTool$MovingEvent = sap.ui.base.Event< MoveTool$MovingEventParameters, MoveTool >; /** * Event object of the MoveTool#placementModeChanged event. */ type MoveTool$PlacementModeChangedEvent = sap.ui.base.Event< MoveTool$PlacementModeChangedEventParameters, MoveTool >; /** * Event object of the PointCloudSelectionTool#currentGroupChanged event. */ type PointCloudSelectionTool$CurrentGroupChangedEvent = sap.ui.base.Event< PointCloudSelectionTool$CurrentGroupChangedEventParameters, PointCloudSelectionTool >; /** * Event object of the PointCloudSelectionTool#groupAdded event. */ type PointCloudSelectionTool$GroupAddedEvent = sap.ui.base.Event< PointCloudSelectionTool$GroupAddedEventParameters, PointCloudSelectionTool >; /** * Event object of the PointCloudSelectionTool#groupRemoved event. */ type PointCloudSelectionTool$GroupRemovedEvent = sap.ui.base.Event< PointCloudSelectionTool$GroupRemovedEventParameters, PointCloudSelectionTool >; /** * Event object of the RedlineTool#elementClicked event. */ type RedlineTool$ElementClickedEvent = sap.ui.base.Event< RedlineTool$ElementClickedEventParameters, RedlineTool >; /** * Event object of the RedlineTool#elementCreated event. */ type RedlineTool$ElementCreatedEvent = sap.ui.base.Event< RedlineTool$ElementCreatedEventParameters, RedlineTool >; /** * Event object of the RedlineTool#elementHovered event. */ type RedlineTool$ElementHoveredEvent = sap.ui.base.Event< RedlineTool$ElementHoveredEventParameters, RedlineTool >; /** * Event object of the RotateOrbitTool#rotate event. */ type RotateOrbitTool$RotateEvent = sap.ui.base.Event< RotateOrbitTool$RotateEventParameters, RotateOrbitTool >; /** * Event object of the RotateTool#axisChanged event. */ type RotateTool$AxisChangedEvent = sap.ui.base.Event< RotateTool$AxisChangedEventParameters, RotateTool >; /** * Event object of the RotateTool#coordinateSystemChanged event. */ type RotateTool$CoordinateSystemChangedEvent = sap.ui.base.Event< RotateTool$CoordinateSystemChangedEventParameters, RotateTool >; /** * Event object of the RotateTool#placementModeChanged event. */ type RotateTool$PlacementModeChangedEvent = sap.ui.base.Event< RotateTool$PlacementModeChangedEventParameters, RotateTool >; /** * Event object of the RotateTool#rotated event. */ type RotateTool$RotatedEvent = sap.ui.base.Event< RotateTool$RotatedEventParameters, RotateTool >; /** * Event object of the RotateTool#rotating event. */ type RotateTool$RotatingEvent = sap.ui.base.Event< RotateTool$RotatingEventParameters, RotateTool >; /** * Event object of the RotateTurntableTool#rotate event. */ type RotateTurntableTool$RotateEvent = sap.ui.base.Event< RotateTurntableTool$RotateEventParameters, RotateTurntableTool >; /** * Event object of the ScaleTool#coordinateSystemChanged event. */ type ScaleTool$CoordinateSystemChangedEvent = sap.ui.base.Event< ScaleTool$CoordinateSystemChangedEventParameters, ScaleTool >; /** * Event object of the ScaleTool#placementModeChanged event. */ type ScaleTool$PlacementModeChangedEvent = sap.ui.base.Event< ScaleTool$PlacementModeChangedEventParameters, ScaleTool >; /** * Event object of the ScaleTool#scaled event. */ type ScaleTool$ScaledEvent = sap.ui.base.Event< ScaleTool$ScaledEventParameters, ScaleTool >; /** * Event object of the ScaleTool#scaling event. */ type ScaleTool$ScalingEvent = sap.ui.base.Event< ScaleTool$ScalingEventParameters, ScaleTool >; /** * Event object of the Tool#enabled event. */ type Tool$EnabledEvent = sap.ui.base.Event< Tool$EnabledEventParameters, Tool >; /** * Event object of the TooltipTool#hover event. */ type TooltipTool$HoverEvent = sap.ui.base.Event< TooltipTool$HoverEventParameters, TooltipTool >; /** * Event object of the TransformSvgElementTool#moved event. */ type TransformSvgElementTool$MovedEvent = sap.ui.base.Event< TransformSvgElementTool$MovedEventParameters, TransformSvgElementTool >; /** * Event object of the TransformSvgElementTool#moving event. */ type TransformSvgElementTool$MovingEvent = sap.ui.base.Event< TransformSvgElementTool$MovingEventParameters, TransformSvgElementTool >; /** * Event object of the TransformSvgElementTool#rotated event. */ type TransformSvgElementTool$RotatedEvent = sap.ui.base.Event< TransformSvgElementTool$RotatedEventParameters, TransformSvgElementTool >; /** * Event object of the TransformSvgElementTool#rotating event. */ type TransformSvgElementTool$RotatingEvent = sap.ui.base.Event< TransformSvgElementTool$RotatingEventParameters, TransformSvgElementTool >; /** * Event object of the TransformSvgElementTool#scaled event. */ type TransformSvgElementTool$ScaledEvent = sap.ui.base.Event< TransformSvgElementTool$ScaledEventParameters, TransformSvgElementTool >; /** * Event object of the TransformSvgElementTool#scaling event. */ type TransformSvgElementTool$ScalingEvent = sap.ui.base.Event< TransformSvgElementTool$ScalingEventParameters, TransformSvgElementTool >; } /** * Contract for authorization callback function * * A callback function which can be implemented by an application to provide an authorization token. Such * a function receives a single parameter which is a connection URL and must return a promise which will * be resolved to {@link https://www.oauth.com/oauth2-servers/access-tokens/access-token-response/ Access Token Response } * when authorization token is obtained. * * A sample implementation of authorization handler:: * ```javascript * * ... * var viewer = new sap.ui.vk.Viewer(); * viewer.setAuthorizationHandler(function(url) { * var headers = new Headers(); * headers.append("Content-Type", "application/x-www-form-urlencoded"); * headers.append("Authorization", "Basic " + basicAuth); * * return fetch(accessTokenUrl, { * method: "POST", * body: "grant_type=client_credentials", * headers: headers * }).then(response => response.json()) * }); * ... * ``` * * * @since 1.60.0 */ interface AuthorizationHandler { __implements__sap_ui_vk_AuthorizationHandler: boolean; } /** * Contract for objects that implement decryption. * * An interface for an object provided by an application to decrypt content of encrypted models. * * Content is encrypted with the {@link https://en.wikipedia.org/wiki/Advanced_Encryption_Standard AES128 } * algorithm in the {@link https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_Block_Chaining_.28CBC.29 CBC } * mode. * * A key is derived with the {@link https://en.wikipedia.org/wiki/PBKDF2 PBKDF2} algorithm by applying the * {@link https://en.wikipedia.org/wiki/Hash-based_message_authentication_code HMAC}-{@link https://en.wikipedia.org/wiki/SHA-2 SHA256 } * function 10,000 times. * * A sample implementation and usage of the sap.ui.vk.DecryptionHandler interface with the {@link https://cdnjs.cloudflare.com/ajax/libs/asmCrypto/0.16.4/asmcrypto.js asmCrypto } * library:: * ```javascript * * ... * * ... * var decryptionHandler = { * deriveKey: function(salt, password) { * try { * return asmCrypto.PBKDF2_HMAC_SHA256.bytes(password, salt, 10000, 16); * } catch (ex) { * return null; * } * }, * decrypt: function(key, iv, input) { * try { * return asmCrypto.AES_CBC.decrypt(input, key, true, iv); * } catch (ex) { * return null; * } * } * }; * ... * var viewer = new sap.ui.vk.Viewer(); * viewer.setDecryptionHandler(decryptionHandler); * var contentResource = new sap.ui.vk.ContentResource({ * source: "http://my-web-server.com/my-encrypted-model.vds", * sourceType: "vds", * sourceId: "abc", * password: "abracadabra" * }); * viewer.addContentResource(contentResource); * ``` * * * @since 1.38.0 */ interface DecryptionHandler { __implements__sap_ui_vk_DecryptionHandler: boolean; /** * Decrypts the input buffer with the {@link https://en.wikipedia.org/wiki/Advanced_Encryption_Standard AES128 } * algorithm in the {@link https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation#Cipher_Block_Chaining_.28CBC.29 CBC } * mode. * * * @returns The decrypted buffer. */ decrypt( /** * The derived key generated by the previous call to {@link sap.ui.vk.DecryptionHandler#deriveKey sap.ui.vk.DecryptionHandler.deriveKey}. */ key: object, /** * The 128-bit {@link https://en.wikipedia.org/wiki/Initialization_vector initialization vector}. */ iv: Uint8Array, /** * The encrypted buffer. */ encryptedData: Uint8Array ): Uint8Array; /** * Generates a cryptographic session key derived from a base data value. * * The key must be derived with the {@link https://en.wikipedia.org/wiki/PBKDF2 PBKDF2} algorithm by applying * the {@link https://en.wikipedia.org/wiki/Hash-based_message_authentication_code HMAC}-{@link https://en.wikipedia.org/wiki/SHA-2 SHA256 } * function 10,000 times. * * The resulting 128-bit key should be passed to subsequent calls to {@link sap.ui.vk.DecryptionHandler#decrypt sap.ui.vk.DecryptionHandler.decrypt}. * * * @returns A derived 128-bit key that should be passed to subsequent calls to {@link sap.ui.vk.DecryptionHandler#decrypt sap.ui.vk.DecryptionHandler.decrypt}. */ deriveKey( /** * Random data that is used as an additional input to a one-way function that "hashes" a password or passphrase. */ salt: Uint8Array, /** * A password used for encryption/decryption. */ password: Uint8Array ): object; } /** * Contract for objects that provide access to animation playbacks. */ interface IPlaybackCollection { __implements__sap_ui_vk_IPlaybackCollection: boolean; } /** * Describes the settings that can be provided to the AnimationPlayer constructor. */ interface $AnimationPlayerSettings extends sap.ui.core.$ElementSettings { viewStateManager?: sap.ui.vk.ViewStateManagerBase | string; viewActivated?: (oEvent: sap.ui.base.Event) => void; beforeTimeChanged?: (oEvent: sap.ui.base.Event) => void; timeChanged?: (oEvent: sap.ui.base.Event) => void; stateChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the Annotation constructor. */ interface $AnnotationSettings extends sap.ui.core.$ControlSettings { /** * Reference to the annotation Id */ annotationId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Reference to the annotation name */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Reference to the node that represents the annotation */ nodeRef?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The text that will be displayed in the annotation */ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The style of the annotation */ style?: | sap.ui.vk.AnnotationStyle | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the annotation */ display?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the animation of the annotation. If set to `false` then animation is not played. */ animate?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Amount of time in seconds to wait before animation is played. Default value of -1 means that this is * not set. */ animationDelay?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the annotation selected state */ selected?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If annotation is editable then double click event is fired when user double clicks on the annotation * and text editing is allowed by calling openEditor() method. If annotation is also selected then resize * and reposition handles will be displayed. */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the X Coordinate of the annotation. This uses a scale of -0.5 to 0.5, left to right respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. */ xCoordinate?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the Y Coordinate of the annotation. This uses a scale of -0.5 to 0.5, top to bottom respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. */ yCoordinate?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, left * to right respectively. */ xOffset?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, top * to bottom respectively. */ yOffset?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the height of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. */ height?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the width of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. */ width?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; textEditor?: sap.ui.core.Control; viewport?: sap.ui.vk.Viewport | string; } /** * Describes the settings that can be provided to the Camera constructor. */ interface $CameraSettings extends sap.ui.base.$ManagedObjectSettings { /** * Camera position in global space (x, y, z coordinates) */ position?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Camera direction vector in global space (normalized x, y, z vector values) */ targetDirection?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Camera up vector in global space (normalized x, y, z vector values) */ upDirection?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Near clipping plane distance */ nearClipPlane?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Far clipping plane distance */ farClipPlane?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ContainerBase constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerBase} */ interface $ContainerBaseSettings extends sap.ui.core.$ControlSettings { /** * Show fullscreen toggle button in toolbar */ showFullScreen?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Show settings button in toolbar */ showSettings?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Show selection button in toolbar */ showSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls whether the control is show fullscreen or embedded */ fullScreen?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Title to show in toolbar */ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; autoAdjustHeight?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Content Aggregation. */ content?: | sap.ui.vk.ContainerContent[] | sap.ui.vk.ContainerContent | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledBy). */ ariaLabelledBy?: Array; contentChange?: (oEvent: ContainerBase$ContentChangeEvent) => void; settingsPressed?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the ContainerContent constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerContent} */ interface $ContainerContentSettings extends sap.ui.core.$ControlSettings { /** * Icon to show up in the toolbar */ icon?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Title for the icon in the toolbar */ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; content?: sap.ui.core.Control; } /** * Describes the settings that can be provided to the ContentConnector constructor. */ interface $ContentConnectorSettings extends sap.ui.core.$ElementSettings { /** * Content resources to load and display. */ contentResources?: | sap.ui.vk.ContentResource[] | sap.ui.vk.ContentResource | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * View state managers. */ viewStateManagers?: | sap.ui.vk.ViewStateManagerBase[] | sap.ui.vk.ViewStateManagerBase | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * This event will be fired when content resource changes are about to be processed. */ contentChangesStarted?: (oEvent: sap.ui.base.Event) => void; /** * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. */ contentChangesFinished?: ( oEvent: ContentConnector$ContentChangesFinishedEvent ) => void; /** * This event will be fired to report the progress of content changes. */ contentChangesProgress?: ( oEvent: ContentConnector$ContentChangesProgressEvent ) => void; /** * This event will be fired when content loading is finished. */ contentLoadingFinished?: ( oEvent: ContentConnector$ContentLoadingFinishedEvent ) => void; /** * This event will be fired when the current content is completely rebuilt or destroyed as a result of changes * in content resources. */ contentReplaced?: ( oEvent: ContentConnector$ContentReplacedEvent ) => void; /** * This event will be fired when the current content is about to be destroyed. */ contentDestroying?: ( oEvent: ContentConnector$ContentDestroyingEvent ) => void; } /** * Describes the settings that can be provided to the ContentManager constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $ContentManagerSettings extends sap.ui.base.$ManagedObjectSettings { /** * This event will be fired when content resources are about to be loaded. */ contentChangesStarted?: (oEvent: sap.ui.base.Event) => void; /** * This event will be fired when content resources have been loaded successfully or with a failure. */ contentChangesFinished?: ( oEvent: ContentManager$ContentChangesFinishedEvent ) => void; /** * This event will be fired to report the progress of content changes. */ contentChangesProgress?: ( oEvent: ContentManager$ContentChangesProgressEvent ) => void; /** * This event will be fired when content loading is finished. */ contentLoadingFinished?: ( oEvent: ContentManager$ContentLoadingFinishedEvent ) => void; } /** * Describes the settings that can be provided to the ContentResource constructor. */ interface $ContentResourceSettings extends sap.ui.base.$ManagedObjectSettings { /** * The source URL or the {@link https://developer.mozilla.org/en-US/docs/Web/API/File File} object of the * content resource/file to load from. The source may be omitted if a grouping node is needed. */ source?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The source type of the content resource. Valid types: * * * - vds * - vds4 * - vds4-2d * - svg * - png * - jpg * - jpeg * - gif * - bmp * - tif * - tiff * - stream * - stream2d * - ecad * - pdf * - auto * * The source type may be omitted if this is a grouping content node. If the `source` property points * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType` * property will be detected by making a request to the backend. NOTE: The tif and tiff image formats * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy * library to load and display VDS file content. If source type of "vds4" is used then new namespace based * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model. */ sourceType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The unique ID of the content resource. */ sourceId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The local transformation matrix of the node created for this content resource. */ localMatrix?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name of the node created for this content resource. */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The password to use when opening the resource. */ password?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to false, unsecure connections will be used. Default: true. */ useSecureConnection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Id of scene to retrieve tree for. Mandatory for the stream source type. */ veid?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: * true. */ includeHidden?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Send structural data for animation objects, if false they will be omitted, reducing data size. Default: * true. */ includeAnimation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, elements for PMI rendering content will be returned. Default: false. */ pushPMI?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional metadata filter that can trim the tree before sending to the client only keeping nodes that * passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, * meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple * filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes * (e.g. breadcrumb) even if they don't pass the filter. */ metadataFilter?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Optional parameter with view id which shall be activated when scene is loaded. */ activateView?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Optional boolean parameter to enable detailed logging. Can be used to track performance issues during * data streaming from SAP 3D Visualization Service. */ enableLogger?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, information of view groups will be returned. Default: true. */ pushViewGroups?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, will return nodes with the type background */ includeBackground?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, will load parametric nodes */ includeParametric?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, will load metadata */ includeMetadata?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional parameter to load UsageIds. Valid values: * `true` - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined * for the tenant which are not relevant to the current application. `false` - Do not load any UsageIds. * `string` - A single non-empty string which defines the name of the requested UsageId. `string[]` * - An array of non-empty strings which define the names of requested UsageIds. */ includeUsageId?: | sap.ui.vk.IncludeUsageIdType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * An object used to load content resource's dependencies. * * A content resource may have dependencies, e.g. if the loaded content resource is a shattered VDS file * it reference other VDS files. * * `dependencyLoader` should be an object with method `function load(uri: string, context: any): Promise<{buffer: * ArrayBuffer, context: any}>`, where `uri` is a reference to a dependency and `context` is opaque data. * * `uri` is application specific and can be a full URL or a relative file name or anything else, e.g. some * identifier known to `dependencyLoader`. */ dependencyLoader?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Child content resources. */ contentResources?: | sap.ui.vk.ContentResource[] | sap.ui.vk.ContentResource | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the DrawerToolbar constructor. */ interface $DrawerToolbarSettings extends sap.ui.core.$ControlSettings { /** * Indicates whether the DrawerToolbar is expanded or not. If expanded is set to true, then both the toolbar * and 'Close' icon are rendered. If expanded is set to false, then only the 'Open' icon is rendered. */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; navigationMode?: | sap.ui.vk.NavigationMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines the content of the DrawerToolbar. See {@link sap.m.OverflowToolbar} for list of allowed controls. * The content visible when the DrawerToolbar is expanded. */ content?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; viewport?: sap.ui.vk.ViewportBase | string; } /** * Describes the settings that can be provided to the FlexibleControl constructor. */ interface $FlexibleControlSettings extends sap.ui.core.$ControlSettings { /** * CSS width of the vertical layout. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; layout?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If not enabled all controls inside are not enabled automatically. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Child Controls within the layout. */ content?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the FlexibleControlLayoutData constructor. */ interface $FlexibleControlLayoutDataSettings extends sap.ui.core.$LayoutDataSettings { /** * Sets the size of the content. */ size?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the minimum size of the content in px. */ minSize?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the margin-bottom of the content in px. */ marginTop?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; marginBottom?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ImageContentManager constructor. */ interface $ImageContentManagerSettings extends sap.ui.vk.$ContentManagerSettings {} /** * Describes the settings that can be provided to the LegendItem constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerLegendItem} */ interface $LegendItemSettings extends sap.m.$StandardListItemSettings { /** * show color square */ color?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The semantic spot type for the legend marker. */ semanticSpotType?: | sap.ui.vbm.SemanticType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ListPanel constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ListPanel} */ interface $ListPanelSettings extends sap.ui.core.$ControlSettings { /** * Header text */ headerText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Header icon */ headerIcon?: | sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Expansion state */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Expand animation */ expandAnimation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Selection Mode */ selectionMode?: | sap.m.ListMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Item aggregation */ items?: | sap.m.ListItemBase[] | sap.m.ListItemBase | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Event is fired if the header icon is pressed */ headerIconPress?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired if the panel is expanded of collapsed */ expand?: (oEvent: sap.ui.base.Event) => void; /** * Event is fired when selection is changed via user interaction inside the control. */ selectionChange?: (oEvent: ListPanel$SelectionChangeEvent) => void; /** * Event is fired when an item is pressed unless the item's `type` property is `Inactive`. */ itemPress?: (oEvent: ListPanel$ItemPressEvent) => void; } /** * Describes the settings that can be provided to the ListPanelStack constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ListPanelStack} */ interface $ListPanelStackSettings extends sap.ui.core.$ControlSettings { /** * Control width */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Expansion state */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Expand animation */ expandAnimation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Ability to collapse */ collapsible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; content?: | sap.ui.vk.ListPanel[] | sap.ui.vk.ListPanel | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the MapContainer constructor. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.MapContainer} */ interface $MapContainerSettings extends sap.ui.vk.$ContainerBaseSettings { /** * Show navbar */ showNavbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the home button */ showHome?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Map Layer Select */ showMapLayer?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the rectangular zoom button */ showRectangularZoom?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the zoom buttons */ showZoom?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * List Panel aggregation */ listPanelStack?: sap.ui.vk.ListPanelStack; } /** * Describes the settings that can be provided to the NativeViewport constructor. */ interface $NativeViewportSettings extends sap.ui.vk.$ViewportBaseSettings { /** * Limit the ability to zoom out. If enabled the zoom out stops if the image size reaches 25% of the full * view (best fit). */ limitZoomOut?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Raised when the display size of the image in the Native Viewport changes. */ resize?: (oEvent: NativeViewport$ResizeEvent) => void; /** * Raised when the display position or magnification of the image in the Native Viewport changes. */ move?: (oEvent: NativeViewport$MoveEvent) => void; } /** * Describes the settings that can be provided to the NodeHierarchy constructor. */ interface $NodeHierarchySettings extends sap.ui.base.$ManagedObjectSettings { /** * This event will be fired when the node hierarchy changes, e.g. a node is added or removed. */ changed?: (oEvent: sap.ui.base.Event) => void; /** * This event will be fired when a new node is created. */ nodeCreated?: (oEvent: NodeHierarchy$NodeCreatedEvent) => void; /** * This event will be fired when a node is about to be removed. */ nodeRemoving?: (oEvent: NodeHierarchy$NodeRemovingEvent) => void; nodeReplaced?: (oEvent: NodeHierarchy$NodeReplacedEvent) => void; nodeUpdated?: (oEvent: NodeHierarchy$NodeUpdatedEvent) => void; } /** * Describes the settings that can be provided to the NodeProxy constructor. */ interface $NodeProxySettings extends sap.ui.base.$ManagedObjectSettings { /** * The node reference. This property is read-only. */ nodeRef?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The node VE IDs. This property is read-only. */ veIds?: | object[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name of the node. This property is read-only. */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The local transformation matrix of the node. */ localMatrix?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The world transformation matrix of the node. */ worldMatrix?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The material of the node (optional). */ material?: | sap.ui.vk.Material | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The node opacity. */ opacity?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The tint color. * * * The tint color is a 32-bit integer in the ABGR notation, where A is amount of blending between material * color and tint color. */ tintColorABGR?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The tint color. */ tintColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The node metadata. This property is read-only. */ nodeMetadata?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The indicator showing if the node has child nodes. This property is read-only. */ hasChildren?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The indicator showing if the node is closed. This property is read-only. */ closed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Notifications constructor. */ interface $NotificationsSettings extends sap.ui.core.$ControlSettings { /** * This event will be fired when all messages in the log are deleted. */ allMessagesCleared?: (oEvent: sap.ui.base.Event) => void; /** * This event will be fired when a new log message is added. */ messageAdded?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the OrthographicCamera constructor. */ interface $OrthographicCameraSettings extends sap.ui.vk.$CameraSettings { /** * Camera zoom factor */ zoomFactor?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the OutputSettings constructor. */ interface $OutputSettingsSettings extends sap.ui.core.$ElementSettings { /** * width of the output, unit in mm */ width?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * height of the output, unit in mm */ height?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * density of the output, unit in dpi (dots-per-inch) */ dpi?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Overlay constructor. * * @deprecated As of version 1.120. This is not in use anymore. Please consider using Redline tool, see * {@link sap.ui.vk.RedlineTool} */ interface $OverlaySettings extends sap.ui.core.$ControlSettings { zoomOnResize?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Aggregation of Highlight Areas. */ areas?: | sap.ui.vk.OverlayArea[] | sap.ui.vk.OverlayArea | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Aggregation of Highlight Areas. */ target?: sap.ui.core.Control | string; /** * Raised when the Control is clicked. */ click?: (oEvent: Overlay$ClickEvent) => void; /** * Raised when the Control is right clicked/longPress(tap and hold). */ contextMenu?: (oEvent: Overlay$ContextMenuEvent) => void; } /** * Describes the settings that can be provided to the OverlayArea constructor. * * @deprecated As of version 1.120. This is not in use anymore. Please consider using Redline tool, see * {@link sap.ui.vk.RedlineTool} */ interface $OverlayAreaSettings extends sap.ui.core.$ElementSettings { /** * Unique identifier for the object. This is optional. If not provided the default identifier sId is used. * However, sId is generated if template binding is used and thus it is not stable. Provide the key if the * object really needs a unique and stable identifier. */ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0". */ position?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The fill color of the OverlayArea. */ color?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The border color of the OverlayArea. */ colorBorder?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The select color of the OverlayArea in case selection highlighting is desired. */ colorSelect?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The non-select color of the OverlayArea in case non-selection de-highlighting is desired. */ colorNonSelect?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;) */ deltaColorHot?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * set to true if the element is selected */ select?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Set to true if OverlayArea is changeable. */ changeable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The event is raised when there is a click action on an OverlayArea. */ click?: (oEvent: sap.ui.base.Event) => void; /** * The event is raised when there is a right click or a tap and hold action on an OverlayArea. */ contextMenu?: (oEvent: OverlayArea$ContextMenuEvent) => void; /** * This event is raised when the edge of an OverlayArea is clicked. */ edgeClick?: (oEvent: OverlayArea$EdgeClickEvent) => void; /** * This event is raised when the edge of an OverlayArea is right clicked. */ edgeContextMenu?: (oEvent: OverlayArea$EdgeContextMenuEvent) => void; /** * This event is raised when the design handle of a changeable OverlayArea is moved. */ handleMoved?: (oEvent: sap.ui.base.Event) => void; /** * This event is raised when the design handle of a changeable OverlayArea is right clicked. */ handleContextMenu?: ( oEvent: OverlayArea$HandleContextMenuEvent ) => void; /** * This event is raised when the design handle of a changeable OverlayArea is clicked. */ handleClick?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the PerspectiveCamera constructor. */ interface $PerspectiveCameraSettings extends sap.ui.vk.$CameraSettings { /** * Camera frustum field of view in degree */ fov?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ProgressIndicator constructor. * * @deprecated As of version 1.114.0. Use {@link sap.m.ProgressIndicator} instead. */ interface $ProgressIndicatorSettings extends sap.m.$ProgressIndicatorSettings {} /** * Describes the settings that can be provided to the RedlineCollaboration constructor. */ interface $RedlineCollaborationSettings extends sap.ui.core.$ElementSettings { /** * A list of available conversations. */ conversations?: | sap.ui.vk.RedlineConversation[] | sap.ui.vk.RedlineConversation | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; viewport?: sap.ui.vk.Viewport | string; /** * Currently active conversation. */ activeConversation?: sap.ui.vk.RedlineConversation | string; /** * Currently active comment. */ activeComment?: /* was: sap.ui.vk.RedlineComment */ any | string; elementCreated?: ( oEvent: RedlineCollaboration$ElementCreatedEvent ) => void; elementClicked?: ( oEvent: RedlineCollaboration$ElementClickedEvent ) => void; elementHovered?: ( oEvent: RedlineCollaboration$ElementHoveredEvent ) => void; conversationActivating?: ( oEvent: RedlineCollaboration$ConversationActivatingEvent ) => void; conversationActivated?: ( oEvent: RedlineCollaboration$ConversationActivatedEvent ) => void; } /** * Describes the settings that can be provided to the RedlineConversation constructor. */ interface $RedlineConversationSettings extends sap.ui.core.$ElementSettings { conversationName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; timestamp?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; viewId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; viewInfo?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; animationOffset?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; measurementScale?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; pageId?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; comments?: | sap.ui.vk.RedlineElementComment[] | sap.ui.vk.RedlineElementComment | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineDesign constructor. */ interface $RedlineDesignSettings extends sap.ui.vk.$RedlineSurfaceSettings { elementCreated?: (oEvent: RedlineDesign$ElementCreatedEvent) => void; } /** * Describes the settings that can be provided to the RedlineElement constructor. */ interface $RedlineElementSettings extends sap.ui.core.$ElementSettings { originX?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; originY?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; opacity?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; strokeWidth?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; strokeColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; strokeDashArray?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; halo?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; haloColor?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; createdByUser?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; createTimestamp?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; deletedByUser?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; deleteTimestamp?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; suppress?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; elementId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the RedlineElementComment constructor. */ interface $RedlineElementCommentSettings extends sap.ui.core.$ElementSettings { text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; createdByUser?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; createTimestamp?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineElementEllipse constructor. */ interface $RedlineElementEllipseSettings extends sap.ui.vk.$RedlineElementSettings { radiusX?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; radiusY?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; fillColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineElementFreehand constructor. */ interface $RedlineElementFreehandSettings extends sap.ui.vk.$RedlineElementSettings { path?: | float[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineElementLine constructor. */ interface $RedlineElementLineSettings extends sap.ui.vk.$RedlineElementSettings { deltaX?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; deltaY?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; endArrowHead?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineElementRectangle constructor. */ interface $RedlineElementRectangleSettings extends sap.ui.vk.$RedlineElementSettings { width?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; height?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; fillColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineElementText constructor. */ interface $RedlineElementTextSettings extends sap.ui.vk.$RedlineElementSettings { text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; font?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; fontSize?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; fillColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; width?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; height?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the RedlineSurface constructor. */ interface $RedlineSurfaceSettings extends sap.ui.core.$ControlSettings { virtualLeft?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; virtualTop?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; virtualSideLength?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; panningRatio?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; redlineElements?: | sap.ui.vk.RedlineElement[] | sap.ui.vk.RedlineElement | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; pan?: (oEvent: RedlineSurface$PanEvent) => void; zoom?: (oEvent: RedlineSurface$ZoomEvent) => void; } /** * Describes the settings that can be provided to the SafeArea constructor. */ interface $SafeAreaSettings extends sap.ui.core.$ControlSettings { /** * Application defined setting control which can be used to control SafeArea and aspect ratio settings */ settingsControl?: sap.ui.core.Control; } /** * Describes the settings that can be provided to the Scene constructor. */ interface $SceneSettings extends sap.ui.base.$ManagedObjectSettings { /** * Enables or disables double-sided materials */ doubleSided?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SceneTree constructor. */ interface $SceneTreeSettings extends sap.ui.core.$ControlSettings { /** * Text to be displayed in title bar of scene tree */ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `False` then title text will not bbe displayed */ showTitle?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Show or hide search field */ showSearchField?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * In legacy visibility mode all changes in node visibility also apply to all descendent nodes */ legacyVisibilityMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; treeTable?: sap.ui.table.TreeTable; /** * An association to the `ContentConnector` instance that manages content resources. */ contentConnector?: sap.ui.vk.ContentConnector | string; /** * An association to the `ViewStateManager` instance. */ viewStateManager?: sap.ui.vk.ViewStateManagerBase | string; /** * This event will be fired when a scene tree content is replaced. */ contentChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the StepNavigation constructor. * * @deprecated As of version 1.72.0. This class is used only with DVL namespace which will be removed in * future. Use {@link sap.ui.vk.ViewGallery} instead. */ interface $StepNavigationSettings extends sap.ui.core.$ControlSettings { /** * Managed settings and properties for Step Navigation events. */ settings?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Width of the Step Navigation control. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Height of the Step Navigation control. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the Step Navigation control should display thumbnails. If set to `true`, then thumbnails * are rendered. If set to `false`, then thumbnails are hidden. */ showThumbnails?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the Step Navigation control should display a toolbar. If set to `true`, then the toolbar * is rendered. If set to `false`, then the toolbar is hidden. */ showToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the Step Navigation control should display a popup containing information around the step * that is playing. If set to `true`, then the popup is rendered. If set to `false`, the popup is hidden. */ showStepInfo?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Template control for Procedure items. */ procedureItemTemplate?: sap.ui.core.Item; /** * sap.ui.core.Popup used to render step information in a popup. */ stepInfoPopup?: sap.ui.core.Control; /** * sap.m.Toolbar used to render the entire Step Navigation control's content. */ layout?: sap.m.Toolbar; /** * sap.m.ScrollContainer used to render a list of thumbnails for the available steps. */ thumbnailsContainer?: sap.m.ScrollContainer; contentConnector?: sap.ui.vk.ContentConnector | string; resize?: (oEvent: StepNavigation$ResizeEvent) => void; /** * Raised each time a step starts, changes, or finishes. */ stepChanged?: (oEvent: StepNavigation$StepChangedEvent) => void; } /** * Describes the settings that can be provided to the Texture constructor. */ interface $TextureSettings extends sap.ui.base.$ManagedObjectSettings { /** * Rotation angle of uv coordinates */ uvRotationAngle?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Horizontal offset of uv coordinates */ uvHorizontalOffset?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * VerticalOffset offset of uv coordinates */ uvVerticalOffset?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Horizontal scale of uv coordinates */ uvHorizontalScale?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Vertical scale of uv coordinates */ uvVerticalScale?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Is the uv horizontal tiling enabled */ uvHorizontalTilingEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Is the uv vertical tiling enabled */ uvVerticalTilingEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ToggleMenuButton constructor. */ interface $ToggleMenuButtonSettings extends sap.ui.core.$ControlSettings { /** * Defines the type of the button (for example, Default, Accept, Reject, Transparent). Values `Back`, `Up` * and `Unstyled` are ignored. */ type?: | sap.m.ButtonType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the width of the button. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Boolean property to enable the control (default is `true`). **Note:** Depending on custom settings, the * buttons that are disabled have other colors than the enabled ones. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * When set to `truefalse` to avoid the attempt of fetching density perfect image. */ iconDensityAware?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the position of the popup menu with enumerated options. By default, the control opens the menu * at its bottom left side. * * **Note:** In the case that the menu has no space to show itself in the view port of the current window * it tries to open itself to the inverted direction. */ menuPosition?: | sap.ui.core.Popup.Dock | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This property specifies the element's text directionality with enumerated options. By default, the control * inherits text direction from the DOM. */ textDirection?: | sap.ui.core.TextDirection | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The property is “true” when the control is toggled. The default state of this property is "false". */ pressed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the menu items contained within this control. */ items?: /* was: sap.ui.vk.ToggleMenuItem */ | any[] | /* was: sap.ui.vk.ToggleMenuItem */ any | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Sets or retrieves the selected item from the aggregation named items. */ defaultItem?: /* was: sap.ui.vk.ToggleMenuItem */ any | string; /** * Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs, which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Fired before menu opening when the `buttonMode` is set to `Split` and the user presses the arrow button. */ beforeMenuOpen?: (oEvent: sap.ui.base.Event) => void; /** * Fired when a `ToggleMenuItem` is toggled. */ itemToggled?: (oEvent: ToggleMenuButton$ItemToggledEvent) => void; /** * Fired when a `ToggleMenuItem` is selected. */ itemSelected?: (oEvent: ToggleMenuButton$ItemSelectedEvent) => void; } /** * Describes the settings that can be provided to the Toolbar constructor. */ interface $ToolbarSettings extends sap.ui.core.$ControlSettings { /** * Toolbar content, this can be used to add/remove buttons and other SAP UI5 controls to the toolbar */ content?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the View constructor. */ interface $ViewSettings extends sap.ui.base.$ManagedObjectSettings { /** * View persistent ID (optional) */ viewId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * View name (optional) */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * View description (optional) */ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be * ignored. */ aspectRatio?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Flag for auto-playing animation on view activation (optional) */ autoPlayAnimation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Background top color (optional) */ topColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Background bottom color (optional) */ bottomColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Navigation mode (optional) */ navigationMode?: | sap.ui.vk.NavigationMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Dimension (optional) */ dimension?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Viewer constructor. */ interface $ViewerSettings extends sap.ui.core.$ControlSettings { /** * Disables the scene tree control Button on the menu */ enableSceneTree?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the scene tree control */ showSceneTree?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the Step Navigation Control Button on the menu */ enableStepNavigation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the Message Popover Control */ enableNotifications?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the Step Navigation Control */ showStepNavigation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the Step Navigation thumbnails */ showStepNavigationThumbnails?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If enabled the Step Navigation will be overlayed on top of the viewport. Only set this during initialization. * Will not work when set at runtime. */ overlayStepNavigation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the ECAD layers panel control */ enableLayersPanel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the ECAD layers panel control */ showLayersPanel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the ECAD elements panel control */ enableElementsPanel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the ECAD elements panel control */ showElementsPanel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the page gallery control */ enablePageGallery?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the page gallery control */ showPageGallery?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides Toolbar control */ enableToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enable / disable progress indicator for downloading and rendering VDS files */ enableProgressIndicator?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the drawer toolbar */ showDrawerToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the mini map control */ enableMiniMap?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the mini map control */ showMiniMap?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Width of the Viewer control */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Height of the Viewer control */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The toolbar title */ toolbarTitle?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Whether or not we want ViewStateManager to keep track of visibility changes. */ shouldTrackVisibilityChanges?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Whether or not we want ViewStateManager to have recursive selection. */ recursiveSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional Emscripten runtime module settings. A JSON object with the following properties: * - totalMemory {int} size of Emscripten module memory in bytes, default value: 512 MB. * - logElementId {string} ID of a textarea DOM element to write the log to. * - statusElementId {string} ID of a DOM element to write the status messages to. Emscripten runtime * module settings cannot be changed after the control is fully initialized. */ runtimeSettings?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional WebGL context attributes. A JSON object with the following boolean properties: * - antialias {boolean} default value `true`. If set to `true`, the context will attempt to perform antialiased * rendering if possible. * - alpha {boolean} default value `true`. If set to `true`, the context will have an alpha (transparency) * channel. * - premultipliedAlpha {boolean} default value `false`. If set to `true`, the color channels in the framebuffer * will be stored premultiplied by the alpha channel to improve performance. Other {@link https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2 WebGL context attributes } * are also supported. WebGL context attributes cannot be changed after the control is fully initialized. */ webGLContextAttributes?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides showing of all hotspots toggle button */ hotspotsEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables or disables showing of all hotspots */ showAllHotspots?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color used for highlighting Smart2D hotspots in the ABGR format. */ hotspotColorABGR?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color used for highlighting Smart2D hotspots in the CSS Color format. */ hotspotColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Content resources to load and display in the Viewer control. */ contentResources?: | sap.ui.vk.ContentResource[] | sap.ui.vk.ContentResource | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * View gallery control */ viewGallery?: sap.ui.vk.ViewGallery; /** * Drawer toolbar */ drawerToolbar?: sap.ui.vk.DrawerToolbar; /** * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. */ contentResourceChangesProcessed?: (oEvent: sap.ui.base.Event) => void; /** * This event will be fired when a scene / image has been loaded into the Viewer. */ sceneLoadingSucceeded?: ( oEvent: Viewer$SceneLoadingSucceededEvent ) => void; /** * This event will be fired when a critical error occurs during scene / image loading. */ sceneLoadingFailed?: (oEvent: Viewer$SceneLoadingFailedEvent) => void; /** * This event will be fired when scene / image loaded in Viewer is about to be destroyed. */ sceneDestroying?: (oEvent: Viewer$SceneDestroyingEvent) => void; /** * This event is fired when the nodes are selected/unselected. */ selectionChanged?: (oEvent: Viewer$SelectionChangedEvent) => void; /** * This event is fired when viewer enters/exits full screen mode. */ fullScreen?: (oEvent: Viewer$FullScreenEvent) => void; /** * This event will be fired when a URL in a note is clicked. */ urlClicked?: (oEvent: Viewer$UrlClickedEvent) => void; /** * This event will be fired when a node is clicked. */ nodeClicked?: (oEvent: Viewer$NodeClickedEvent) => void; } /** * Describes the settings that can be provided to the ViewGallery constructor. */ interface $ViewGallerySettings extends sap.ui.core.$ControlSettings { /** * Indicates that the View Gallery control should display animation slider showing time of animation in * current view. */ showAnimationTimeSlider?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the View Gallery control should display toolbar */ showToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the View Gallery control should display thumbnails */ showThumbnailContainer?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Index of selected view */ selectedViewIndex?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Index of selected view group */ selectedViewGroupIndex?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the View Gallery control should allow view reordering */ enableViewReordering?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% * opaque */ transparency?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If disabled, view gallery is non-interactive and greyed out */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; animationPlayer?: sap.ui.vk.AnimationPlayer | string; contentConnector?: sap.ui.vk.ContentConnector | string; host?: sap.ui.vk.ViewportBase | string; viewManager?: sap.ui.vk.ViewManager | string; /** * Fires when selection is changed via user interaction inside the control. */ selectionChange?: (oEvent: ViewGallery$SelectionChangeEvent) => void; /** * Fires when views are reordered */ viewOrderChange?: (oEvent: ViewGallery$ViewOrderChangeEvent) => void; } /** * Describes the settings that can be provided to the ViewGroup constructor. */ interface $ViewGroupSettings extends sap.ui.base.$ManagedObjectSettings { viewGroupId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the ViewManager constructor. */ interface $ViewManagerSettings extends sap.ui.core.$ElementSettings { /** * An association to the {@link sap.ui.vk.ContentConnector ContentConnector} instance that manages content * resources. */ contentConnector?: sap.ui.vk.ContentConnector | string; /** * An association to the {@link sap.ui.vk.AnimationPlayer AnimationPlayer} instance that manages animation * sequences. * * If no AnimationPlayer is associated with ViewManager the views can still be activated but no animation * will be played. */ animationPlayer?: sap.ui.vk.AnimationPlayer | string; } /** * Describes the settings that can be provided to the Viewport constructor. */ interface $ViewportSettings extends sap.ui.vk.$ViewportBaseSettings {} /** * Describes the settings that can be provided to the ViewportBase constructor. */ interface $ViewportBaseSettings extends sap.ui.core.$ControlSettings { /** * Shows or hides the debug info. */ showDebugInfo?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport background top color in the CSS Color format */ backgroundColorTop?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport background bottom color in the CSS Color format */ backgroundColorBottom?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport width */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport height */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Selection mode */ selectionMode?: | sap.ui.vk.SelectionMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Selection display mode */ selectionDisplayMode?: | sap.ui.vk.SelectionDisplayMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Show selection bounding boxes */ showSelectionBoundingBoxes?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Freeze camera */ freezeCamera?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Viewport render mode */ renderMode?: | sap.ui.vk.RenderMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows or hides the Safe Area */ showSafeArea?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables or disables showing of all hotspots */ showAllHotspots?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables or disables showing of all dynamic contents */ showAllDynamicContents?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables hotspot hovering */ disableHotspotHovering?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color used for highlighting hotspots in the ABGR format */ hotspotColorABGR?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color used for highlighting hotspots in the CSS Color format */ hotspotColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; hotspotCustomTextOutlineWidth?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; hotspotCustomTextOutlineColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; hotspotCustomTextHaloWidth?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; keepOutputSize?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color used to highlight all hotspots when the showAllHotspots property has a value of true. */ showAllHotspotsTintColor?: | sap.ui.core.CSSColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Automatically start rendering This will allow client code to control if viewport rendering should commence * automatically or not. */ autoStartRendering?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; minCameraPitch?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; maxCameraPitch?: | float | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The controls inside the viewport. */ content?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * SafeArea control for viewport */ safeArea?: sap.ui.vk.SafeArea; /** * HTML Annotations present in the active view */ annotations?: | sap.ui.vk.Annotation[] | sap.ui.vk.Annotation | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Output size settings of the viewport */ outputSettings?: sap.ui.vk.OutputSettings; /** * An association to the `ContentConnector` instance that manages content resources. */ contentConnector?: sap.ui.vk.ContentConnector | string; /** * An association to the `ViewStateManager` instance. */ viewStateManager?: sap.ui.vk.ViewStateManagerBase | string; /** * The tools of this viewport. */ tools?: Array; /** * This event is fired when a URL in a note is clicked. */ urlClicked?: (oEvent: ViewportBase$UrlClickedEvent) => void; /** * This event will be fired when a node is clicked. */ nodeClicked?: (oEvent: ViewportBase$NodeClickedEvent) => void; /** * This event is fired when viewport size is changed. */ resize?: (oEvent: ViewportBase$ResizeEvent) => void; /** * This event is fired when nodes in the scene are picked by user action. If application requires different * selection behaviour then it can handle this event and implement its own selection method. In this case * {@link sap.ui.vk.Viewport#selectionMode selectionMode} property should be set to `sap.ui.vk.SelectionMode.None` * Application can modify list of picked node references to alter selection behaviour. */ nodesPicked?: (oEvent: ViewportBase$NodesPickedEvent) => void; /** * This event is fired when a node in the scene is zoomed in/out by double-clicking. */ nodeZoomed?: (oEvent: ViewportBase$NodeZoomedEvent) => void; /** * This event is fired when a view in the viewport is activated */ viewActivated?: (oEvent: ViewportBase$ViewActivatedEvent) => void; } /** * Describes the settings that can be provided to the ViewStateManager constructor. */ interface $ViewStateManagerSettings extends sap.ui.vk.$ViewStateManagerBaseSettings {} /** * Describes the settings that can be provided to the ViewStateManagerBase constructor. */ interface $ViewStateManagerBaseSettings extends sap.ui.core.$ElementSettings { shouldTrackVisibilityChanges?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; recursiveSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; recursiveOutlining?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; features?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; contentConnector?: sap.ui.vk.ContentConnector | string; viewManager?: sap.ui.vk.ViewManager | string; /** * This event is fired when the visibility of the node changes. */ visibilityChanged?: ( oEvent: ViewStateManagerBase$VisibilityChangedEvent ) => void; /** * This event is fired when the nodes are selected/unselected. */ selectionChanged?: ( oEvent: ViewStateManagerBase$SelectionChangedEvent ) => void; /** * This event is fired when the nodes are outlined/unoutlined. */ outliningChanged?: ( oEvent: ViewStateManagerBase$OutliningChangedEvent ) => void; /** * This event is fired when opacity of the nodes is changed. */ opacityChanged?: ( oEvent: ViewStateManagerBase$OpacityChangedEvent ) => void; /** * This event is fired when tint color of the nodes is changed. */ tintColorChanged?: ( oEvent: ViewStateManagerBase$TintColorChangedEvent ) => void; /** * This event is fired when the node hierarchy is replaced. */ nodeHierarchyReplaced?: ( oEvent: ViewStateManagerBase$NodeHierarchyReplacedEvent ) => void; /** * This event is fired when highlighting color is changed. */ highlightColorChanged?: ( oEvent: ViewStateManagerBase$HighlightColorChangedEvent ) => void; /** * This event is fired when node's transformation changed. */ transformationChanged?: ( oEvent: ViewStateManagerBase$TransformationChangedEvent ) => void; /** * This event is fired when View is about to be activated. */ viewStateApplying?: ( oEvent: ViewStateManagerBase$ViewStateApplyingEvent ) => void; /** * This event is fired when View activated. */ viewStateApplied?: ( oEvent: ViewStateManagerBase$ViewStateAppliedEvent ) => void; /** * This event is fired when viewport is ready for playing animation (e.g, camera is ready). */ readyForAnimation?: ( oEvent: ViewStateManagerBase$ReadyForAnimationEvent ) => void; /** * This event is fired when outlining color is changed. */ outlineColorChanged?: ( oEvent: ViewStateManagerBase$OutlineColorChangedEvent ) => void; /** * This event is fired when outline width is changed. */ outlineWidthChanged?: ( oEvent: ViewStateManagerBase$OutlineWidthChangedEvent ) => void; } /** * Parameters of the AnimationPlayer#beforeTimeChanged event. */ interface AnimationPlayer$BeforeTimeChangedEventParameters {} /** * Parameters of the AnimationPlayer#stateChanged event. */ interface AnimationPlayer$StateChangedEventParameters {} /** * Parameters of the AnimationPlayer#timeChanged event. */ interface AnimationPlayer$TimeChangedEventParameters {} /** * Parameters of the AnimationPlayer#viewActivated event. */ interface AnimationPlayer$ViewActivatedEventParameters {} /** * Parameters of the ContainerBase#contentChange event. */ interface ContainerBase$ContentChangeEventParameters { selectedItemId?: string; } /** * Parameters of the ContainerBase#settingsPressed event. */ interface ContainerBase$SettingsPressedEventParameters {} /** * Parameters of the ContentConnector#contentChangesFinished event. */ interface ContentConnector$ContentChangesFinishedEventParameters { /** * The content created or updated. * * The content can be of type HTMLImageElement, sap.ui.vk.Scene etc. */ content?: any; /** * The failure reason if any. * An single element or an array of elements with the following structure: * error - An object with details of the error. contentResource - A {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource } * object when it is possible to match the Error object to a {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource } * object. */ failureReason?: any; } /** * Parameters of the ContentConnector#contentChangesProgress event. */ interface ContentConnector$ContentChangesProgressEventParameters { /** * The name of the loading phase. It can be e.g. 'downloading', 'building the scene' etc. It might be null * if reporting this parameter does not make sense. */ phase?: string; /** * The overall percentage of the loading process. */ percentage?: float; /** * The content resource currently being loaded. It might be null if reporting this parameter does not make * sense. */ source?: any; } /** * Parameters of the ContentConnector#contentChangesStarted event. */ interface ContentConnector$ContentChangesStartedEventParameters {} /** * Parameters of the ContentConnector#contentDestroying event. */ interface ContentConnector$ContentDestroyingEventParameters { /** * The content to be destroyed. * * The content can be of type HTMLImageElement, sap.ui.vk.Scene etc. */ content?: any; /** * Returns a `function(prevent: boolean)` with one boolean parameter. To prevent garbage collection after * the content is destroyed call this function passing `true` as a parameter. */ preventGarbageCollection?: Function; } /** * Parameters of the ContentConnector#contentLoadingFinished event. */ interface ContentConnector$ContentLoadingFinishedEventParameters { source?: any; node?: any; } /** * Parameters of the ContentConnector#contentReplaced event. */ interface ContentConnector$ContentReplacedEventParameters { /** * New content. * * The content can be of type HTMLImageElement, sap.ui.vk.Scene etc. */ newContent?: any; /** * Old content. * * The content can be of type HTMLImageElement, sap.ui.vk.Scene etc. */ oldContent?: any; } /** * Parameters of the ContentManager#contentChangesFinished event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ContentManager$ContentChangesFinishedEventParameters { /** * The content created or updated. */ content?: any; /** * The failure reason if any. * An single element or an array of elements with the following structure: * error - An object with details of the error. contentResource - A {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource } * object when it is possible to match `error` to a {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource } * object. */ failureReason?: object; } /** * Parameters of the ContentManager#contentChangesProgress event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ContentManager$ContentChangesProgressEventParameters { /** * The name of the loading phase. It can be e.g. 'downloading', 'building the scene' etc. It might be null * if reporting this parameter does not make sense. */ phase?: string; /** * The overall percentage of the loading process. */ percentage?: float; /** * The content resource currently being loaded. It might be null if reporting this parameter does not make * sense. */ source?: any; } /** * Parameters of the ContentManager#contentChangesStarted event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ContentManager$ContentChangesStartedEventParameters {} /** * Parameters of the ContentManager#contentLoadingFinished event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ContentManager$ContentLoadingFinishedEventParameters { source?: any; node?: any; } /** * Parameters of the DrawerToolbar#expanded event. */ interface DrawerToolbar$ExpandedEventParameters { /** * If the DrawerToolbar is expanded, this is true. If the DrawerToolbar is collapsed, this is false. */ expand?: boolean; } /** * Parameters of the ListPanel#expand event. */ interface ListPanel$ExpandEventParameters {} /** * Parameters of the ListPanel#headerIconPress event. */ interface ListPanel$HeaderIconPressEventParameters {} /** * Parameters of the ListPanel#itemPress event. */ interface ListPanel$ItemPressEventParameters { /** * The item which fired the pressed event. */ listItem?: sap.m.ListItemBase; /** * The control which caused the press event within the container. */ srcControl?: sap.ui.core.Control; } /** * Parameters of the ListPanel#selectionChange event. */ interface ListPanel$SelectionChangeEventParameters { /** * The item whose selection has changed. In `MultiSelect` mode, only the up-most selected item is returned. * This parameter can be used for single-selection modes. */ listItem?: sap.m.ListItemBase; /** * Array of items whose selection has changed. This parameter can be used for `MultiSelect` mode. */ listItems?: sap.m.ListItemBase[]; /** * Indicates whether the `listItem` parameter is selected or not. */ selected?: boolean; } /** * Parameters of the NativeViewport#move event. */ interface NativeViewport$MoveEventParameters { pan?: object; zoom?: float; } /** * Parameters of the NativeViewport#resize event. */ interface NativeViewport$ResizeEventParameters extends sap.ui.vk.ViewportBase$ResizeEventParameters { oldSize?: object; } /** * Parameters of the NodeHierarchy#changed event. */ interface NodeHierarchy$ChangedEventParameters {} /** * Parameters of the NodeHierarchy#nodeCreated event. */ interface NodeHierarchy$NodeCreatedEventParameters { nodeRef?: any; nodeId?: string; } /** * Parameters of the NodeHierarchy#nodeRemoving event. */ interface NodeHierarchy$NodeRemovingEventParameters { nodeRef?: any; nodeId?: string; } /** * Parameters of the NodeHierarchy#nodeReplaced event. */ interface NodeHierarchy$NodeReplacedEventParameters { ReplacedNodeRef?: any; ReplacementNodeRef?: any; ReplacedNodeId?: string; ReplacementNodeId?: string; } /** * Parameters of the NodeHierarchy#nodeUpdated event. */ interface NodeHierarchy$NodeUpdatedEventParameters { nodeRef?: any; nodeId?: string; } /** * Parameters of the Notifications#allMessagesCleared event. */ interface Notifications$AllMessagesClearedEventParameters {} /** * Parameters of the Notifications#messageAdded event. */ interface Notifications$MessageAddedEventParameters {} /** * Parameters of the Overlay#click event. */ interface Overlay$ClickEventParameters { /** * Client coordinate X */ clientX?: int; /** * Client coordinate Y */ clientY?: int; /** * Coordinates of click position in format "x;y;0" */ pos?: string; } /** * Parameters of the Overlay#contextMenu event. */ interface Overlay$ContextMenuEventParameters { /** * Coordinates of click position in format "x;y;0" */ pos?: string; /** * Menu to open */ menu?: sap.ui.unified.Menu; } /** * Parameters of the OverlayArea#click event. */ interface OverlayArea$ClickEventParameters {} /** * Parameters of the OverlayArea#contextMenu event. */ interface OverlayArea$ContextMenuEventParameters { /** * Menu to open */ menu?: sap.ui.unified.Menu; } /** * Parameters of the OverlayArea#edgeClick event. */ interface OverlayArea$EdgeClickEventParameters { /** * Index of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the * first position in the position array and end at the second. */ index?: int; } /** * Parameters of the OverlayArea#edgeContextMenu event. */ interface OverlayArea$EdgeContextMenuEventParameters { /** * Index of the clicked edge. The numbering is zero based and the first edge with index 0 starts at the * first position in the position array and end at the second. */ index?: int; /** * Menu to open */ menu?: sap.ui.unified.Menu; } /** * Parameters of the OverlayArea#handleClick event. */ interface OverlayArea$HandleClickEventParameters {} /** * Parameters of the OverlayArea#handleContextMenu event. */ interface OverlayArea$HandleContextMenuEventParameters { /** * Index of the clicked handle. The numbering is zero based. */ index?: int; /** * Menu to open */ menu?: sap.ui.unified.Menu; } /** * Parameters of the OverlayArea#handleMoved event. */ interface OverlayArea$HandleMovedEventParameters {} /** * Parameters of the RedlineCollaboration#conversationActivated event. */ interface RedlineCollaboration$ConversationActivatedEventParameters { conversation?: sap.ui.vk.RedlineConversation; viewportLocked?: boolean; } /** * Parameters of the RedlineCollaboration#conversationActivating event. */ interface RedlineCollaboration$ConversationActivatingEventParameters { conversation?: sap.ui.vk.RedlineConversation; } /** * Parameters of the RedlineCollaboration#elementClicked event. */ interface RedlineCollaboration$ElementClickedEventParameters { elementId?: string; } /** * Parameters of the RedlineCollaboration#elementCreated event. */ interface RedlineCollaboration$ElementCreatedEventParameters { element?: object; } /** * Parameters of the RedlineCollaboration#elementHovered event. */ interface RedlineCollaboration$ElementHoveredEventParameters { elementId?: string; } /** * Parameters of the RedlineDesign#elementCreated event. */ interface RedlineDesign$ElementCreatedEventParameters { element?: object; } /** * Parameters of the RedlineSurface#pan event. */ interface RedlineSurface$PanEventParameters { deltaX?: float; deltaY?: float; } /** * Parameters of the RedlineSurface#zoom event. */ interface RedlineSurface$ZoomEventParameters { originX?: float; originY?: float; zoomFactor?: float; } /** * Parameters of the SceneTree#contentChanged event. */ interface SceneTree$ContentChangedEventParameters {} /** * Parameters of the StepNavigation#resize event. */ interface StepNavigation$ResizeEventParameters { oldSize?: object; size?: object; } /** * Parameters of the StepNavigation#stepChanged event. */ interface StepNavigation$StepChangedEventParameters { /** * The ID of the rendering client that raised the event. */ clientId?: object; /** * The type of sap.ve.dvl.DVLSTEPEVENT that has been raised; for example, DVLSTEPEVENT_FINISHED, DVLSTEPEVENT_SWITCHED, * DVLSTEPEVENT_STARTED, DVLSTEPEVENT_PLAYING. */ type?: object; /** * The ID of the step affected by this stepId event. */ stepId?: object; } /** * Parameters of the ToggleMenuButton#beforeMenuOpen event. */ interface ToggleMenuButton$BeforeMenuOpenEventParameters {} /** * Parameters of the ToggleMenuButton#itemSelected event. */ interface ToggleMenuButton$ItemSelectedEventParameters { /** * The `ToggleMenuItem` which was selected. */ item?: /* was: sap.ui.vk.ToggleMenuItem */ any; } /** * Parameters of the ToggleMenuButton#itemToggled event. */ interface ToggleMenuButton$ItemToggledEventParameters { /** * The `ToggleMenuItem` which was unpressed. */ oldItem?: /* was: sap.ui.vk.ToggleMenuItem */ any; /** * The `ToggleMenuItem` which was pressed. */ newItem?: /* was: sap.ui.vk.ToggleMenuItem */ any; } /** * Parameters of the Viewer#contentResourceChangesProcessed event. */ interface Viewer$ContentResourceChangesProcessedEventParameters {} /** * Parameters of the Viewer#fullScreen event. */ interface Viewer$FullScreenEventParameters { /** * true: entered full screen; false: exited full screen. */ isFullScreen?: boolean; } /** * Parameters of the Viewer#nodeClicked event. */ interface Viewer$NodeClickedEventParameters { /** * Returns a node reference. */ nodeRef?: any; x?: int; y?: int; } /** * Parameters of the Viewer#sceneDestroying event. */ interface Viewer$SceneDestroyingEventParameters { /** * Returns a reference to the scene to be destroyed. */ scene?: sap.ui.vk.Scene; /** * Returns a `function(prevent: boolean)` with one boolean parameter. To prevent garbage collection after * the scene is destroyed call this function passing `true` as a parameter. */ preventGarbageCollection?: Function; } /** * Parameters of the Viewer#sceneLoadingFailed event. */ interface Viewer$SceneLoadingFailedEventParameters { /** * Returns an optional object describing the reason of the failure. */ reason?: object; } /** * Parameters of the Viewer#sceneLoadingSucceeded event. */ interface Viewer$SceneLoadingSucceededEventParameters { /** * Returns a reference to the loaded Scene. */ scene?: sap.ui.vk.Scene; } /** * Parameters of the Viewer#selectionChanged event. */ interface Viewer$SelectionChangedEventParameters { /** * Node references to the newly selected nodes. */ selected?: any[]; /** * Node references to the newly unselected nodes. */ unselected?: any[]; } /** * Parameters of the Viewer#urlClicked event. */ interface Viewer$UrlClickedEventParameters { /** * Returns a node reference of the note that contains the URL. */ nodeRef?: any; /** * Returns a URL that was clicked. */ url?: string; } /** * Parameters of the ViewGallery#selectionChange event. */ interface ViewGallery$SelectionChangeEventParameters { item?: sap.ui.core.Control; } /** * Parameters of the ViewGallery#viewOrderChange event. */ interface ViewGallery$ViewOrderChangeEventParameters { view?: sap.ui.vk.View; viewIndex?: int; } /** * Parameters of the ViewportBase#nodeClicked event. */ interface ViewportBase$NodeClickedEventParameters { /** * Returns a node reference. */ nodeRef?: any; x?: int; y?: int; } /** * Parameters of the ViewportBase#nodesPicked event. */ interface ViewportBase$NodesPickedEventParameters { /** * References of the nodes that are picked. */ picked?: any[]; } /** * Parameters of the ViewportBase#nodeZoomed event. */ interface ViewportBase$NodeZoomedEventParameters { /** * Reference of the node that is zoomed. */ zoomed?: any; /** * True for zoom in, and false for zoom out. */ isZoomIn?: boolean; } /** * Parameters of the ViewportBase#procedureFinished event. */ interface ViewportBase$ProcedureFinishedEventParameters {} /** * Parameters of the ViewportBase#resize event. */ interface ViewportBase$ResizeEventParameters { /** * Returns the width and height of new size `\{ width: number, height: number \}` in CSS pixels. */ size?: object; } /** * Parameters of the ViewportBase#urlClicked event. */ interface ViewportBase$UrlClickedEventParameters { /** * Returns a node reference of the note that contains the URL. */ nodeRef?: any; /** * Returns a URL that was clicked. */ url?: string; } /** * Parameters of the ViewportBase#viewActivated event. */ interface ViewportBase$ViewActivatedEventParameters { /** * Index of the activated view */ viewIndex?: int; /** * The activated view */ view?: sap.ui.vk.View; /** * The type of content loaded into the Viewport (for example: 2D, 3D). */ type?: string; } /** * Parameters of the ViewportBase#viewFinished event. */ interface ViewportBase$ViewFinishedEventParameters { viewIndex?: int; } /** * Parameters of the ViewStateManagerBase#highlightColorChanged event. */ interface ViewStateManagerBase$HighlightColorChangedEventParameters { /** * Highlighting color */ highlightColor?: sap.ui.core.CSSColor; /** * Highlighting color in the ABGR format. */ highlightColorABGR?: int; } /** * Parameters of the ViewStateManagerBase#nodeHierarchyReplaced event. */ interface ViewStateManagerBase$NodeHierarchyReplacedEventParameters { /** * Old node hierarchy */ oldNodeHierarchy?: sap.ui.vk.NodeHierarchy; /** * New node hierarchy */ newNodeHierarchy?: sap.ui.vk.NodeHierarchy; } /** * Parameters of the ViewStateManagerBase#opacityChanged event. */ interface ViewStateManagerBase$OpacityChangedEventParameters { /** * References of nodes whose opacity changed. */ changed?: any[]; /** * Opacity assigned to the nodes. Could be either `float` or `float[]` if event was fired from a bulk operation. */ opacity?: any; } /** * Parameters of the ViewStateManagerBase#outlineColorChanged event. */ interface ViewStateManagerBase$OutlineColorChangedEventParameters { /** * Outlining color */ outlineColor?: sap.ui.core.CSSColor; /** * Outlining color in the ABGR format. */ outlineColorABGR?: int; } /** * Parameters of the ViewStateManagerBase#outlineWidthChanged event. */ interface ViewStateManagerBase$OutlineWidthChangedEventParameters { /** * Outline width */ width?: float; } /** * Parameters of the ViewStateManagerBase#outliningChanged event. */ interface ViewStateManagerBase$OutliningChangedEventParameters { /** * References of newly outlined nodes. */ outlined?: any[]; /** * References of newly unoutlined nodes. */ unoutlined?: any[]; } /** * Parameters of the ViewStateManagerBase#readyForAnimation event. */ interface ViewStateManagerBase$ReadyForAnimationEventParameters { view?: sap.ui.vk.View; } /** * Parameters of the ViewStateManagerBase#selectionChanged event. */ interface ViewStateManagerBase$SelectionChangedEventParameters { /** * References of newly selected nodes. */ selected?: any[]; /** * References of newly unselected nodes. */ unselected?: any[]; } /** * Parameters of the ViewStateManagerBase#tintColorChanged event. */ interface ViewStateManagerBase$TintColorChangedEventParameters { /** * References of nodes whose tint color changed. */ changed?: any[]; /** * Tint color assigned to the nodes. Could be either `sap.ui.core.CSSColor` or `sap.ui.core.CSSColor[]` * if event was fired from a bulk operation. */ tintColor?: any; /** * Tint color in the ABGR format assigned to the nodes. Could be either `int` or `int[]` if event was fired * from a bulk operation. */ tintColorABGR?: any; } /** * Parameters of the ViewStateManagerBase#transformationChanged event. */ interface ViewStateManagerBase$TransformationChangedEventParameters { /** * Reference to a changed node or array of node references. */ changed?: any; /** * Node's transformation or array of nodes' transforms Transformation object will contain the following * fields of type `float[]`: translation scale angleAxis | euler | quaternion */ transformation?: any; } /** * Parameters of the ViewStateManagerBase#viewStateApplied event. */ interface ViewStateManagerBase$ViewStateAppliedEventParameters { view?: sap.ui.vk.View; } /** * Parameters of the ViewStateManagerBase#viewStateApplying event. */ interface ViewStateManagerBase$ViewStateApplyingEventParameters { view?: sap.ui.vk.View; } /** * Parameters of the ViewStateManagerBase#visibilityChanged event. */ interface ViewStateManagerBase$VisibilityChangedEventParameters { /** * References of newly shown nodes. */ visible?: any[]; /** * References of newly hidden nodes. */ hidden?: any[]; } /** * This type defines possible valid values for property {@link sap.ui.vk.ContentResource#getIncludeUsageId ContentResource.includeUsageId}. * * The possible valid values: * `true` - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined * for the tenant which are not relevant to the current application. `false` - Do not load any UsageIds. * `string` - A single non-empty string which defines the name of the requested UsageId. `string[]` * - An array of non-empty strings which define the names of requested UsageIds. * * @since 1.96.0 */ interface IncludeUsageIdType {} /** * A utility class with static methods to work with transformation matrices. * * @since 1.32.0 */ interface TransformationMatrix { /** * Converts matrix from 3x2 to 4x3. * * * ```javascript * * m0 m2 x m0 m2 0 x * m1 m3 y → m1 m3 0 y * 0 0 1 0 * ``` * * * * @returns The matrix 4x3 with the last row removed from matrix4x4. */ convert3x2To4x3( /** * The matrix to convert. */ m3x2: float[] ): float[]; /** * Converts matrix from 4x3 to 3x2. * * * ```javascript * * m0 m3 m6 x m0 m3 x * m1 m4 m7 y → m1 m4 y * m2 m5 m8 z * ``` * * * * @returns The matrix 3x2. */ convert4x3To3x2( /** * The matrix 4x3 to convert. */ m4x3: float[] ): float[]; /** * Converts matrix from 4x4 to 3x2. * * * ```javascript * * m0 m4 m8 x m0 m4 x * m1 m5 m9 y → m1 m5 y * m2 m6 m10 z * m3 m7 m11 1 * ``` * * * * @returns The matrix 3x2. */ convert4x4To3x2( /** * The matrix 4x4 to convert. */ m4x4: float[] ): float[]; /** * Converts matrix from 4x4 or 4x3 to 3x2. * * * @returns The matrix 3x2. */ convertTo3x2( /** * The matrix 4x4 or 4x3 to convert. */ m: float[] ): float[]; /** * Converts matrix from 4x4 to 4x3. * * * ```javascript * * m0 m3 m6 x m0 m3 m6 x * m1 m4 m7 y → m1 m4 m7 y * m2 m5 m8 z m2 m5 m8 z * 0 0 0 1 * ``` * * * * @returns The matrix 4x3 with the last row removed from matrix4x4. */ convertTo4x3( /** * The matrix to convert. The last row must be [0, 0, 0, 1]. */ matrix4x4: float[] ): float[]; /** * Converts matrix from 4x3 to 4x4. * * * ```javascript * * m0 m3 m6 x m0 m3 m6 x * m1 m4 m7 y → m1 m4 m7 y * m2 m5 m8 z m2 m5 m8 z * 0 0 0 1 * ``` * * * * @returns The matrix 4x4 with [0, 0, 0, 1] in the last row. */ convertTo4x4( /** * The matrix to convert. */ matrix4x3: float[] ): float[]; /** * Parses the given string value and converts it into an array of numbers. * * * @returns an array of 12 or 16 numbers */ parseValue( /** * a comma or white space delimited string */ value: string ): float[]; } /** * Provides definition for an animation playback * * @since 1.67.0 */ class AnimationPlayer extends sap.ui.core.Element { /** * Constructor for a new AnimationPlayer. * * The objects of this class contain necessary information to define how an animation sequence is played * * 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(); /** * Creates a new subclass of class sap.ui.vk.AnimationPlayer 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.AnimationPlayer. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:beforeTimeChanged beforeTimeChanged} event of * this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeTimeChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeTimeChanged beforeTimeChanged} event of * this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeTimeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachStateChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachStateChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:timeChanged timeChanged} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachTimeChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:timeChanged timeChanged} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachTimeChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewActivated viewActivated} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachViewActivated( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewActivated viewActivated} event of this `sap.ui.vk.AnimationPlayer`. * * 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.AnimationPlayer` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachViewActivated( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.AnimationPlayer` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeTimeChanged beforeTimeChanged} event * of this `sap.ui.vk.AnimationPlayer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeTimeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:stateChanged stateChanged} event of this `sap.ui.vk.AnimationPlayer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachStateChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:timeChanged timeChanged} event of this `sap.ui.vk.AnimationPlayer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachTimeChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewActivated viewActivated} event of this * `sap.ui.vk.AnimationPlayer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewActivated( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforeTimeChanged beforeTimeChanged} 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 */ fireBeforeTimeChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:stateChanged stateChanged} 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 */ fireStateChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:timeChanged timeChanged} 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 */ fireTimeChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:viewActivated viewActivated} 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 */ fireViewActivated( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Get the animated property of a node at the current time, should be called after {@link sap.ui.vk.AnimationPlayer#setTime setTime}. * * * @returns An object with the following properties: * - For `Translate`, `Rotate`, `Scale`: * `offsetToRest: float[]` - translation, scale or rotation in quaternion form relative to the values of * the rest transformation. If the property is not defined, `null` is assigned. * - `offsetToPrevious: float[]` - translation, scale or rotation relative to the values at the end of * the previous playback or the values of the rest transformation for the first playback. If the property * is not defined, `null` is assigned. Rotation is assigned in the form in which the animation track is * defined. * - `absolute: float[]` - values of translation, scale or rotation in quaternion form in the parent's * coordinate space. * - `world: float[]` - values of translation, scale or rotation in quaternion form in the world coordinate * space. * - For `Opacity`: * `offsetToRest: float` - opacity relative to the rest opacity. If the property is not defined, `null` * is assigned. * - `offsetToPrevious: float` - opacity relative to the value at the end of the previous playback or * the rest opacity for the first playback. If the property is not defined, `null` is assigned. * - `opacity: float` - the node's own opacity * - `totalOpacity: float` - the product of opacity values from all the ancestors and the node's own opacity. */ getAnimatedProperty( /** * A node reference */ nodeRef: any, /** * A property name */ property: /* was: sap.ui.vk.AnimationTrackType */ any ): object; /** * Gets animation playback currently playing. * * * @returns animation playback. */ getCurrentPlayback(): /* was: sap.ui.vk.AnimationPlayback */ any; /** * Gets current animation time position in the current animation playback. * * * @returns animation time. */ getCurrentPlaybackTime(): float; /** * Gets start time for specified animation playback. * * * @returns animation start time. */ getStartTime( /** * Animation playback or animation playback index in the current view. */ playback: /* was: sap.ui.vk.AnimationPlayback */ any | int ): float; /** * Gets current absolute animation time position. * * * @returns animation time. */ getTime(): float; /** * Gets current total animation duration. * * * @returns animation duration. */ getTotalDuration(): float; /** * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager}, * or `null`. */ getViewStateManager(): sap.ui.core.ID | null; /** * Starts playing animation from the current time position. * * * @returns `this` to allow method chaining. */ play(): this; /** * Moves animation to a specified time. * * * @returns `this` to allow method chaining. */ setTime( /** * Time to set */ time: float, /** * Optional, when specified, `time` is relative to beginning of specified playback. */ playbackIndex: int, /** * Optional, block the beforeTimeChanged and timeChanged events */ blockTimeChangeEvents: boolean ): this; /** * Moves animation to a specified time. * * * @returns `this` to allow method chaining. */ setTime( /** * Time to set */ time: float, /** * Optional, block the beforeTimeChanged and timeChanged events */ blockTimeChangeEvents: boolean ): 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: sap.ui.core.ID | sap.ui.vk.ViewStateManagerBase ): this; /** * Stops playing animation. * * * @returns `this` to allow method chaining. */ stop(): this; } /** * Annotation allows applications to display custom html annotation on top of Viewport and associate it * with 3D object * * @since 1.76.0 */ class Annotation extends sap.ui.core.Control { /** * Constructor for a new Annotation. * * 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(); /** * The main method for creation of annotations * * * @returns Newly create annotation */ static createAnnotation( /** * Object with annotation settings */ divAnnotation: any, /** * Viewport where annotation are displayed */ viewport: sap.ui.vk.Viewport ): sap.ui.vk.Annotation; /** * Creates a new subclass of class sap.ui.vk.Annotation 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Annotation. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the textEditor in the aggregation {@link #getTextEditor textEditor}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTextEditor(): this; /** * Adjust annotation size to fit text * * * @returns `this` to allow method chaining */ fitToText( /** * If set then maximum width of annotation will be limited to this number in pixels. */ maxWidth?: number, /** * If set then maximum height of annotation will be limited to this number in pixels. */ maxHeight?: number ): this; /** * Gets current value of property {@link #getAnimate animate}. * * Controls the animation of the annotation. If set to `false` then animation is not played. * * Default value is `true`. * * * @returns Value of property `animate` */ getAnimate(): boolean; /** * Gets current value of property {@link #getAnimationDelay animationDelay}. * * Amount of time in seconds to wait before animation is played. Default value of -1 means that this is * not set. * * Default value is `-1`. * * * @returns Value of property `animationDelay` */ getAnimationDelay(): float; /** * Gets current value of property {@link #getAnnotationId annotationId}. * * Reference to the annotation Id * * * @returns Value of property `annotationId` */ getAnnotationId(): string; /** * Gets current value of property {@link #getDisplay display}. * * Controls the visibility of the annotation * * Default value is `false`. * * * @returns Value of property `display` */ getDisplay(): boolean; /** * Gets current value of property {@link #getEditable editable}. * * If annotation is editable then double click event is fired when user double clicks on the annotation * and text editing is allowed by calling openEditor() method. If annotation is also selected then resize * and reposition handles will be displayed. * * Default value is `false`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Sets the height of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. * * * @returns Value of property `height` */ getHeight(): float; /** * Gets current value of property {@link #getName name}. * * Reference to the annotation name * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getNodeRef nodeRef}. * * Reference to the node that represents the annotation * * * @returns Value of property `nodeRef` */ getNodeRef(): any; /** * Gets current value of property {@link #getSelected selected}. * * Controls the annotation selected state * * Default value is `false`. * * * @returns Value of property `selected` */ getSelected(): boolean; /** * Gets current value of property {@link #getStyle style}. * * The style of the annotation * * Default value is `Default`. * * * @returns Value of property `style` */ getStyle(): sap.ui.vk.AnnotationStyle; /** * Return list of target nodes. * * * @returns Target nodes for leader lines */ getTargetNodes(): any[]; /** * Gets current value of property {@link #getText text}. * * The text that will be displayed in the annotation * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets content of aggregation {@link #getTextEditor textEditor}. */ getTextEditor(): sap.ui.core.Control; /** * Get transformation matrix from the annotation node * * * @returns The transformation matrix */ getTransform(): number[]; /** * ID of the element which is the current target of the association {@link #getViewport viewport}, or `null`. */ getViewport(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * Sets the width of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. * * * @returns Value of property `width` */ getWidth(): float; /** * Gets current value of property {@link #getXCoordinate xCoordinate}. * * Sets the X Coordinate of the annotation. This uses a scale of -0.5 to 0.5, left to right respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. * * Default value is `0`. * * * @returns Value of property `xCoordinate` */ getXCoordinate(): float; /** * Gets current value of property {@link #getXOffset xOffset}. * * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, left * to right respectively. * * Default value is `0`. * * * @returns Value of property `xOffset` */ getXOffset(): float; /** * Gets current value of property {@link #getYCoordinate yCoordinate}. * * Sets the Y Coordinate of the annotation. This uses a scale of -0.5 to 0.5, top to bottom respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. * * Default value is `0`. * * * @returns Value of property `yCoordinate` */ getYCoordinate(): float; /** * Gets current value of property {@link #getYOffset yOffset}. * * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, top * to bottom respectively. * * Default value is `0`. * * * @returns Value of property `yOffset` */ getYOffset(): float; /** * Sets a new value for property {@link #getAnimate animate}. * * Controls the animation of the annotation. If set to `false` then animation is not played. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAnimate( /** * New value for property `animate` */ bAnimate?: boolean ): this; /** * Sets a new value for property {@link #getAnimationDelay animationDelay}. * * Amount of time in seconds to wait before animation is played. Default value of -1 means that this is * not set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `-1`. * * * @returns Reference to `this` in order to allow method chaining */ setAnimationDelay( /** * New value for property `animationDelay` */ fAnimationDelay?: float ): this; /** * Sets a new value for property {@link #getAnnotationId annotationId}. * * Reference to the annotation Id * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setAnnotationId( /** * New value for property `annotationId` */ sAnnotationId: string ): this; /** * Sets a new value for property {@link #getDisplay display}. * * Controls the visibility of the annotation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplay( /** * New value for property `display` */ bDisplay?: boolean ): this; /** * Sets a new value for property {@link #getEditable editable}. * * If annotation is editable then double click event is fired when user double clicks on the annotation * and text editing is allowed by calling openEditor() method. If annotation is also selected then resize * and reposition handles will be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Sets the height of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ fHeight: float ): this; /** * Adjust annotation size and position so it is placed close to the object it's pointing to. This method * can be used if precise position is not known by the application. * * * @returns `this` to allow method chaining */ setInitialOffset(): this; /** * Sets a new value for property {@link #getName name}. * * Reference to the annotation name * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; /** * Sets a new value for property {@link #getNodeRef nodeRef}. * * Reference to the node that represents the annotation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setNodeRef( /** * New value for property `nodeRef` */ oNodeRef: any ): this; /** * Sets a new value for property {@link #getSelected selected}. * * Controls the annotation selected state * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSelected( /** * New value for property `selected` */ bSelected?: boolean ): this; /** * Sets a new value for property {@link #getStyle style}. * * The style of the annotation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setStyle( /** * New value for property `style` */ sStyle?: sap.ui.vk.AnnotationStyle ): this; /** * Sets a new value for property {@link #getText text}. * * The text that will be displayed in the annotation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; /** * Sets the aggregated {@link #getTextEditor textEditor}. * * * @returns Reference to `this` in order to allow method chaining */ setTextEditor( /** * The textEditor to set */ oTextEditor: sap.ui.core.Control ): this; /** * Set transformation matrix to the annotation node * * * @returns `this` to allow method chaining. */ setTransform( /** * The transformation matrix */ transform: number[] ): this; /** * Sets the associated {@link #getViewport viewport}. * * * @returns Reference to `this` in order to allow method chaining */ setViewport( /** * ID of an element which becomes the new target of this viewport association; alternatively, an element * instance may be given */ oViewport: sap.ui.core.ID | sap.ui.vk.Viewport ): this; /** * Sets a new value for property {@link #getWidth width}. * * Sets the width of the annotation. This uses a scale of 0 to 1, 0% to 100% respectively. This is relative * to the Viewport's safe area if present, otherwise it is relative to the Viewport. Negative values will * be ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ fWidth: float ): this; /** * Sets a new value for property {@link #getXCoordinate xCoordinate}. * * Sets the X Coordinate of the annotation. This uses a scale of -0.5 to 0.5, left to right respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setXCoordinate( /** * New value for property `xCoordinate` */ fXCoordinate?: float ): this; /** * Sets a new value for property {@link #getXOffset xOffset}. * * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, left * to right respectively. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setXOffset( /** * New value for property `xOffset` */ fXOffset?: float ): this; /** * Sets a new value for property {@link #getYCoordinate yCoordinate}. * * Sets the Y Coordinate of the annotation. This uses a scale of -0.5 to 0.5, top to bottom respectively. * This is relative to the Viewport's safe area if present, otherwise it is relative to the Viewport. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setYCoordinate( /** * New value for property `yCoordinate` */ fYCoordinate?: float ): this; /** * Sets a new value for property {@link #getYOffset yOffset}. * * Sets horizontal offset of annotation's position relative to the point where it should be normally placed. * Can be used to offset annotation from attachment node (if set). This uses a scale of -0.5 to 0.5, top * to bottom respectively. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setYOffset( /** * New value for property `yOffset` */ fYOffset?: float ): this; } /** * Provides a simple, lightweight proxy object to a node in a node hierarchy. * * The objects of this class should not be created directly, and should only be created through the use * of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } */ abstract class BaseNodeProxy extends sap.ui.base.Object implements sap.ui.base.Poolable, sap.ui.vk.BaseNodeProxy { __implements__sap_ui_base_Poolable: boolean; __implements__sap_ui_vk_BaseNodeProxy: boolean; /** * Constructor for a new BaseNodeProxy. The objects of this class should not be created directly, and should * only be created through the use of the following methods: * - {@link sap.ui.vk.NodeHierarchy#enumerateChildren sap.ui.vk.NodeHierarchy.enumerateChildren} * - {@link sap.ui.vk.NodeHierarchy#enumerateAncestors sap.ui.vk.NodeHierarchy.enumerateAncestors} * - {@link sap.ui.vk.ViewStateManager#enumerateSelection sap.ui.vk.ViewStateManager.enumerateSelection } * * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.BaseNodeProxy 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.base.Object.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.BaseNodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Indicates whether the node has child nodes. * * * @returns A value of `true` indicates that the node has child nodes, and a value of `false` indicates * otherwise. */ getHasChildren(): boolean; /** * Gets the name of the node. * * * @returns The node's name. */ getName(): string; /** * Gets the ID of the node. * * * @returns The node's ID. */ getNodeId(): string; /** * Gets the metadata of the node. * * * @returns A JSON object containing the node's metadata. */ getNodeMetadata(): object; /** * Gets the reference object of the node. * * * @returns The node's reference object. */ getNodeRef(): any; /** * Gets the scene reference that this BaseNodeProxy object wraps. * * * @returns A scene reference that this BaseNodeProxy object wraps. */ getSceneRef(): any; /** * Initialize this BaseNodeProxy with its data. * * The `init` method is called by an object pool when the object is (re-)activated for a new caller. * See: * sap.ui.base.Poolable.prototype#init * * @ui5-protected Do not call from applications (only from related classes in the framework) */ init( /** * The NodeHierarchy object this BaseNodeProxy object belongs to. */ nodeHierarchy: sap.ui.vk.NodeHierarchy, /** * The ID or reference (depending on the concrete BaseNodeProxy implementation) of the node for which to * get BaseNodeProxy. */ nodeRef: any ): void; /** * Reset BaseNodeProxy data, needed for pooling. * See: * sap.ui.base.Poolable.prototype#reset * * @ui5-protected Do not call from applications (only from related classes in the framework) */ reset(): void; } /** * Provides the base interface for the camera. * * The objects of this class should not be created directly. Use PerspectiveCamera or OrthographicCamera * instead. * * @since 1.52.0 */ abstract class Camera extends sap.ui.base.ManagedObject { /** * Constructor for a new Camera. * * 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(); /** * Creates a new subclass of class sap.ui.vk.Camera 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Camera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * * @returns Camera reference that this camera class wraps */ getCameraRef(): any; /** * Gets current value of property {@link #getFarClipPlane farClipPlane}. * * Far clipping plane distance * * Default value is `1.0`. * * * @returns Value of property `farClipPlane` */ getFarClipPlane(): float; /** * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Flag indicating if camera object is modified */ getIsModified(): boolean; /** * Gets current value of property {@link #getNearClipPlane nearClipPlane}. * * Near clipping plane distance * * Default value is `0.1`. * * * @returns Value of property `nearClipPlane` */ getNearClipPlane(): float; /** * Gets current value of property {@link #getPosition position}. * * Camera position in global space (x, y, z coordinates) * * Default value is `[0, 0, 0]`. * * * @returns Value of property `position` */ getPosition(): float[]; /** * Gets current value of property {@link #getTargetDirection targetDirection}. * * Camera direction vector in global space (normalized x, y, z vector values) * * Default value is `[1, 0, 0]`. * * * @returns Value of property `targetDirection` */ getTargetDirection(): float[]; /** * Gets current value of property {@link #getUpDirection upDirection}. * * Camera up vector in global space (normalized x, y, z vector values) * * Default value is `[0, 1, 0]`. * * * @returns Value of property `upDirection` */ getUpDirection(): float[]; /** * Sets a new value for property {@link #getFarClipPlane farClipPlane}. * * Far clipping plane distance * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1.0`. * * * @returns Reference to `this` in order to allow method chaining */ setFarClipPlane( /** * New value for property `farClipPlane` */ fFarClipPlane?: float ): this; /** * @ui5-protected Do not call from applications (only from related classes in the framework) */ setIsModified( /** * Set or reset flag to indicate if this object is modified */ val: boolean ): void; /** * Sets a new value for property {@link #getNearClipPlane nearClipPlane}. * * Near clipping plane distance * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.1`. * * * @returns Reference to `this` in order to allow method chaining */ setNearClipPlane( /** * New value for property `nearClipPlane` */ fNearClipPlane?: float ): this; /** * Sets a new value for property {@link #getPosition position}. * * Camera position in global space (x, y, z coordinates) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[0, 0, 0]`. * * * @returns Reference to `this` in order to allow method chaining */ setPosition( /** * New value for property `position` */ sPosition?: float[] ): this; /** * Sets a new value for property {@link #getTargetDirection targetDirection}. * * Camera direction vector in global space (normalized x, y, z vector values) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[1, 0, 0]`. * * * @returns Reference to `this` in order to allow method chaining */ setTargetDirection( /** * New value for property `targetDirection` */ sTargetDirection?: float[] ): this; /** * Sets a new value for property {@link #getUpDirection upDirection}. * * Camera up vector in global space (normalized x, y, z vector values) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[0, 1, 0]`. * * * @returns Reference to `this` in order to allow method chaining */ setUpDirection( /** * New value for property `upDirection` */ sUpDirection?: float[] ): this; } /** * Abstract Constructor for a new Container. * * @since 1.38.0 * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerBase} */ class ContainerBase extends sap.ui.core.Control { /** * Abstract Constructor for a new Container. * * 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?: sap.ui.vk.$ContainerBaseSettings ); /** * Abstract Constructor for a new Container. * * 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?: sap.ui.vk.$ContainerBaseSettings ); /** * Creates a new subclass of class sap.ui.vk.ContainerBase 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ContainerBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * adjusts customizable buttons of overflow toolbar, displays content buttons * * @ui5-protected Do not call from applications (only from related classes in the framework) */ _addToolbarContent(): void; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * add container content - map, table.. */ addContent( /** * content object to add */ oObject: sap.ui.vk.ContainerContent ): void; /** * Attaches event handler `fnFunction` to the {@link #event:contentChange contentChange} event of this `sap.ui.vk.ContainerBase`. * * 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.ContainerBase` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChange( /** * 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: ContainerBase$ContentChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContainerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChange contentChange} event of this `sap.ui.vk.ContainerBase`. * * 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.ContainerBase` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ContainerBase$ContentChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContainerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:settingsPressed settingsPressed} event of this * `sap.ui.vk.ContainerBase`. * * 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.ContainerBase` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachSettingsPressed( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContainerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:settingsPressed settingsPressed} event of this * `sap.ui.vk.ContainerBase`. * * 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.ContainerBase` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachSettingsPressed( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContainerBase` itself */ oListener?: object ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChange contentChange} event of this * `sap.ui.vk.ContainerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContainerBase$ContentChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:settingsPressed settingsPressed} event of * this `sap.ui.vk.ContainerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSettingsPressed( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:contentChange contentChange} 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 */ fireContentChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContainerBase$ContentChangeEventParameters ): this; /** * Fires event {@link #event:settingsPressed settingsPressed} 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 */ fireSettingsPressed( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getAutoAdjustHeight autoAdjustHeight}. * * Default value is `false`. * * * @returns Value of property `autoAdjustHeight` */ getAutoAdjustHeight(): boolean; /** * Gets content of aggregation {@link #getContent content}. * * Content Aggregation. */ getContent(): sap.ui.vk.ContainerContent[]; /** * Gets current value of property {@link #getFullScreen fullScreen}. * * Controls whether the control is show fullscreen or embedded * * Default value is `false`. * * * @returns Value of property `fullScreen` */ getFullScreen(): boolean; /** * get selected content * * * @returns the currently selected content container */ getSelectedContent(): sap.ui.vk.ContainerContent; /** * Gets current value of property {@link #getShowFullScreen showFullScreen}. * * Show fullscreen toggle button in toolbar * * Default value is `true`. * * * @returns Value of property `showFullScreen` */ getShowFullScreen(): boolean; /** * Gets current value of property {@link #getShowSelection showSelection}. * * Show selection button in toolbar * * Default value is `true`. * * * @returns Value of property `showSelection` */ getShowSelection(): boolean; /** * Gets current value of property {@link #getShowSettings showSettings}. * * Show settings button in toolbar * * Default value is `true`. * * * @returns Value of property `showSettings` */ getShowSettings(): boolean; /** * Gets current value of property {@link #getTitle title}. * * Title to show in toolbar * * Default value is `empty string`. * * * @returns Value of property `title` */ getTitle(): string; /** * Checks for the provided `sap.ui.vk.ContainerContent` in the aggregation {@link #getContent content}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.vk.ContainerContent ): int; /** * insert container content - map, table.. */ insertContent( /** * content object to insert */ oObject: sap.ui.vk.ContainerContent, /** * index in the content aggregation where to insert the new content object */ iIndex: int ): void; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): sap.ui.core.ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.vk.ContainerContent[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.vk.ContainerContent ): sap.ui.vk.ContainerContent | null; /** * Sets a new value for property {@link #getAutoAdjustHeight autoAdjustHeight}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoAdjustHeight( /** * New value for property `autoAdjustHeight` */ bAutoAdjustHeight?: boolean ): this; /** * set FullScreen - default is normal mode, but app can call this method to set the default to full screen */ setFullScreen( /** * Fullscreen mode on or off */ bFullScreen: boolean ): void; /** * set selected content */ setSelectedContent( /** * the selected content; involves no re-rendering */ oContent: sap.ui.vk.ContainerContent ): void; /** * Sets a new value for property {@link #getShowFullScreen showFullScreen}. * * Show fullscreen toggle button in toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowFullScreen( /** * New value for property `showFullScreen` */ bShowFullScreen?: boolean ): this; /** * Sets a new value for property {@link #getShowSelection showSelection}. * * Show selection button in toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSelection( /** * New value for property `showSelection` */ bShowSelection?: boolean ): this; /** * Sets a new value for property {@link #getShowSettings showSettings}. * * Show settings button in toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSettings( /** * New value for property `showSettings` */ bShowSettings?: boolean ): this; /** * Display title */ setTitle( /** * the title */ sValue: string ): void; /** * default Content could be defined in application */ switchContent( /** * the content to be visible; involves re-rendering */ oContent: sap.ui.vk.ContainerContent ): void; /** * update container to allow dynamic change button layout */ updateContainer(): void; } /** * Aggregation element for the Container Base * * @since 1.38.0 * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerContent} */ class ContainerContent extends sap.ui.core.Control { /** * Constructor for a new ContainerContent. * * 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?: sap.ui.vk.$ContainerContentSettings ); /** * Constructor for a new ContainerContent. * * 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?: sap.ui.vk.$ContainerContentSettings ); /** * Creates a new subclass of class sap.ui.vk.ContainerContent 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ContainerContent. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets content of aggregation {@link #getContent content}. */ getContent(): sap.ui.core.Control; /** * Gets current value of property {@link #getIcon icon}. * * Icon to show up in the toolbar * * * @returns Value of property `icon` */ getIcon(): string; /** * Gets current value of property {@link #getTitle title}. * * Title for the icon in the toolbar * * * @returns Value of property `title` */ getTitle(): string; /** * Sets the aggregated {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ setContent( /** * The content to set */ oContent: sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Icon to show up in the toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setIcon( /** * New value for property `icon` */ sIcon?: string ): this; /** * Sets a new value for property {@link #getTitle title}. * * Title for the icon in the toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; } /** * Provides an object that owns content resources, tracks their changes and loads and destroys the content * built from the content resources. */ class ContentConnector extends sap.ui.core.Element { /** * Constructor for a new ContentConnector. * * 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 ContentConnector object. */ mSettings?: sap.ui.vk.$ContentConnectorSettings ); /** * Constructor for a new ContentConnector. * * 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 ContentConnector object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ContentConnector object. */ mSettings?: sap.ui.vk.$ContentConnectorSettings ); /** * Adds a new content manager resolver. * * The last added resolver will be executed the first. * * Content manager resolver analyzes the content resource definition and returns the type of the content * manager to use for loading the content resource. * * The simplest resolver tests the content resource source type. The test can be either a string comparison * or a regular expression. * * A more sophisticated resolver is a function that can use the full content resource definition to find * a proper content manager dynamically, e.g. the resolver can use the 'HEAD' HTTP request to get the 'Content-Type' * header to find out the type of the content resource. * * @since 1.50.0 * * @returns The {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector} class to allow method chaining. */ static addContentManagerResolver( /** * Object that defines how to find out the content manager class name. * If `resolver` is a function then this function takes one parameter of type {@link sap.ui.vk.ContentResource sap.ui.vk.ContentResource } * and returns a {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise } * that resolves with an object with the following properties: * - `dimension: int` - dimension of the model. E.g. 2 or 3. * - `contentManagerClassName: string` - name of content manager class to use for loading the content * resource. * - `settings: object` - optional settings specific to the content manager. * See {@link sap.ui.vk.threejs.ContentManager sap.ui.vk.threejs.ContentManager}. If `resolver` is * an object then it has the following properties: */ resolver: | Function | { /** * The pattern the {@link sap.ui.vk.ContentResource#getSourceType sourceType} property of the content resource * is compared with. */ pattern?: string | RegExp; /** * Dimension of models of this source type. E.g. 2 or 3. */ dimension?: int; /** * Name of the content manager class to use for loading content resources of this type. E.g. sap.ui.vk.dvl.ContentManager, * sap.ui.vk.threejs.ContentManager, sap.ui.vk.ImageContentManager. */ contentManagerClassName?: string; /** * Optional settings specific to the content manager class. */ settings?: object; } ): Function; /** * Creates a new subclass of class sap.ui.vk.ContentConnector 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ContentConnector. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Removes all content manager resolvers. * * @since 1.50.0 * * @returns The {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector} class to allow method chaining. */ static removeAllContentManagerResolvers(): Function; /** * Removes a content manager resolver. * * If there are more than one content manager resolver matching the `resolver` the last added is removed. * * @since 1.50.0 * * @returns `true` if a matching resolver is found and removed, `false` otherwise. */ static removeContentManagerResolver( /** * Object that defines how to find out the content manager class name. */ resolver: Function | string | RegExp | object ): boolean; /** * Adds some contentResource to the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ addContentResource( /** * The contentResource to add; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource ): this; /** * Adds some viewStateManager to the aggregation {@link #getViewStateManagers viewStateManagers}. * * * @returns Reference to `this` in order to allow method chaining */ addViewStateManager( /** * The viewStateManager to add; if empty, nothing is inserted */ oViewStateManager: sap.ui.vk.ViewStateManagerBase ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesFinished( /** * 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: ContentConnector$ContentChangesFinishedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesFinished( /** * The function to be called when the event occurs */ fnFunction: ( p1: ContentConnector$ContentChangesFinishedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired to report the progress of content changes. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesProgress( /** * 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: ContentConnector$ContentChangesProgressEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired to report the progress of content changes. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesProgress( /** * The function to be called when the event occurs */ fnFunction: ( p1: ContentConnector$ContentChangesProgressEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when content resource changes are about to be processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesStarted( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when content resource changes are about to be processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesStarted( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentDestroying contentDestroying} event of * this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when the current content is about to be destroyed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentDestroying( /** * 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: ContentConnector$ContentDestroyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentDestroying contentDestroying} event of * this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when the current content is about to be destroyed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentDestroying( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentConnector$ContentDestroyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when content loading is finished. * * * @returns Reference to `this` in order to allow method chaining */ attachContentLoadingFinished( /** * 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: ContentConnector$ContentLoadingFinishedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when content loading is finished. * * * @returns Reference to `this` in order to allow method chaining */ attachContentLoadingFinished( /** * The function to be called when the event occurs */ fnFunction: ( p1: ContentConnector$ContentLoadingFinishedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentReplaced contentReplaced} event of this * `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when the current content is completely rebuilt or destroyed as a result of changes * in content resources. * * * @returns Reference to `this` in order to allow method chaining */ attachContentReplaced( /** * 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: ContentConnector$ContentReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentReplaced contentReplaced} event of this * `sap.ui.vk.ContentConnector`. * * 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.ContentConnector` itself. * * This event will be fired when the current content is completely rebuilt or destroyed as a result of changes * in content resources. * * * @returns Reference to `this` in order to allow method chaining */ attachContentReplaced( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentConnector$ContentReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentConnector` itself */ oListener?: object ): this; /** * Binds aggregation {@link #getContentResources contentResources} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindContentResources( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo ): this; /** * Destroys all the contentResources in the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContentResources(): this; /** * Destroys all the viewStateManagers in the aggregation {@link #getViewStateManagers viewStateManagers}. * * * @returns Reference to `this` in order to allow method chaining */ destroyViewStateManagers(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesFinished( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ContentConnector$ContentChangesFinishedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesProgress( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ContentConnector$ContentChangesProgressEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesStarted( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentDestroying contentDestroying} event * of this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentDestroying( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentConnector$ContentDestroyingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentLoadingFinished( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ContentConnector$ContentLoadingFinishedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentReplaced contentReplaced} event of * this `sap.ui.vk.ContentConnector`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentReplaced( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentConnector$ContentReplacedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:contentChangesFinished contentChangesFinished} 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 */ fireContentChangesFinished( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentConnector$ContentChangesFinishedEventParameters ): this; /** * Fires event {@link #event:contentChangesProgress contentChangesProgress} 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 */ fireContentChangesProgress( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentConnector$ContentChangesProgressEventParameters ): this; /** * Fires event {@link #event:contentChangesStarted contentChangesStarted} 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 */ fireContentChangesStarted( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:contentDestroying contentDestroying} 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 */ fireContentDestroying( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentConnector$ContentDestroyingEventParameters ): this; /** * Fires event {@link #event:contentLoadingFinished contentLoadingFinished} 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 */ fireContentLoadingFinished( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentConnector$ContentLoadingFinishedEventParameters ): this; /** * Fires event {@link #event:contentReplaced contentReplaced} 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 */ fireContentReplaced( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentConnector$ContentReplacedEventParameters ): this; /** * Gets the content currently loaded. * * @since 1.50.0 * * @returns The content loaded. It can be HTMLImageElement, sap.ui.vk.Scene etc. */ getContent(): any; /** * Gets the content manager used to load the current content. * * @since 1.50.0 * * @returns The content manager used to load the current content. */ getContentManager(): sap.ui.vk.ContentManager; /** * Gets content of aggregation {@link #getContentResources contentResources}. * * Content resources to load and display. */ getContentResources(): sap.ui.vk.ContentResource[]; /** * Gets the default view state manager. * * The type of the default view state manager depends on the type of the currently loaded content. * * @since 1.99.0 * * @returns The default view state manager or `null`. */ getDefaultViewStateManager(): sap.ui.vk.ViewStateManagerBase | null; /** * Gets content of aggregation {@link #getViewStateManagers viewStateManagers}. * * View state managers. */ getViewStateManagers(): sap.ui.vk.ViewStateManagerBase[]; /** * Checks for the provided `sap.ui.vk.ContentResource` in the aggregation {@link #getContentResources contentResources}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContentResource( /** * The contentResource whose index is looked for */ oContentResource: sap.ui.vk.ContentResource ): int; /** * Checks for the provided `sap.ui.vk.ViewStateManagerBase` in the aggregation {@link #getViewStateManagers viewStateManagers}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfViewStateManager( /** * The viewStateManager whose index is looked for */ oViewStateManager: sap.ui.vk.ViewStateManagerBase ): int; /** * Inserts a contentResource into the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ insertContentResource( /** * The contentResource to insert; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource, /** * The `0`-based index the contentResource should be inserted at; for a negative value of `iIndex`, the * contentResource is inserted at position 0; for a value greater than the current size of the aggregation, * the contentResource is inserted at the last position */ iIndex: int ): this; /** * Inserts a viewStateManager into the aggregation {@link #getViewStateManagers viewStateManagers}. * * * @returns Reference to `this` in order to allow method chaining */ insertViewStateManager( /** * The viewStateManager to insert; if empty, nothing is inserted */ oViewStateManager: sap.ui.vk.ViewStateManagerBase, /** * The `0`-based index the viewStateManager should be inserted at; for a negative value of `iIndex`, the * viewStateManager is inserted at position 0; for a value greater than the current size of the aggregation, * the viewStateManager is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContentResources contentResources}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContentResources(): sap.ui.vk.ContentResource[]; /** * Removes all the controls from the aggregation {@link #getViewStateManagers viewStateManagers}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllViewStateManagers(): sap.ui.vk.ViewStateManagerBase[]; /** * Removes a contentResource from the aggregation {@link #getContentResources contentResources}. * * * @returns The removed contentResource or `null` */ removeContentResource( /** * The contentResource to remove or its index or id */ vContentResource: int | string | sap.ui.vk.ContentResource ): sap.ui.vk.ContentResource | null; /** * Removes a viewStateManager from the aggregation {@link #getViewStateManagers viewStateManagers}. * * * @returns The removed viewStateManager or `null` */ removeViewStateManager( /** * The viewStateManager to remove or its index or id */ vViewStateManager: int | string | sap.ui.vk.ViewStateManagerBase ): sap.ui.vk.ViewStateManagerBase | null; /** * Sets a callback function which will be used to obtain authorization token when connected to remote server. * * @since 1.60.0 * * @returns Reference to `this` in order to allow method chaining. */ setAuthorizationHandler( /** * An application defined callback function that can provide authorization token. */ handler: sap.ui.vk.AuthorizationHandler ): this; /** * Set the consumption scenario (used in SAP/partner applications). * * @since 1.114.0 * * @returns `this` to allow method chaining. */ setConsumptionScenario( /** * The consumption scenario. */ consumptionScenario: string ): this; /** * Sets an object that decrypts content of encrypted models. * * @since 1.60.0 * * @returns Reference to `this` in order to allow method chaining. */ setDecryptionHandler( /** * An object that decrypts content of encrypted models. */ handler: sap.ui.vk.DecryptionHandler ): this; /** * Sets the maximum number of retry attempts for a download operation if the initial request to retrieve * a model from a remote server could not be fulfilled and the error with which the request failed is considered * recoverable. * * Retry Mechanism: Requests to retrieve (download) a model from a remote server may not always be fulfilled. * If the request failed with an error that is considered recoverable then the download manager will * keep on trying issuing new requests until the request is fulfilled or the specified `retryCount` is exceeded. * * The default number of retry attempts is 1, unless specified otherwise by calling this method. Note that, * specifying 0 as `retryCount` disables the retry mechanism altogether. * * **Timing of retry attempts**: There is no delay between subsequent attempts. * * **Events fired**: The download manager will not fire any events between subsequent attempts. For * each requested item there will be a single `itemSucceeded` or `itemFailed` event fired when the download * operation for that given item finishes. * * **Recoverable errors**: The following errors are considered recoverable: * - Any kind of network error (e.g. due to temporary network outage). HTTP status code is expected to * be 0. * - Responses with the following 4xx-5xx HTTP status codes: * 408: Request Timeout * - 425: Too Early (RFC 8470) * - 429: Too Many Requests (RFC 6585) * - 500: Internal Server Error * - 502: Bad Gateway * - 503: Service Unavailable * - 504: Gateway Timeout * * @since 1.95.0 * * @returns Reference to `this` in order to allow method chaining. */ setRetryCount( /** * Maximum number of retry attempts. Value must be non-negative. The default retry count is 1, unless specified * otherwise by calling this method and passing in the desired value. Passing in 0 disables any retry attempts. */ retryCount: int ): this; /** * Unbinds aggregation {@link #getContentResources contentResources} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindContentResources(): this; } /** * Provides a base loader interface. * * To load content a concrete loader class is to be used. * * @since 1.50.0 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ abstract class ContentManager extends sap.ui.base.ManagedObject { /** * Constructor for a new ContentManager. * * 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. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.$ContentManagerSettings ); /** * Constructor for a new ContentManager. * * 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. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * ID for the new ContentManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ContentManager object. */ mSettings?: sap.ui.vk.$ContentManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.ContentManager 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.base.ManagedObject.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ContentManager. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content resources have been loaded successfully or with a failure. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesFinished( /** * 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: ContentManager$ContentChangesFinishedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content resources have been loaded successfully or with a failure. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesFinished( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentManager$ContentChangesFinishedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired to report the progress of content changes. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesProgress( /** * 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: ContentManager$ContentChangesProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired to report the progress of content changes. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesProgress( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentManager$ContentChangesProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content resources are about to be loaded. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesStarted( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content resources are about to be loaded. * * * @returns Reference to `this` in order to allow method chaining */ attachContentChangesStarted( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content loading is finished. * * * @returns Reference to `this` in order to allow method chaining */ attachContentLoadingFinished( /** * 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: ContentManager$ContentLoadingFinishedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentManager`. * * 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.ContentManager` itself. * * This event will be fired when content loading is finished. * * * @returns Reference to `this` in order to allow method chaining */ attachContentLoadingFinished( /** * The function to be called when the event occurs */ fnFunction: (p1: ContentManager$ContentLoadingFinishedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ContentManager` itself */ oListener?: object ): this; /** * Collects and destroys unused objects and resources. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining. */ collectGarbage(): this; /** * Creates a Perspective camera * * @since 1.52.0 * * @returns Created Camera. */ createOrthographicCamera(): sap.ui.vk.OrthographicCamera; /** * Creates a Orthographic camera * * @since 1.52.0 * * @returns Created Camera. */ createPerspectiveCamera(): sap.ui.vk.PerspectiveCamera; /** * Destroys a camera for the content type * * @since 1.52.0 * * @returns Reference to `this` in order to allow method chaining. */ destroyCamera( /** * The camera to destroy. */ camera: any ): this; /** * Destroys the content. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining. */ destroyContent( /** * The content to destroy. */ content: any ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesFinished contentChangesFinished } * event of this `sap.ui.vk.ContentManager`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesFinished( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentManager$ContentChangesFinishedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesProgress contentChangesProgress } * event of this `sap.ui.vk.ContentManager`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesProgress( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentManager$ContentChangesProgressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChangesStarted contentChangesStarted } * event of this `sap.ui.vk.ContentManager`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentChangesStarted( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentLoadingFinished contentLoadingFinished } * event of this `sap.ui.vk.ContentManager`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentLoadingFinished( /** * The function to be called, when the event occurs */ fnFunction: (p1: ContentManager$ContentLoadingFinishedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:contentChangesFinished contentChangesFinished} 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 */ fireContentChangesFinished( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentManager$ContentChangesFinishedEventParameters ): this; /** * Fires event {@link #event:contentChangesProgress contentChangesProgress} 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 */ fireContentChangesProgress( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentManager$ContentChangesProgressEventParameters ): this; /** * Fires event {@link #event:contentChangesStarted contentChangesStarted} 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 */ fireContentChangesStarted( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:contentLoadingFinished contentLoadingFinished} 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 */ fireContentLoadingFinished( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ContentManager$ContentLoadingFinishedEventParameters ): this; /** * Starts downloading and building or updating the content from the content resources. * * This method is asynchronous. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining. */ loadContent( /** * The current content to update. It can be `null` if this is an initial loading call. */ content: any, /** * The content resources to load or update. */ contentResources: sap.ui.vk.ContentResource[] ): this; /** * Set the consumption scenario for metering differention. This value is passed in SAP-ConsumptionScenario * HTTP headers in requests made to the EPD Visualization backend when viewing. * * @since 1.114.0 * * @returns `this` to allow method chaining. */ setConsumptionScenario( /** * The consumption scenario. */ consumptionScenario: string ): this; /** * Sets the maximum number of retry attempts for a download operation if the initial request to retrieve * a model from a remote server could not be fulfilled and the error with which the request failed is considered * recoverable. * * See {@link sap.ui.vk.ContentConnector#setRetryCount} for details. * * @since 1.95.0 * * @returns Reference to `this` in order to allow method chaining. */ setRetryCount( /** * Maximum number of retry attempts. Value must be non-negative. The default number of retry attempts is * 1, unless specified otherwise by calling this method and passing in the desired value. Specifying 0 disables * any retry attempts. */ retryCount: int ): this; } /** * Specifies a resource to load. */ class ContentResource extends sap.ui.base.ManagedObject { /** * Constructor for a new ContentResource. * * 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( /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new content * resource. */ mSettings?: sap.ui.vk.$ContentResourceSettings, /** * scope An object for resolving string-based type and formatter references in bindings. */ oScope?: object ); /** * Constructor for a new ContentResource. * * 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 of the new content resource. `sId`is generated automatically if no non-empty ID is given. Note: this * can be omitted, regardless of whether `mSettings` will be provided or not. */ sId?: string, /** * An optional map/JSON object with initial property values, aggregated objects etc. for the new content * resource. */ mSettings?: sap.ui.vk.$ContentResourceSettings, /** * scope An object for resolving string-based type and formatter references in bindings. */ oScope?: object ); /** * Collects content resource categories. The result is tested if the content resource hierarchy has the * same category - 2D or 3D. * * @deprecated As of version 1.50.0. Content resource categories shall not be used anymore. See {@link sap.ui.vk.ContentResource#sourceType } * property for selection of content type. * * @returns The array of distinct content resource categories. */ static collectCategories( /** * The array of content resources. */ resources: sap.ui.vk.ContentResource[] ): /* was: sap.ui.vk.ContentResourceSourceCategory */ any[]; /** * Creates a new subclass of class sap.ui.vk.ContentResource 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ContentResource. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Adds some contentResource to the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ addContentResource( /** * The contentResource to add; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource ): this; /** * Destroys all the contentResources in the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContentResources(): this; /** * Gets current value of property {@link #getActivateView activateView}. * * Optional parameter with view id which shall be activated when scene is loaded. * * * @returns Value of property `activateView` */ getActivateView(): string; /** * Gets content of aggregation {@link #getContentResources contentResources}. * * Child content resources. */ getContentResources(): sap.ui.vk.ContentResource[]; /** * Gets current value of property {@link #getDependencyLoader dependencyLoader}. * * An object used to load content resource's dependencies. * * A content resource may have dependencies, e.g. if the loaded content resource is a shattered VDS file * it reference other VDS files. * * `dependencyLoader` should be an object with method `function load(uri: string, context: any): Promise<{buffer: * ArrayBuffer, context: any}>`, where `uri` is a reference to a dependency and `context` is opaque data. * * `uri` is application specific and can be a full URL or a relative file name or anything else, e.g. some * identifier known to `dependencyLoader`. * * * @returns Value of property `dependencyLoader` */ getDependencyLoader(): any; /** * Gets current value of property {@link #getEnableLogger enableLogger}. * * Optional boolean parameter to enable detailed logging. Can be used to track performance issues during * data streaming from SAP 3D Visualization Service. * * Default value is `false`. * * * @returns Value of property `enableLogger` */ getEnableLogger(): boolean; /** * Gets current value of property {@link #getIncludeAnimation includeAnimation}. * * Send structural data for animation objects, if false they will be omitted, reducing data size. Default: * true. * * Default value is `true`. * * * @returns Value of property `includeAnimation` */ getIncludeAnimation(): boolean; /** * Gets current value of property {@link #getIncludeBackground includeBackground}. * * If set to true, will return nodes with the type background * * Default value is `true`. * * * @returns Value of property `includeBackground` */ getIncludeBackground(): boolean; /** * Gets current value of property {@link #getIncludeHidden includeHidden}. * * Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: * true. * * Default value is `true`. * * * @returns Value of property `includeHidden` */ getIncludeHidden(): boolean; /** * Gets current value of property {@link #getIncludeMetadata includeMetadata}. * * If set to true, will load metadata * * Default value is `false`. * * * @returns Value of property `includeMetadata` */ getIncludeMetadata(): boolean; /** * Gets current value of property {@link #getIncludeParametric includeParametric}. * * If set to true, will load parametric nodes * * Default value is `true`. * * * @returns Value of property `includeParametric` */ getIncludeParametric(): boolean; /** * Gets current value of property {@link #getIncludeUsageId includeUsageId}. * * Optional parameter to load UsageIds. Valid values: * `true` - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined * for the tenant which are not relevant to the current application. `false` - Do not load any UsageIds. * `string` - A single non-empty string which defines the name of the requested UsageId. `string[]` * - An array of non-empty strings which define the names of requested UsageIds. * * Default value is `false`. * * * @returns Value of property `includeUsageId` */ getIncludeUsageId(): sap.ui.vk.IncludeUsageIdType; /** * Gets current value of property {@link #getLocalMatrix localMatrix}. * * The local transformation matrix of the node created for this content resource. * * * @returns Value of property `localMatrix` */ getLocalMatrix(): float[]; /** * Gets current value of property {@link #getMetadataFilter metadataFilter}. * * Optional metadata filter that can trim the tree before sending to the client only keeping nodes that * passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, * meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple * filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes * (e.g. breadcrumb) even if they don't pass the filter. * * * @returns Value of property `metadataFilter` */ getMetadataFilter(): string; /** * Gets current value of property {@link #getName name}. * * The name of the node created for this content resource. * * * @returns Value of property `name` */ getName(): string; /** * Gets the {@link sap.ui.vk.NodeProxy NodeProxy} object created for this content resource. * * If this is the only top level content resource, the {@link sap.ui.vk.NodeProxy NodeProxy} object is not * set since the grouping node is not created, which means that there may be multiple top level nodes. * * * @returns The {@link sap.ui.vk.NodeProxy NodeProxy} object created for this content resource if any, otherwise * `null`. */ getNodeProxy(): sap.ui.vk.NodeProxy; /** * Gets current value of property {@link #getPassword password}. * * The password to use when opening the resource. * * * @returns Value of property `password` */ getPassword(): string; /** * Gets current value of property {@link #getPushPMI pushPMI}. * * If set to true, elements for PMI rendering content will be returned. Default: false. * * Default value is `false`. * * * @returns Value of property `pushPMI` */ getPushPMI(): boolean; /** * Gets current value of property {@link #getPushViewGroups pushViewGroups}. * * If set to true, information of view groups will be returned. Default: true. * * Default value is `true`. * * * @returns Value of property `pushViewGroups` */ getPushViewGroups(): boolean; /** * Gets current value of property {@link #getSource source}. * * The source URL or the {@link https://developer.mozilla.org/en-US/docs/Web/API/File File} object of the * content resource/file to load from. The source may be omitted if a grouping node is needed. * * * @returns Value of property `source` */ getSource(): any; /** * Gets current value of property {@link #getSourceId sourceId}. * * The unique ID of the content resource. * * * @returns Value of property `sourceId` */ getSourceId(): string; /** * Gets content resource source properties. * * The content resource source properties depend on the content resource source type. They are different * for VDS and PNG for example. The list of possible source properties: * - version - object * major - number * - minor - number * - compressed - boolean * - encrypted - boolean The source properties are optional and the list might be extended in future * versions. * * * @returns A JSON like object containing the content resource source properties. */ getSourceProperties(): object; /** * Gets current value of property {@link #getSourceType sourceType}. * * The source type of the content resource. Valid types: * * * - vds * - vds4 * - vds4-2d * - svg * - png * - jpg * - jpeg * - gif * - bmp * - tif * - tiff * - stream * - stream2d * - ecad * - pdf * - auto * * The source type may be omitted if this is a grouping content node. If the `source` property points * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType` * property will be detected by making a request to the backend. NOTE: The tif and tiff image formats * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy * library to load and display VDS file content. If source type of "vds4" is used then new namespace based * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model. * * * @returns Value of property `sourceType` */ getSourceType(): string; /** * Gets current value of property {@link #getUseSecureConnection useSecureConnection}. * * If set to false, unsecure connections will be used. Default: true. * * Default value is `true`. * * * @returns Value of property `useSecureConnection` */ getUseSecureConnection(): boolean; /** * Gets current value of property {@link #getVeid veid}. * * Id of scene to retrieve tree for. Mandatory for the stream source type. * * * @returns Value of property `veid` */ getVeid(): string; /** * Checks for the provided `sap.ui.vk.ContentResource` in the aggregation {@link #getContentResources contentResources}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContentResource( /** * The contentResource whose index is looked for */ oContentResource: sap.ui.vk.ContentResource ): int; /** * Inserts a contentResource into the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ insertContentResource( /** * The contentResource to insert; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource, /** * The `0`-based index the contentResource should be inserted at; for a negative value of `iIndex`, the * contentResource is inserted at position 0; for a value greater than the current size of the aggregation, * the contentResource is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContentResources contentResources}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContentResources(): sap.ui.vk.ContentResource[]; /** * Removes a contentResource from the aggregation {@link #getContentResources contentResources}. * * * @returns The removed contentResource or `null` */ removeContentResource( /** * The contentResource to remove or its index or id */ vContentResource: int | string | sap.ui.vk.ContentResource ): sap.ui.vk.ContentResource | null; /** * Sets a new value for property {@link #getActivateView activateView}. * * Optional parameter with view id which shall be activated when scene is loaded. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setActivateView( /** * New value for property `activateView` */ sActivateView: string ): this; /** * Sets a new value for property {@link #getDependencyLoader dependencyLoader}. * * An object used to load content resource's dependencies. * * A content resource may have dependencies, e.g. if the loaded content resource is a shattered VDS file * it reference other VDS files. * * `dependencyLoader` should be an object with method `function load(uri: string, context: any): Promise<{buffer: * ArrayBuffer, context: any}>`, where `uri` is a reference to a dependency and `context` is opaque data. * * `uri` is application specific and can be a full URL or a relative file name or anything else, e.g. some * identifier known to `dependencyLoader`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDependencyLoader( /** * New value for property `dependencyLoader` */ oDependencyLoader: any ): this; /** * Sets a new value for property {@link #getEnableLogger enableLogger}. * * Optional boolean parameter to enable detailed logging. Can be used to track performance issues during * data streaming from SAP 3D Visualization Service. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableLogger( /** * New value for property `enableLogger` */ bEnableLogger?: boolean ): this; /** * Sets a new value for property {@link #getIncludeAnimation includeAnimation}. * * Send structural data for animation objects, if false they will be omitted, reducing data size. Default: * true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeAnimation( /** * New value for property `includeAnimation` */ bIncludeAnimation?: boolean ): this; /** * Sets a new value for property {@link #getIncludeBackground includeBackground}. * * If set to true, will return nodes with the type background * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeBackground( /** * New value for property `includeBackground` */ bIncludeBackground?: boolean ): this; /** * Sets a new value for property {@link #getIncludeHidden includeHidden}. * * Send structural data for hidden objects, if false they will be omitted, reducing data size. Default: * true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeHidden( /** * New value for property `includeHidden` */ bIncludeHidden?: boolean ): this; /** * Sets a new value for property {@link #getIncludeMetadata includeMetadata}. * * If set to true, will load metadata * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeMetadata( /** * New value for property `includeMetadata` */ bIncludeMetadata?: boolean ): this; /** * Sets a new value for property {@link #getIncludeParametric includeParametric}. * * If set to true, will load parametric nodes * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeParametric( /** * New value for property `includeParametric` */ bIncludeParametric?: boolean ): this; /** * Sets a new value for property {@link #getIncludeUsageId includeUsageId}. * * Optional parameter to load UsageIds. Valid values: * `true` - Load all UsageIds. This is potentially very expensive, as there could be many UsageIds defined * for the tenant which are not relevant to the current application. `false` - Do not load any UsageIds. * `string` - A single non-empty string which defines the name of the requested UsageId. `string[]` * - An array of non-empty strings which define the names of requested UsageIds. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setIncludeUsageId( /** * New value for property `includeUsageId` */ sIncludeUsageId?: sap.ui.vk.IncludeUsageIdType ): this; /** * Sets a new value for property {@link #getLocalMatrix localMatrix}. * * The local transformation matrix of the node created for this content resource. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLocalMatrix( /** * New value for property `localMatrix` */ sLocalMatrix: float[] ): this; /** * Sets a new value for property {@link #getMetadataFilter metadataFilter}. * * Optional metadata filter that can trim the tree before sending to the client only keeping nodes that * passed the filter and their parents. Default: null. Format: Comma-separated list of meta.category1.tag1.value1, * meta.category2.tag2.value2. "meta." is the prefix and all metadata filters must start with it. Multiple * filters are supported, they are combined using `OR` operator. Includes parent nodes of matching nodes * (e.g. breadcrumb) even if they don't pass the filter. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setMetadataFilter( /** * New value for property `metadataFilter` */ sMetadataFilter: string ): this; /** * Sets a new value for property {@link #getName name}. * * The name of the node created for this content resource. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; /** * Sets a new value for property {@link #getPassword password}. * * The password to use when opening the resource. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPassword( /** * New value for property `password` */ sPassword: string ): this; /** * Sets a new value for property {@link #getPushPMI pushPMI}. * * If set to true, elements for PMI rendering content will be returned. Default: false. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setPushPMI( /** * New value for property `pushPMI` */ bPushPMI?: boolean ): this; /** * Sets a new value for property {@link #getPushViewGroups pushViewGroups}. * * If set to true, information of view groups will be returned. Default: true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setPushViewGroups( /** * New value for property `pushViewGroups` */ bPushViewGroups?: boolean ): this; /** * Sets a new value for property {@link #getSource source}. * * The source URL or the {@link https://developer.mozilla.org/en-US/docs/Web/API/File File} object of the * content resource/file to load from. The source may be omitted if a grouping node is needed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSource( /** * New value for property `source` */ oSource: any ): this; /** * Sets a new value for property {@link #getSourceId sourceId}. * * The unique ID of the content resource. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSourceId( /** * New value for property `sourceId` */ sSourceId: string ): this; /** * Sets a new value for property {@link #getSourceType sourceType}. * * The source type of the content resource. Valid types: * * * - vds * - vds4 * - vds4-2d * - svg * - png * - jpg * - jpeg * - gif * - bmp * - tif * - tiff * - stream * - stream2d * - ecad * - pdf * - auto * * The source type may be omitted if this is a grouping content node. If the `source` property points * to an IPD Visualization service the `sourceType` property can be assigned value `auto`. The actual `sourceType` * property will be detected by making a request to the backend. NOTE: The tif and tiff image formats * are not supported on all browsers. Source type "vds" initializes deprecated DVL namespace and uses legacy * library to load and display VDS file content. If source type of "vds4" is used then new namespace based * on Threejs rendering model will be used to load and display VDS file content. Since DVL namespace is * deprecated in one of future releases it will be removed and source type "vds" will also use Threejs model. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSourceType( /** * New value for property `sourceType` */ sSourceType: string ): this; /** * Sets a new value for property {@link #getUseSecureConnection useSecureConnection}. * * If set to false, unsecure connections will be used. Default: true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setUseSecureConnection( /** * New value for property `useSecureConnection` */ bUseSecureConnection?: boolean ): this; /** * Sets a new value for property {@link #getVeid veid}. * * Id of scene to retrieve tree for. Mandatory for the stream source type. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setVeid( /** * New value for property `veid` */ sVeid: string ): this; } /** * Overflow toolbar that can be collapsed. */ class DrawerToolbar extends sap.ui.core.Control { /** * Constructor for a new DrawerToolbar control. * * 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?: sap.ui.vk.$DrawerToolbarSettings ); /** * Constructor for a new DrawerToolbar control. * * 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?: sap.ui.vk.$DrawerToolbarSettings ); /** * Creates a new subclass of class sap.ui.vk.DrawerToolbar 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.DrawerToolbar. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expanded expanded} event of this `sap.ui.vk.DrawerToolbar`. * * 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.DrawerToolbar` itself. * * Indicates whether the DrawerToolbar is expanded or collapsed. * * * @returns Reference to `this` in order to allow method chaining */ attachExpanded( /** * 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: DrawerToolbar$ExpandedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.DrawerToolbar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expanded expanded} event of this `sap.ui.vk.DrawerToolbar`. * * 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.DrawerToolbar` itself. * * Indicates whether the DrawerToolbar is expanded or collapsed. * * * @returns Reference to `this` in order to allow method chaining */ attachExpanded( /** * The function to be called when the event occurs */ fnFunction: (p1: DrawerToolbar$ExpandedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.DrawerToolbar` itself */ oListener?: object ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:expanded expanded} event of this `sap.ui.vk.DrawerToolbar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachExpanded( /** * The function to be called, when the event occurs */ fnFunction: (p1: DrawerToolbar$ExpandedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:expanded expanded} 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 */ fireExpanded( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.DrawerToolbar$ExpandedEventParameters ): this; /** * Gets content of aggregation {@link #getContent content}. * * Determines the content of the DrawerToolbar. See {@link sap.m.OverflowToolbar} for list of allowed controls. * The content visible when the DrawerToolbar is expanded. */ getContent(): sap.ui.core.Control[]; /** * Gets current value of property {@link #getExpanded expanded}. * * Indicates whether the DrawerToolbar is expanded or not. If expanded is set to true, then both the toolbar * and 'Close' icon are rendered. If expanded is set to false, then only the 'Open' icon is rendered. * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getNavigationMode navigationMode}. * * Default value is `Turntable`. * * * @returns Value of property `navigationMode` */ getNavigationMode(): sap.ui.vk.NavigationMode; /** * ID of the element which is the current target of the association {@link #getViewport viewport}, or `null`. */ getViewport(): sap.ui.core.ID | null; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Sets the expanded property of the control. * * * @returns Pointer to the control instance to allow method chaining. */ setExpanded( /** * Defines whether control is expanded or not. */ bExpanded: boolean ): this; /** * Sets a new value for property {@link #getNavigationMode navigationMode}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Turntable`. * * * @returns Reference to `this` in order to allow method chaining */ setNavigationMode( /** * New value for property `navigationMode` */ sNavigationMode?: sap.ui.vk.NavigationMode ): this; /** * Sets the associated {@link #getViewport viewport}. * * * @returns Reference to `this` in order to allow method chaining */ setViewport( /** * ID of an element which becomes the new target of this viewport association; alternatively, an element * instance may be given */ oViewport: sap.ui.core.ID | sap.ui.vk.ViewportBase ): this; } /** * Holds layout data for the FlexibleControl contents. * * @since 1.16.0 */ class FlexibleControl extends sap.ui.core.Control { /** * Constructor for a new FlexibleControl. * * 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?: sap.ui.vk.$FlexibleControlSettings ); /** * Constructor for a new FlexibleControl. * * 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?: sap.ui.vk.$FlexibleControlSettings ); /** * Creates a new subclass of class sap.ui.vk.FlexibleControl 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.FlexibleControl. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets content of aggregation {@link #getContent content}. * * Child Controls within the layout. */ getContent(): sap.ui.core.Control[]; /** * Gets current value of property {@link #getEnabled enabled}. * * If not enabled all controls inside are not enabled automatically. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeight height}. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getLayout layout}. * * Default value is `"Stacked"`. * * * @returns Value of property `layout` */ getLayout(): string; /** * Gets current value of property {@link #getWidth width}. * * CSS width of the vertical layout. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Sets a new value for property {@link #getEnabled enabled}. * * If not enabled all controls inside are not enabled automatically. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): 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. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getLayout layout}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Stacked"`. * * * @returns Reference to `this` in order to allow method chaining */ setLayout( /** * New value for property `layout` */ sLayout?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * CSS width of the vertical layout. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * Holds layout data for the FlexibleControl contents. Allowed size values are numeric values ending in * "px" and "%" and the special case "auto". (The CSS value "auto" is used internally to recalculate the * size of the content dynamically and is not directly set as style property.) * * @since 1.32.0 */ class FlexibleControlLayoutData extends sap.ui.core.LayoutData { /** * Constructor for a new FlexibleControlLayoutData. * * 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?: sap.ui.vk.$FlexibleControlLayoutDataSettings ); /** * Constructor for a new FlexibleControlLayoutData. * * 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?: sap.ui.vk.$FlexibleControlLayoutDataSettings ); /** * Creates a new subclass of class sap.ui.vk.FlexibleControlLayoutData 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.LayoutData.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.FlexibleControlLayoutData. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getMarginBottom marginBottom}. * * Default value is `"0px"`. * * * @returns Value of property `marginBottom` */ getMarginBottom(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getMarginTop marginTop}. * * Sets the margin-bottom of the content in px. * * Default value is `"0px"`. * * * @returns Value of property `marginTop` */ getMarginTop(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getMinSize minSize}. * * Sets the minimum size of the content in px. * * Default value is `"0px"`. * * * @returns Value of property `minSize` */ getMinSize(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getSize size}. * * Sets the size of the content. * * Default value is `"auto"`. * * * @returns Value of property `size` */ getSize(): sap.ui.core.CSSSize; /** * Sets a new value for property {@link #getMarginBottom marginBottom}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"0px"`. * * * @returns Reference to `this` in order to allow method chaining */ setMarginBottom( /** * New value for property `marginBottom` */ sMarginBottom?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getMarginTop marginTop}. * * Sets the margin-bottom of the content in px. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"0px"`. * * * @returns Reference to `this` in order to allow method chaining */ setMarginTop( /** * New value for property `marginTop` */ sMarginTop?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getMinSize minSize}. * * Sets the minimum size of the content in px. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"0px"`. * * * @returns Reference to `this` in order to allow method chaining */ setMinSize( /** * New value for property `minSize` */ sMinSize?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getSize size}. * * Sets the size of the content. * * 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 */ setSize( /** * New value for property `size` */ sSize?: sap.ui.core.CSSSize ): this; } /** * Provides a loader that loads a 2D raster or vector image into an HTMLImageElement or HTMLObjectElement * object. * * @since 1.50.0 */ class ImageContentManager extends sap.ui.vk.ContentManager { /** * Constructor for a new ImageContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. */ constructor( /** * Initial settings for the new ImageContentManager object. */ mSettings?: sap.ui.vk.$ImageContentManagerSettings ); /** * Constructor for a new ImageContentManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ContentManager#constructor sap.ui.vk.ContentManager } * can be used. */ constructor( /** * ID for the new ImageContentManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ImageContentManager object. */ mSettings?: sap.ui.vk.$ImageContentManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.ImageContentManager 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.vk.ContentManager.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ImageContentManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; } /** * Provides a proxy object to the layer in the node hierarchy. * * Layer is a list of nodes. One node hierarchy can have multiple layers. One node can be included in multiple * layers. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createLayerProxy sap.ui.vk.NodeHierarchy.createLayerProxy } * method and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyLayerProxy sap.ui.vk.NodeHierarchy.destroyLayerProxy } * method. */ abstract class LayerProxy extends sap.ui.base.Object { /** * Constructor for a new LayerProxy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createLayerProxy sap.ui.vk.NodeHierarchy.createLayerProxy } * method and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyLayerProxy sap.ui.vk.NodeHierarchy.destroyLayerProxy } * method. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.LayerProxy 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.base.Object.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.LayerProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Gets the description of the layer. * * * @returns The description of the layer. */ getDescription(): string; /** * Gets the layer ID. * * * @returns The layer ID. */ getLayerId(): string; /** * Gets the layer metadata. * * * @returns The layer metadata. */ getLayerMetadata(): object; /** * Gets the name of the layer * * * @returns The name of the layer. */ getName(): string; /** * Gets an array of IDs of nodes belonging to the layer. * * * @returns An array of IDs of nodes belonging to the layer. */ getNodes(): string[]; /** * Gets the layer VE IDs. * * * @returns The layer VE IDs. */ getVeIds(): object[]; } /** * Legend item control * * @since 1.38.0 * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ContainerLegendItem} */ class LegendItem extends sap.m.StandardListItem { /** * Constructor for a new LegendItem. * * 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?: sap.ui.vk.$LegendItemSettings ); /** * Constructor for a new LegendItem. * * 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?: sap.ui.vk.$LegendItemSettings ); /** * Creates a new subclass of class sap.ui.vk.LegendItem 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.m.StandardListItem.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.LegendItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getColor color}. * * show color square * * * @returns Value of property `color` */ getColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getSemanticSpotType semanticSpotType}. * * The semantic spot type for the legend marker. * * * @returns Value of property `semanticSpotType` */ getSemanticSpotType(): sap.ui.vbm.SemanticType; /** * Sets a new value for property {@link #getColor color}. * * show color square * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColor( /** * New value for property `color` */ sColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getSemanticSpotType semanticSpotType}. * * The semantic spot type for the legend marker. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSemanticSpotType( /** * New value for property `semanticSpotType` */ sSemanticSpotType?: sap.ui.vbm.SemanticType ): this; } /** * Aggregation control for the Legend * * @since 1.38.0 * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ListPanel} */ class ListPanel extends sap.ui.core.Control { /** * Constructor for a new ListPanel. * * 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?: sap.ui.vk.$ListPanelSettings ); /** * Constructor for a new ListPanel. * * 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?: sap.ui.vk.$ListPanelSettings ); /** * Creates a new subclass of class sap.ui.vk.ListPanel 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ListPanel. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: sap.m.ListItemBase ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expand expand} event of this `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired if the panel is expanded of collapsed * * * @returns Reference to `this` in order to allow method chaining */ attachExpand( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:expand expand} event of this `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired if the panel is expanded of collapsed * * * @returns Reference to `this` in order to allow method chaining */ attachExpand( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:headerIconPress headerIconPress} event of this * `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired if the header icon is pressed * * * @returns Reference to `this` in order to allow method chaining */ attachHeaderIconPress( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:headerIconPress headerIconPress} event of this * `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired if the header icon is pressed * * * @returns Reference to `this` in order to allow method chaining */ attachHeaderIconPress( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired when an item is pressed unless the item's `type` property is `Inactive`. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * 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: ListPanel$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired when an item is pressed unless the item's `type` property is `Inactive`. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * The function to be called when the event occurs */ fnFunction: (p1: ListPanel$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired when selection is changed via user interaction inside the control. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * 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: ListPanel$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.vk.ListPanel`. * * 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.ListPanel` itself. * * Event is fired when selection is changed via user interaction inside the control. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ListPanel$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ListPanel` itself */ oListener?: object ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:expand expand} event of this `sap.ui.vk.ListPanel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachExpand( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:headerIconPress headerIconPress} event of * this `sap.ui.vk.ListPanel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHeaderIconPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemPress itemPress} event of this `sap.ui.vk.ListPanel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: ListPanel$ItemPressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of * this `sap.ui.vk.ListPanel`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ListPanel$SelectionChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:expand expand} 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 */ fireExpand( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:headerIconPress headerIconPress} 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 */ fireHeaderIconPress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:itemPress itemPress} 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 */ fireItemPress( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ListPanel$ItemPressEventParameters ): this; /** * Fires event {@link #event:selectionChange selectionChange} 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 */ fireSelectionChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ListPanel$SelectionChangeEventParameters ): this; /** * Gets current value of property {@link #getExpandAnimation expandAnimation}. * * Expand animation * * Default value is `true`. * * * @returns Value of property `expandAnimation` */ getExpandAnimation(): boolean; /** * Gets current value of property {@link #getExpanded expanded}. * * Expansion state * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getHeaderIcon headerIcon}. * * Header icon * * * @returns Value of property `headerIcon` */ getHeaderIcon(): sap.ui.core.URI; /** * Gets current value of property {@link #getHeaderText headerText}. * * Header text * * * @returns Value of property `headerText` */ getHeaderText(): string; /** * Gets content of aggregation {@link #getItems items}. * * Item aggregation */ getItems(): sap.m.ListItemBase[]; /** * Returns selected list item. When no item is selected, "null" is returned. When "multi-selection" is enabled * and multiple items are selected, only the up-most selected item is returned. * * * @returns Selected item. */ getSelectedItem(): sap.m.ListItemBase; /** * Returns an array containing the selected list items. If no items are selected, an empty array is returned. * * * @returns Selected items */ getSelectedItems(): sap.m.ListItemBase[]; /** * Gets current value of property {@link #getSelectionMode selectionMode}. * * Selection Mode * * Default value is `MultiSelect`. * * * @returns Value of property `selectionMode` */ getSelectionMode(): sap.m.ListMode; /** * Checks for the provided `sap.m.ListItemBase` in the aggregation {@link #getItems items}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: sap.m.ListItemBase ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: sap.m.ListItemBase, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): sap.m.ListItemBase[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | sap.m.ListItemBase ): sap.m.ListItemBase | null; /** * Sets a new value for property {@link #getExpandAnimation expandAnimation}. * * Expand animation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setExpandAnimation( /** * New value for property `expandAnimation` */ bExpandAnimation?: boolean ): this; /** * Sets a new value for property {@link #getExpanded expanded}. * * Expansion state * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets a new value for property {@link #getHeaderIcon headerIcon}. * * Header icon * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeaderIcon( /** * New value for property `headerIcon` */ sHeaderIcon: sap.ui.core.URI ): this; /** * Sets a new value for property {@link #getHeaderText headerText}. * * Header text * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeaderText( /** * New value for property `headerText` */ sHeaderText: string ): this; /** * Selects or deselects the given list item. */ setSelectedItem( /** * The list item whose selection to be changed. This parameter is mandatory. */ oListItem: sap.m.ListItemBase, /** * Sets selected status of the list item. Default value is true. */ bSelect: boolean, /** * Whether to fire the event or not. */ bFireEvent: boolean ): void; /** * Sets a new value for property {@link #getSelectionMode selectionMode}. * * Selection Mode * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `MultiSelect`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionMode( /** * New value for property `selectionMode` */ sSelectionMode?: sap.m.ListMode ): this; } /** * ListPanelStack control * * @since 1.38.0 * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.ListPanelStack} */ class ListPanelStack extends sap.ui.core.Control { /** * Constructor for a new ListPanelStack. * * 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?: sap.ui.vk.$ListPanelStackSettings ); /** * Constructor for a new ListPanelStack. * * 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?: sap.ui.vk.$ListPanelStackSettings ); /** * Creates a new subclass of class sap.ui.vk.ListPanelStack 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ListPanelStack. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.vk.ListPanel ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets current value of property {@link #getCollapsible collapsible}. * * Ability to collapse * * Default value is `true`. * * * @returns Value of property `collapsible` */ getCollapsible(): boolean; /** * Gets content of aggregation {@link #getContent content}. */ getContent(): sap.ui.vk.ListPanel[]; /** * Gets current value of property {@link #getExpandAnimation expandAnimation}. * * Expand animation * * Default value is `true`. * * * @returns Value of property `expandAnimation` */ getExpandAnimation(): boolean; /** * Gets current value of property {@link #getExpanded expanded}. * * Expansion state * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getWidth width}. * * Control width * * Default value is `"100%"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.ui.vk.ListPanel` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.vk.ListPanel ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.vk.ListPanel, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.vk.ListPanel[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.vk.ListPanel ): sap.ui.vk.ListPanel | null; /** * Sets a new value for property {@link #getCollapsible collapsible}. * * Ability to collapse * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setCollapsible( /** * New value for property `collapsible` */ bCollapsible?: boolean ): this; /** * Sets a new value for property {@link #getExpandAnimation expandAnimation}. * * Expand animation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setExpandAnimation( /** * New value for property `expandAnimation` */ bExpandAnimation?: boolean ): this; /** * Sets a new value for property {@link #getExpanded expanded}. * * Expansion state * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * Control width * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * Loco is a utility class that provides a set of methods to handle input events for UI5 controls. * * @since 1.32.0 */ class Loco extends sap.ui.base.Object { /** * Constructor for a new Loco instance. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object } * can be used. */ constructor( /** * The viewport to attach the event handlers to. */ viewport?: sap.ui.vk.Viewport ); /** * Creates a new subclass of class sap.ui.vk.Loco 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.base.Object.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Loco. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Adds a viewport event handler to the Loco. * * Handlers with higher priority are called first. * * If the viewport already has the event handler attached, the handler is not added again, but its priority * is updated and the handler is moved to the correct position in the list of handlers. * * * @returns Reference to `this` in order to allow method chaining. */ addHandler( /** * The event handler to be added. */ handler: object, /** * The priority of the handler. */ priority: number ): this; /** * Cleans up, removes all handlers. */ destroy(): void; /** * Removes a viewport event handler from Loco. * * * @returns Reference to `this` in order to allow method chaining. */ removeHandler( /** * The event handler to be removed. */ handler: object ): this; } /** * Abstract Constructor for a new Container. * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.MapContainer} */ class MapContainer extends sap.ui.vk.ContainerBase { /** * Constructor for a new MapContainer. * * 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?: sap.ui.vk.$MapContainerSettings ); /** * Constructor for a new MapContainer. * * 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?: sap.ui.vk.$MapContainerSettings ); /** * Creates a new subclass of class sap.ui.vk.MapContainer 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.vk.ContainerBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.MapContainer. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the listPanelStack in the aggregation {@link #getListPanelStack listPanelStack}. * * * @returns Reference to `this` in order to allow method chaining */ destroyListPanelStack(): this; /** * Gets content of aggregation {@link #getListPanelStack listPanelStack}. * * List Panel aggregation */ getListPanelStack(): sap.ui.vk.ListPanelStack; /** * Gets current value of property {@link #getShowHome showHome}. * * Controls the visibility of the home button * * Default value is `true`. * * * @returns Value of property `showHome` */ getShowHome(): boolean; /** * Gets current value of property {@link #getShowMapLayer showMapLayer}. * * Controls the visibility of the Map Layer Select * * Default value is `true`. * * * @returns Value of property `showMapLayer` */ getShowMapLayer(): boolean; /** * Gets current value of property {@link #getShowNavbar showNavbar}. * * Show navbar * * Default value is `true`. * * * @returns Value of property `showNavbar` */ getShowNavbar(): boolean; /** * Gets current value of property {@link #getShowRectangularZoom showRectangularZoom}. * * Controls the visibility of the rectangular zoom button * * Default value is `true`. * * * @returns Value of property `showRectangularZoom` */ getShowRectangularZoom(): boolean; /** * Gets current value of property {@link #getShowZoom showZoom}. * * Controls the visibility of the zoom buttons * * Default value is `true`. * * * @returns Value of property `showZoom` */ getShowZoom(): boolean; /** * Sets the aggregated {@link #getListPanelStack listPanelStack}. * * * @returns Reference to `this` in order to allow method chaining */ setListPanelStack( /** * The listPanelStack to set */ oListPanelStack: sap.ui.vk.ListPanelStack ): this; /** * Sets a new value for property {@link #getShowHome showHome}. * * Controls the visibility of the home button * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowHome( /** * New value for property `showHome` */ bShowHome?: boolean ): this; /** * Sets a new value for property {@link #getShowMapLayer showMapLayer}. * * Controls the visibility of the Map Layer Select * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowMapLayer( /** * New value for property `showMapLayer` */ bShowMapLayer?: boolean ): this; /** * Sets a new value for property {@link #getShowNavbar showNavbar}. * * Show navbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowNavbar( /** * New value for property `showNavbar` */ bShowNavbar?: boolean ): this; /** * Sets a new value for property {@link #getShowRectangularZoom showRectangularZoom}. * * Controls the visibility of the rectangular zoom button * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowRectangularZoom( /** * New value for property `showRectangularZoom` */ bShowRectangularZoom?: boolean ): this; /** * Sets a new value for property {@link #getShowZoom showZoom}. * * Controls the visibility of the zoom buttons * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowZoom( /** * New value for property `showZoom` */ bShowZoom?: boolean ): this; /** * Set custom item on the MapContainer toolbar. All custom items added between selection segment button * and setting button. * * * @returns Item configuration object */ setToolbarItem( /** * Item configuration object. */ item: { /** * Id of the item for future references. */ id: string; /** * Relative index of an item across all custom items. */ index: int; /** * Visibility of an item. */ visible: boolean; /** * Active item or not. */ active: boolean; /** * Text of an item. */ text: string; /** * Tooltip of an item. */ tooltip: string; /** * If true create Overflow button or standard if false. */ overflow: boolean; /** * Icon of an item. */ icon: sap.ui.core.URI; /** * Alternative icon of an item, see {@link sap.m.Button} for details. */ activeIcon: sap.ui.core.URI; /** * The {@link sap.ui.vk.MapContainerButtonType} enum. */ type: string; /** * Callback function which is called when item gets pressed. */ press: Function; /** * sets the initial pressed state for a {@link sap.ui.vk.MapContainerButtonType} Toggle button. This does * not fire the pressed event handler. It should be used if pressed logic is activated by application code * on first load. */ toggled: boolean; } ): object; } /** * Provides the interface for the material. * * The objects of this class should not be created directly. */ abstract class Material extends sap.ui.base.Object { /** * Constructor for a new Material. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.base.Object#constructor sap.ui.base.Object } * can be used. */ constructor(); /** * Creates a new subclass of class sap.ui.vk.Material 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.base.Object.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Material. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.Metadata; /** * Gets current value of material ambient colour Default value is "rgba(0, 0, 0, 1)". * * * @returns Ambient colour - red, green, blue, and alpha */ getAmbientColour(): sap.ui.core.CSSColor; /** * Gets current value of material diffuse colour Default value is "rgba(0, 0, 0, 1)". * * * @returns Diffuse colour - red, green, blue, and alpha */ getDiffuseColour(): sap.ui.core.CSSColor; /** * Gets current value of material emissive colour Default value is "rgba(0, 0, 0, 1)". * * * @returns Emissive colour - red, green, blue, and alpha */ getEmissiveColour(): sap.ui.core.CSSColor; /** * Gets current value of material glossiness Default value is 0.0 * * * @returns Glossiness */ getGlossiness(): float; /** * Gets current value of material line colour Default value is "rgba(0, 0, 0, 1)". * * * @returns Line colour - red, green, blue, and alpha */ getLineColour(): sap.ui.core.CSSColor; /** * Gets current value of material line width Default value is 0.0 * * * @returns Line width */ getLineWidth(): float; /** * Gets the reference to the native material object * * * @returns Material reference that this material class wraps */ getMaterialRef(): any; /** * Gets current value of material name * * * @returns Material name */ getName(): string; /** * Gets current value of material opacity Default value is 1.0 * * * @returns Opacity */ getOpacity(): float; /** * Gets current value of material specular colour Default value is "rgba(0, 0, 0, 1)". * * * @returns Specular colour - red, green, blue, and alpha */ getSpecularColour(): sap.ui.core.CSSColor; /** * Gets current value of material ambient occlusion texture * * * @returns Ambient occlusion texture */ getTextureAmbientOcclusion(): sap.ui.vk.Texture; /** * Gets current value of material bump texture * * * @returns Bump texture */ getTextureBump(): sap.ui.vk.Texture; /** * Gets current value of material diffuse texture * * * @returns Diffuse texture */ getTextureDiffuse(): sap.ui.vk.Texture; /** * Gets current value of material emissive texture * * * @returns Emissive texture */ getTextureEmissive(): sap.ui.vk.Texture; /** * Gets current value of material opacity texture * * * @returns Opacity texture */ getTextureOpacity(): sap.ui.vk.Texture; /** * Gets current value of material reflection texture * * * @returns Reflection texture */ getTextureReflection(): sap.ui.vk.Texture; /** * Sets a new value for material ambient colour When called with a value of null or undefined, the default * value of the property will be restored. Default value is "rgba(0, 0, 0, 1)". * * * @returns Reference to `this` in order to allow method chaining */ setAmbientColour( /** * New value for material ambient colour */ sAmbientColour: sap.ui.core.CSSColor ): this; /** * Sets a new value for material diffuse colour When called with a value of null or undefined, the default * value of the property will be restored. Default value is "rgba(0, 0, 0, 1)". * * * @returns Reference to `this` in order to allow method chaining */ setDiffuseColour( /** * New value for material diffuse colour */ sDiffuseColour: sap.ui.core.CSSColor ): this; /** * Sets a new value for material emissive colour When called with a value of null or undefined, the default * value of the property will be restored. Default value is "rgba(0, 0, 0, 1)". * * * @returns Reference to `this` in order to allow method chaining */ setEmissiveColour( /** * New value for material emissive colour */ sEmissiveColour: sap.ui.core.CSSColor ): this; /** * Sets a new value for material glossiness When called with a value of null or undefined, the default value * of the property will be restored. Default value is 0.0 * * * @returns Reference to `this` in order to allow method chaining */ setGlossiness( /** * New value for material glossiness */ fGlossiness: float ): this; /** * Sets a new value for material line colour When called with a value of null or undefined, the default * value of the property will be restored. Default value is "rgba(0, 0, 0, 1)". * * * @returns Reference to `this` in order to allow method chaining */ setLineColour( /** * New value for material line colour */ sLineColour: sap.ui.core.CSSColor ): this; /** * Sets a new value for material line width When called with a value of null or undefined, the default value * of the property will be restored. Default value is 0.0 * * * @returns Reference to `this` in order to allow method chaining */ setLineWidth( /** * New value for material line width */ fLineWidth: float ): this; /** * Sets a new value for material name * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for material name */ sName: string ): this; /** * Sets a new value for material opacity When called with a value of null or undefined, the default value * of the property will be restored. Default value is 1.0 * * * @returns Reference to `this` in order to allow method chaining */ setOpacity( /** * New value for material opacity */ fOpacity: float ): this; /** * Sets a new value for material specular colour When called with a value of null or undefined, the default * value of the property will be restored. Default value is "rgba(0, 0, 0, 1)". * * * @returns Reference to `this` in order to allow method chaining */ setSpecularColour( /** * New value for material specular colour */ sSpecularColour: sap.ui.core.CSSColor ): this; /** * Sets a new value for material ambient occlusion texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureAmbientOcclusion( /** * New value for material ambient occlusion texture */ sTextureAmbientOcclusion: sap.ui.vk.Texture ): this; /** * Sets a new value for material bump texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureBump( /** * New value for material bump texture */ sTextureBump: sap.ui.vk.Texture ): this; /** * Sets a new value for material diffuse texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureDiffuse( /** * New value for material diffuse texture */ sTextureDiffuse: sap.ui.vk.Texture ): this; /** * Sets a new value for material emissive texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureEmissive( /** * New value for material emissive texture */ sTextureEmissive: sap.ui.vk.Texture ): this; /** * Sets a new value for material opacity texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureOpacity( /** * New value for material opacity texture */ sTextureOpacity: sap.ui.vk.Texture ): this; /** * Sets a new value for material reflection texture * * * @returns Reference to `this` in order to allow method chaining */ setTextureReflection( /** * New value for material reflection texture */ sTextureReflection: sap.ui.vk.Texture ): this; } /** * Enables loading, pan, zoom and overlay capabilities for a subset of file formats capable of being loaded * into a browser natively. * * @since 1.32.0 */ class NativeViewport extends sap.ui.vk.ViewportBase { /** * Constructor for a new NativeViewport. * * 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 Native Viewport control. */ mSettings?: sap.ui.vk.$NativeViewportSettings ); /** * Constructor for a new NativeViewport. * * 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 Native Viewport control, generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Native Viewport control. */ mSettings?: sap.ui.vk.$NativeViewportSettings ); /** * Creates a new subclass of class sap.ui.vk.NativeViewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.NativeViewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:move move} event of this `sap.ui.vk.NativeViewport`. * * 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.NativeViewport` itself. * * Raised when the display position or magnification of the image in the Native Viewport changes. * * * @returns Reference to `this` in order to allow method chaining */ attachMove( /** * 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: NativeViewport$MoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NativeViewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:move move} event of this `sap.ui.vk.NativeViewport`. * * 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.NativeViewport` itself. * * Raised when the display position or magnification of the image in the Native Viewport changes. * * * @returns Reference to `this` in order to allow method chaining */ attachMove( /** * The function to be called when the event occurs */ fnFunction: (p1: NativeViewport$MoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NativeViewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.NativeViewport`. * * 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.NativeViewport` itself. * * Raised when the display size of the image in the Native Viewport changes. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * 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: NativeViewport$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NativeViewport` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.NativeViewport`. * * 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.NativeViewport` itself. * * Raised when the display size of the image in the Native Viewport changes. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * The function to be called when the event occurs */ fnFunction: (p1: NativeViewport$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NativeViewport` itself */ oListener?: object ): this; /** * Marks the start of the current gesture operation. * * * @returns this */ beginGesture( /** * x-coordinate in screen space. */ x: int, /** * y-coordinate in screen space. */ y: int ): sap.ui.vk.NativeViewport; /** * Detaches event handler `fnFunction` from the {@link #event:move move} event of this `sap.ui.vk.NativeViewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMove( /** * The function to be called, when the event occurs */ fnFunction: (p1: NativeViewport$MoveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:resize resize} event of this `sap.ui.vk.NativeViewport`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachResize( /** * The function to be called, when the event occurs */ fnFunction: (p1: NativeViewport$ResizeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Marks the end of the current gesture operation. * * * @returns this */ endGesture(): sap.ui.vk.NativeViewport; /** * Fires event {@link #event:move move} 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 */ fireMove( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NativeViewport$MoveEventParameters ): this; /** * Fires event {@link #event:resize resize} 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 */ fireResize( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NativeViewport$ResizeEventParameters ): this; /** * Gets current value of property {@link #getLimitZoomOut limitZoomOut}. * * Limit the ability to zoom out. If enabled the zoom out stops if the image size reaches 25% of the full * view (best fit). * * Default value is `false`. * * * @returns Value of property `limitZoomOut` */ getLimitZoomOut(): boolean; /** * It retrieves information about the current virtual native viewport. The information can used for making * calculations when restoring Redlining elements. * * * @returns outputSize The information in this object: * - **left** - The x coordinate of the top-left corner of the virtual native viewport * - **top** - The y coordinate of the top-left corner of the virtual native viewport * - **sideLength** - The side length of the virtual native viewport */ getOutputSize(): object; /** * Gets information about the Viewport's attributes; for example, camera. * * * @returns ViewInfo object. */ getViewInfo(): object; /** * Loads a image URL into Viewport. * * @deprecated As of version 1.50.0. Use {@link sap.ui.vk.ContentResource} and {@link sap.ui.vk.ContentConnector#contentResources } * aggregation instead. * * @returns this */ loadUrl( /** * The URL of the resource. */ url: string, /** * onload callback, called when the resource is loaded successfully. */ onload: Function, /** * onerror callback, called when an error occurs during the loading process. */ onerror: Function, /** * onprogress callback, called during the loading process. */ onprogress: Function, /** * an array of type of resources to load. */ resourceType: any[] ): sap.ui.vk.NativeViewport; /** * Performs a `pan` gesture to pan across the Viewport. * * * @returns this */ pan( /** * The change in distance along the x-coordinate. */ dx: int, /** * The change in distance along the y-coordinate. */ dy: int ): sap.ui.vk.NativeViewport; /** * Queues a command for execution during the rendering cycle. All gesture operations should be called using * this method. * * * @returns this */ queueCommand( /** * The function to be executed. */ command: Function ): sap.ui.vk.NativeViewport; /** * Rotates the content of the Viewport. * * * @returns this */ rotate( /** * The change in x-coordinate used to define the desired rotation. */ dx: int, /** * The change in y-coordinate used to define the desired rotation. */ dy: int ): sap.ui.vk.NativeViewport; /** * Sets a new value for property {@link #getLimitZoomOut limitZoomOut}. * * Limit the ability to zoom out. If enabled the zoom out stops if the image size reaches 25% of the full * view (best fit). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setLimitZoomOut( /** * New value for property `limitZoomOut` */ bLimitZoomOut?: boolean ): this; /** * Sets information about the Viewport's attributes; for example, camera. * * * @returns this */ setViewInfo( /** * ViewInfo object. */ viewInfo: object ): sap.ui.vk.NativeViewport; /** * Executes a click or tap gesture. * * * @returns this */ tap( /** * The tap gesture's x-coordinate. */ x: int, /** * The tap gesture's y-coordinate. */ y: int, /** * Indicates whether the tap gesture should be interpreted as a double-click. A value of `true` indicates * a double-click gesture, and `false` indicates a single click gesture. */ isDoubleClick: boolean ): sap.ui.vk.NativeViewport; /** * Performs a `zoom` gesture to zoom in or out on the beginGesture coordinate. * * * @returns this */ zoom( /** * Zoom factor. A scale factor that specifies how much to zoom in or out by. */ z: float ): sap.ui.vk.NativeViewport; /** * Zooms the viewport to fit to the content bounds * * * @returns this */ zoomTo(): sap.ui.vk.NativeViewport; } /** * Provides the ability to explore a Scene object's node structure. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene.getDefaultNodeHierarchy}. */ abstract class NodeHierarchy extends sap.ui.base.ManagedObject { /** * Constructor for a new NodeHierarchy. * * The objects of this class should not be created directly, and should only be created via a call to {@link sap.ui.vk.Scene#getDefaultNodeHierarchy sap.ui.vk.Scene.getDefaultNodeHierarchy}. * * 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(); /** * Creates a new subclass of class sap.ui.vk.NodeHierarchy 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.NodeHierarchy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:changed changed} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when the node hierarchy changes, e.g. a node is added or removed. * * * @returns Reference to `this` in order to allow method chaining */ attachChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:changed changed} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when the node hierarchy changes, e.g. a node is added or removed. * * * @returns Reference to `this` in order to allow method chaining */ attachChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeCreated nodeCreated} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when a new node is created. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeCreated( /** * 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: NodeHierarchy$NodeCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeCreated nodeCreated} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when a new node is created. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeRemoving nodeRemoving} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when a node is about to be removed. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeRemoving( /** * 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: NodeHierarchy$NodeRemovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeRemoving nodeRemoving} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * This event will be fired when a node is about to be removed. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeRemoving( /** * The function to be called when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeRemovingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeReplaced nodeReplaced} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeReplaced( /** * 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: NodeHierarchy$NodeReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeReplaced nodeReplaced} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeReplaced( /** * The function to be called when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeReplacedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeUpdated nodeUpdated} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeUpdated( /** * 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: NodeHierarchy$NodeUpdatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeUpdated nodeUpdated} event of this `sap.ui.vk.NodeHierarchy`. * * 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.NodeHierarchy` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeUpdated( /** * The function to be called when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeUpdatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.NodeHierarchy` itself */ oListener?: object ): this; /** * Creates a layer proxy object. * * The layer proxy object must be destroyed with the {@link #destroyLayerProxy destroyLayerProxy} method. * * @since 1.50.0 * * @returns The proxy object. */ createLayerProxy( /** * The layer ID for which to create a proxy object. */ layerId: string ): sap.ui.vk.LayerProxy; /** * Creates a new node. * * @since 1.50.0 * * @returns The reference object of the newly created node. */ createNode( /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any, /** * The created node content type. */ nodeContentType?: sap.ui.vk.NodeContentType, /** * Optional Json structure used to define node properties. */ content?: object ): any; /** * Creates a copy of an existing node. * * @since 1.50.0 * * @returns The reference object of the newly created node. */ createNodeCopy( /** * The reference object of the node to copy. */ nodeToCopy: any, /** * The reference object of the parent node where the created node is added to. If equals `null` the newly * created node is a top level node. */ parentNode: any, /** * The name of the new node. */ name: string, /** * The created node is added before this specified node. If equals `null` the newly created node is added * at the end of the parent's list of nodes. */ insertBeforeNode: any ): any; /** * Creates a node proxy object. * * The node proxy object must be destroyed with the {@link #destroyNodeProxy destroyNodeProxy} method. * * @since 1.50.0 * * @returns The proxy object. */ createNodeProxy( /** * The reference object for which to create a proxy object. */ nodeRef: any ): sap.ui.vk.NodeProxy; /** * Destroys the layer proxy object. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ destroyLayerProxy( /** * The layer proxy object. */ layerProxy: sap.ui.vk.LayerProxy ): this; /** * Destroys the node proxy object. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ destroyNodeProxy( /** * The node proxy object. */ nodeProxy: sap.ui.vk.NodeProxy ): this; /** * Detaches event handler `fnFunction` from the {@link #event:changed changed} event of this `sap.ui.vk.NodeHierarchy`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeCreated nodeCreated} event of this `sap.ui.vk.NodeHierarchy`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeCreatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeRemoving nodeRemoving} event of this `sap.ui.vk.NodeHierarchy`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeRemoving( /** * The function to be called, when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeRemovingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeReplaced nodeReplaced} event of this `sap.ui.vk.NodeHierarchy`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeReplaced( /** * The function to be called, when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeReplacedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeUpdated nodeUpdated} event of this `sap.ui.vk.NodeHierarchy`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeUpdated( /** * The function to be called, when the event occurs */ fnFunction: (p1: NodeHierarchy$NodeUpdatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Enumerates the ancestor nodes of a particular node in the Scene object. * * This method enumerates the ancestor nodes of a particular node, and then calls the `callback` function, * to which it passes the ancestor nodes to one by one. * The BaseNodeProxy objects passed to `callback` are temporary objects, they are reset after each call * to the `callback` function. * The ancestor nodes are enumerated starting from the top level node, and progresses down the node hierarchy. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ enumerateAncestors( /** * The reference object of a node whose ancestor nodes we want enumerated. */ nodeRef: any, /** * A function to call when the ancestor nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to pass the reference objects of the ancestor nodes, or the whole node proxy to the * `callback` function. * If `true`, then only the reference objects of the ancestor nodes are passed to the `callback` function. * * If `false`, then the node proxies of the ancestor nodes are passed to the `callback` function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * @since 1.50.0 * * @returns `this` to allow method chaining. */ enumerateChildren( /** * The reference object of a node whose child nodes we want enumerated. * When `nodeRef` is specified, the child nodes of this node are enumerated. * When no `nodeRef` is specified, only the top level nodes are enumerated. */ nodeRef: any, /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the reference objects of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the reference objects of the child nodes are passed to the `callback` function. * * If `false`, then the node proxies created from the child reference objects are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Enumerates the child nodes of a particular node in the Scene object. * * This method gets the child nodes of a particular node, and then calls the `callback` function to which * it passes the child nodes to one by one. * The `BaseNodeProxy` objects passed to the `callback` function are temporary objects, which are reset * after each call to the `callback` function. * * * @since 1.50.0 * * @returns `this` to allow method chaining. */ enumerateChildren( /** * A function to call when the child nodes are enumerated. The function takes one parameter of type {@link sap.ui.vk.BaseNodeProxy}, * or string if parameter `passNodeRef` parameter is `true`. */ callback: Function, /** * Indicates whether to enumerate the child nodes if the node is closed. * If `true`, the children of that closed node will be enumerated * If `false`, the children of that node will not be enumerated */ stepIntoClosedNodes?: boolean, /** * Indicates whether to pass the reference objects of the child nodes, or the whole node proxy to the `callback` * function. * If `true`, then only the reference objects of the child nodes are passed to the `callback` function. * * If `false`, then the node proxies created from the child reference objects are passed to the `callback` * function. */ passNodeRef?: boolean ): this; /** * Searches for VE IDs, and returns a list of reference objects of nodes with VE IDs matching the search. * The query is run specifically against VE ID structures, which are strictly related to VDS4 models. * * @since 1.50.0 * * @returns A list of reference objects belonging to nodes that matched the VE IDs search criteria. */ findNodesById( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * source: string (if not specified, the query returns an empty array), * * type: string (if not specified, the query returns an empty array), * * fields: field[] * }``` * * * - **field.name** * A string containing the name of the VE ID. If no value is specified, then the query will return an empty * array. * * - **field.value** * A string representing the search keyword. If no value is specified, it defaults to empty string. * The following example shows a string being passed in: * ```javascript * value: "Box #14"``` * * - **field.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for IDs with names that exactly match the provided string. * Using `"contains"` will search for IDs with names containing the provided string. * Using `"startsWith"` will search for IDs with names starting with the provided string. * If no value is specified, the search mode will default to `"equals"`. * * * - **field.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): any[]; /** * Finds nodes in a scene via metadata information. * * @since 1.50.0 * * @returns A list of reference objects belonging to nodes that matched the search criteria. */ findNodesByMetadata( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * category: string, * key: string, * value: string | string[], * predicate: "equals" | "contains" | "startsWith", * caseSensitive: true | false * }``` * * NOTE: `query.predicate` and `query.caseSensitive` refer to `query.value`. * * - **query.category** * A string indicating the name of the metadata category. * If no value is specified for `query.category`, all nodes in the scene will be returned in the search. * * * - **query.key** * A string indicating the key which belongs to the metadata category specified in `query.category`. You * can only use `query.key` if `query.category` has been specified. * If no value is specified for `query.key`, then all nodes grouped under the specified category will be * returned in the search. * * * - **query.value** * A string or an array of strings containing the value or values associated with `query.key`. You can * only use `query.value` in the search if `query.key` has been specified. * If no value is specified for `query.value`, then all nodes containing the specified key will be returned, * regardless of what the value of the key is. * The following example shows a single string being passed in: * ```javascript * value: "Box #14"``` * The following example shows an array of strings being passed in: * ```javascript * value: ["Box #3", "box #4", "BOX #5"]``` * * - **query.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for key values that exactly match the provided string or array of strings. * * Using `"contains"` will search for key values containing all or part of the provided string or array * of strings. * Using `"startsWith"` will search key values starting with the provided string or array of strings. * If no value is specified, the search mode will default to `"equals"`. * * * - **query.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): any[]; /** * Finds nodes in a scene via node name. * * @since 1.50.0 * * @returns A list of reference objects belonging to nodes that matched the search criteria. */ findNodesByName( /** * JSON object containing the search parameters. * The following example shows what the structure of the `query` object should look like: * ```javascript * query = { * value: string | string[], * predicate: "equals" | "contains" | "startsWith", * caseSensitive: true | false * }``` * * * - **query.value** * A string or an array of strings containing the name of a node or names of nodes. If no value is specified, * then all nodes in the scene will be returned. * The following example shows a single string being passed in: * ```javascript * value: "Box #14"``` * The following example shows an array of strings being passed in: * ```javascript * value: ["Box #3", "box #4", "BOX #5"]``` * * - **query.predicate** * Represents a search mode. The available search modes are `"equals"`, `"contains"`, and `"startsWith"`. * * Using `"equals"` will search for nodes with names that exactly match the provided string or array of * strings. * Using `"contains"` will search for nodes with names containing all or part of the provided string or * array of strings. * Using `"startsWith"` will search for nodes with names starting with the provided string or array of * strings. * If no value is specified, the search mode will default to `"equals"`. * * * - **query.caseSensitive** * Indicates whether the search should be case sensitive or not. * If `true`, the search will be case sensitive, and `false` indicates otherwise. * If no value is specified, `caseSensitive` will default to `false` (that is, the search will be a case-insensitive * search). */ query: object ): any[]; /** * Fires event {@link #event:changed changed} 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 */ fireChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:nodeCreated nodeCreated} 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 */ fireNodeCreated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NodeHierarchy$NodeCreatedEventParameters ): this; /** * Fires event {@link #event:nodeRemoving nodeRemoving} 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 */ fireNodeRemoving( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NodeHierarchy$NodeRemovingEventParameters ): this; /** * Fires event {@link #event:nodeReplaced nodeReplaced} 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 */ fireNodeReplaced( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NodeHierarchy$NodeReplacedEventParameters ): this; /** * Fires event {@link #event:nodeUpdated nodeUpdated} 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 */ fireNodeUpdated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.NodeHierarchy$NodeUpdatedEventParameters ): this; /** * Returns a list of reference objects belonging to the ancestors of a particular node. * * @since 1.50.0 * * @returns A list of reference objects belonging to the ancestors of `nodeRef`. */ getAncestors( /** * The reference object of the node whose ancestors will be returned. */ nodeRef: any ): any[]; /** * Returns a list of reference objects belonging to the children of a particular node. * * @since 1.50.0 * * @returns A list of reference objects belonging to the children of `nodeRef`. */ getChildren( /** * The reference object of the node whose children will be returned. If `nodeRef` is not passed to the `getChildren` * function, the reference objects of the root nodes will be returned. */ nodeRef: any, /** * Indicates whether to return only the child nodes of a closed node or not. If `true`, then the * children of that closed node will be returned. If `false`, then the children of that closed node * will not be returned. */ stepIntoClosedNodes?: boolean ): any[]; /** * Returns a list of hotspot IDs. * * @since 1.50.0 * @deprecated As of version 1.128.0. please use {@link sap.ui.vk.NodeHierarchy#getHotspotNodeRefs getHotspotNodeRefs } * instead. * * @returns A list of hotspot IDs. */ getHotspotNodeIds(): string[]; /** * Returns a list of hotspot node references. * * @since 1.128.0 * * @returns A list of hotspot node references. */ getHotspotNodeRefs(): any[]; /** * Returns a list of layer IDs. * * @since 1.50.0 * * @returns A list of layer IDs. */ getLayers(): string[]; /** * Get node content type * * @since 1.73.0 * * @returns Node content type */ getNodeContentType( /** * The node reference */ nodeRef: any ): sap.ui.vk.NodeContentType; /** * Gets the Scene object the node hierarchy belongs to. * * @since 1.50.0 * * @returns The Scene object the node hierarchy belongs to. */ getScene(): sap.ui.vk.Scene; /** * Gets the scene reference that this NodeHierarchy object wraps. * * * @returns The scene reference that this NodeHierarchy object wraps. */ getSceneRef(): any; /** * Deletes a node and destroys it. * * @since 1.50.0 * * @returns `this` to allow method chaining. */ removeNode( /** * The reference object of the node to destroy. */ nodeRef: any ): this; } /** * Provides a proxy object to the node in the node hierarchy. * * Objects of this type should only be created with the {@link sap.ui.vk.NodeHierarchy#createNodeProxy sap.ui.vk.NodeHierarchy.createNodeProxy } * method. and destroyed with the {@link sap.ui.vk.NodeHierarchy#destroyNodeProxy sap.ui.vk.NodeHierarchy.destroyNodeProxy } * method. * * @since 1.32.0 */ class NodeProxy extends sap.ui.base.ManagedObject { /** * Constructor for a new NodeProxy. * * 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(); /** * Creates a new subclass of class sap.ui.vk.NodeProxy 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.NodeProxy. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Binds property {@link #getLocalMatrix localMatrix} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindLocalMatrix( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Binds property {@link #getOpacity opacity} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindOpacity( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Binds property {@link #getTintColor tintColor} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindTintColor( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Binds property {@link #getTintColorABGR tintColorABGR} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindTintColorABGR( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Binds property {@link #getWorldMatrix worldMatrix} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindWorldMatrix( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Gets current value of property {@link #getClosed closed}. * * The indicator showing if the node is closed. This property is read-only. * * * @returns Value of property `closed` */ getClosed(): boolean; /** * Gets current value of property {@link #getHasChildren hasChildren}. * * The indicator showing if the node has child nodes. This property is read-only. * * * @returns Value of property `hasChildren` */ getHasChildren(): boolean; /** * Gets current value of property {@link #getLocalMatrix localMatrix}. * * The local transformation matrix of the node. * * * @returns Value of property `localMatrix` */ getLocalMatrix(): float[]; /** * get local rotation represented by axis and angle * * * @returns angleAxis rotation [x, y, z, angle], (x, y, z) - rotation axis */ getLocalRotationInAngleAxis(): float[]; /** * get local rotation in Euler form * * * @returns angleAxis rotation [a1, a2, a3, order] a1, a2, a3 - rotation angles about 1st, 2nd, 3nd axis * order - int encoding order of XYZ axis (e.g, order "XZY" - 011100, 01 - 3rd axis(Y), 11 - 2nd axis(Z), * 00 - 1st axis(X)) */ getLocalRotationInEuler(): float[]; /** * get local rotation represented by quaternion * * * @returns quaternion [x, y, z, w] */ getLocalRotationInQuaternion(): float[]; /** * get local scale vector * * * @returns scale vector */ getLocalScale(): float[]; /** * get local translate vector * * * @returns translate vector */ getLocalTranslate(): float[]; /** * Gets current value of property {@link #getMaterial material}. * * The material of the node (optional). * * * @returns Value of property `material` */ getMaterial(): sap.ui.vk.Material; /** * Gets current value of property {@link #getName name}. * * The name of the node. This property is read-only. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getNodeMetadata nodeMetadata}. * * The node metadata. This property is read-only. * * * @returns Value of property `nodeMetadata` */ getNodeMetadata(): object; /** * Gets current value of property {@link #getNodeRef nodeRef}. * * The node reference. This property is read-only. * * * @returns Value of property `nodeRef` */ getNodeRef(): any; /** * Gets current value of property {@link #getOpacity opacity}. * * The node opacity. * * * @returns Value of property `opacity` */ getOpacity(): float; /** * Gets current value of property {@link #getTintColor tintColor}. * * The tint color. * * * @returns Value of property `tintColor` */ getTintColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getTintColorABGR tintColorABGR}. * * The tint color. * * * The tint color is a 32-bit integer in the ABGR notation, where A is amount of blending between material * color and tint color. * * * @returns Value of property `tintColorABGR` */ getTintColorABGR(): int; /** * Gets current value of property {@link #getVeIds veIds}. * * The node VE IDs. This property is read-only. * * * @returns Value of property `veIds` */ getVeIds(): object[]; /** * Gets current value of property {@link #getWorldMatrix worldMatrix}. * * The world transformation matrix of the node. * * * @returns Value of property `worldMatrix` */ getWorldMatrix(): float[]; /** * Gets the scene reference that this NodeProxy object wraps. * * * @returns The scene reference that this NodeProxy object wraps. */ setClosed(): any; /** * Sets a new value for property {@link #getHasChildren hasChildren}. * * The indicator showing if the node has child nodes. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHasChildren( /** * New value for property `hasChildren` */ bHasChildren: boolean ): this; /** * Sets a new value for property {@link #getLocalMatrix localMatrix}. * * The local transformation matrix of the node. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLocalMatrix( /** * New value for property `localMatrix` */ sLocalMatrix: float[] ): this; /** * Sets a new value for property {@link #getMaterial material}. * * The material of the node (optional). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setMaterial( /** * New value for property `material` */ sMaterial: sap.ui.vk.Material ): this; /** * Sets a new value for property {@link #getName name}. * * The name of the node. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; /** * Sets a new value for property {@link #getNodeMetadata nodeMetadata}. * * The node metadata. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setNodeMetadata( /** * New value for property `nodeMetadata` */ oNodeMetadata: object ): this; /** * Sets a new value for property {@link #getNodeRef nodeRef}. * * The node reference. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setNodeRef( /** * New value for property `nodeRef` */ oNodeRef: any ): this; /** * Sets a new value for property {@link #getOpacity opacity}. * * The node opacity. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setOpacity( /** * New value for property `opacity` */ fOpacity: float ): this; /** * Sets a new value for property {@link #getTintColor tintColor}. * * The tint color. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTintColor( /** * New value for property `tintColor` */ sTintColor: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getTintColorABGR tintColorABGR}. * * The tint color. * * * The tint color is a 32-bit integer in the ABGR notation, where A is amount of blending between material * color and tint color. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTintColorABGR( /** * New value for property `tintColorABGR` */ iTintColorABGR: int ): this; /** * Sets a new value for property {@link #getVeIds veIds}. * * The node VE IDs. This property is read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setVeIds( /** * New value for property `veIds` */ sVeIds: object[] ): this; /** * Sets a new value for property {@link #getWorldMatrix worldMatrix}. * * The world transformation matrix of the node. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWorldMatrix( /** * New value for property `worldMatrix` */ sWorldMatrix: float[] ): this; /** * Unbinds property {@link #getLocalMatrix localMatrix} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindLocalMatrix(): this; /** * Unbinds property {@link #getOpacity opacity} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindOpacity(): this; /** * Unbinds property {@link #getTintColor tintColor} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindTintColor(): this; /** * Unbinds property {@link #getTintColorABGR tintColorABGR} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindTintColorABGR(): this; /** * Unbinds property {@link #getWorldMatrix worldMatrix} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindWorldMatrix(): this; } /** * Provides the ability to display logged console messages within your application. * * @since 1.38.0 */ class Notifications extends sap.ui.core.Control { /** * Constructor for a new Notifications. * * 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 Notifications control. */ mSettings?: sap.ui.vk.$NotificationsSettings ); /** * Constructor for a new Notifications. * * 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 Notifications control. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Notifications control. */ mSettings?: sap.ui.vk.$NotificationsSettings ); /** * Creates a new subclass of class sap.ui.vk.Notifications 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Notifications. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:allMessagesCleared allMessagesCleared} event * of this `sap.ui.vk.Notifications`. * * 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.Notifications` itself. * * This event will be fired when all messages in the log are deleted. * * * @returns Reference to `this` in order to allow method chaining */ attachAllMessagesCleared( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Notifications` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:allMessagesCleared allMessagesCleared} event * of this `sap.ui.vk.Notifications`. * * 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.Notifications` itself. * * This event will be fired when all messages in the log are deleted. * * * @returns Reference to `this` in order to allow method chaining */ attachAllMessagesCleared( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Notifications` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageAdded messageAdded} event of this `sap.ui.vk.Notifications`. * * 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.Notifications` itself. * * This event will be fired when a new log message is added. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageAdded( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Notifications` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:messageAdded messageAdded} event of this `sap.ui.vk.Notifications`. * * 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.Notifications` itself. * * This event will be fired when a new log message is added. * * * @returns Reference to `this` in order to allow method chaining */ attachMessageAdded( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Notifications` itself */ oListener?: object ): this; /** * Clears the items in the Message Popover list. * * * @returns `this` to allow method chaining. */ clearAllMessages(): this; /** * Detaches event handler `fnFunction` from the {@link #event:allMessagesCleared allMessagesCleared} event * of this `sap.ui.vk.Notifications`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAllMessagesCleared( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:messageAdded messageAdded} event of this `sap.ui.vk.Notifications`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachMessageAdded( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:allMessagesCleared allMessagesCleared} 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 */ fireAllMessagesCleared( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:messageAdded messageAdded} 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 */ fireMessageAdded( /** * Parameters to pass along with the event */ mParameters?: object ): this; } /** * Provides the interface for the orthographic camera. * * @since 1.52.0 */ class OrthographicCamera extends sap.ui.vk.Camera { /** * Constructor for a new OrthographicCamera. * * 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(); /** * Creates a new subclass of class sap.ui.vk.OrthographicCamera 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.vk.Camera.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.OrthographicCamera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets current value of property {@link #getZoomFactor zoomFactor}. * * Camera zoom factor * * * @returns Value of property `zoomFactor` */ getZoomFactor(): float; /** * Sets a new value for property {@link #getZoomFactor zoomFactor}. * * Camera zoom factor * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setZoomFactor( /** * New value for property `zoomFactor` */ fZoomFactor: float ): this; } /** * Aggregation element for the output settings of the Viewport * * @since 1.92.0 */ class OutputSettings extends sap.ui.core.Element { /** * Constructor for a new OutputSettings. * * 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?: sap.ui.vk.$OutputSettingsSettings ); /** * Constructor for a new OutputSettings. * * 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?: sap.ui.vk.$OutputSettingsSettings ); /** * Creates a new subclass of class sap.ui.vk.OutputSettings 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.OutputSettings. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getDpi dpi}. * * density of the output, unit in dpi (dots-per-inch) * * * @returns Value of property `dpi` */ getDpi(): float; /** * Gets current value of property {@link #getHeight height}. * * height of the output, unit in mm * * * @returns Value of property `height` */ getHeight(): float; /** * Gets current value of property {@link #getWidth width}. * * width of the output, unit in mm * * * @returns Value of property `width` */ getWidth(): float; /** * Sets a new value for property {@link #getDpi dpi}. * * density of the output, unit in dpi (dots-per-inch) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDpi( /** * New value for property `dpi` */ fDpi: float ): this; /** * Sets a new value for property {@link #getHeight height}. * * height of the output, unit in mm * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ fHeight: float ): this; /** * Sets a new value for property {@link #getWidth width}. * * width of the output, unit in mm * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ fWidth: float ): this; } /** * Constructor for a new Overlay. * * @since 1.32.0 * @deprecated As of version 1.120. This is not in use anymore. Please consider using Redline tool, see * {@link sap.ui.vk.RedlineTool} */ class Overlay extends sap.ui.core.Control { /** * Constructor for a new Overlay. * * 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?: sap.ui.vk.$OverlaySettings ); /** * Constructor for a new Overlay. * * 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?: sap.ui.vk.$OverlaySettings ); /** * Creates a new subclass of class sap.ui.vk.Overlay 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Overlay. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some area to the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ addArea( /** * The area to add; if empty, nothing is inserted */ oArea: sap.ui.vk.OverlayArea ): this; /** * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vk.Overlay`. * * 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.Overlay` itself. * * Raised when the Control is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachClick( /** * 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: Overlay$ClickEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Overlay` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vk.Overlay`. * * 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.Overlay` itself. * * Raised when the Control is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachClick( /** * The function to be called when the event occurs */ fnFunction: (p1: Overlay$ClickEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Overlay` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.Overlay`. * * 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.Overlay` itself. * * Raised when the Control is right clicked/longPress(tap and hold). * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * 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: Overlay$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Overlay` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.Overlay`. * * 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.Overlay` itself. * * Raised when the Control is right clicked/longPress(tap and hold). * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * The function to be called when the event occurs */ fnFunction: (p1: Overlay$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Overlay` itself */ oListener?: object ): this; /** * Destroys all the areas in the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ destroyAreas(): this; /** * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.vk.Overlay`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClick( /** * The function to be called, when the event occurs */ fnFunction: (p1: Overlay$ClickEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.Overlay`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContextMenu( /** * The function to be called, when the event occurs */ fnFunction: (p1: Overlay$ContextMenuEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:click click} 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 */ fireClick( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Overlay$ClickEventParameters ): this; /** * Fires event {@link #event:contextMenu contextMenu} 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 */ fireContextMenu( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Overlay$ContextMenuEventParameters ): this; /** * Gets content of aggregation {@link #getAreas areas}. * * Aggregation of Highlight Areas. */ getAreas(): sap.ui.vk.OverlayArea[]; /** * Trigger the interactive creation mode to get a position or position array. * * * @returns Indicator whether the creation mode could be triggered successfully or not. */ getPositionInteractive( /** * Indicator if a single position or an array is requested */ bPosArray: boolean, /** * Callback function func( sPosArray ) to be called when done. Position(array) sPosArray is provided in * format "x;y;0;..." */ callback: Function ): boolean; /** * ID of the element which is the current target of the association {@link #getTarget target}, or `null`. */ getTarget(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getZoomOnResize zoomOnResize}. * * Default value is `true`. * * * @returns Value of property `zoomOnResize` */ getZoomOnResize(): boolean; /** * Checks for the provided `sap.ui.vk.OverlayArea` in the aggregation {@link #getAreas areas}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfArea( /** * The area whose index is looked for */ oArea: sap.ui.vk.OverlayArea ): int; /** * Inserts a area into the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ insertArea( /** * The area to insert; if empty, nothing is inserted */ oArea: sap.ui.vk.OverlayArea, /** * The `0`-based index the area should be inserted at; for a negative value of `iIndex`, the area is inserted * at position 0; for a value greater than the current size of the aggregation, the area is inserted at * the last position */ iIndex: int ): this; /** * open the context menu */ openContextMenu( /** * the context menu to be opened */ oMenu: object ): void; /** * Removes all the controls from the aggregation {@link #getAreas areas}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllAreas(): sap.ui.vk.OverlayArea[]; /** * Removes a area from the aggregation {@link #getAreas areas}. * * * @returns The removed area or `null` */ removeArea( /** * The area to remove or its index or id */ vArea: int | string | sap.ui.vk.OverlayArea ): sap.ui.vk.OverlayArea | null; /** * Reset the Overlay to its initial size and position. * * * @returns This allows method chaining */ reset(): sap.ui.vk.Overlay; /** * Pan and Zoom for the Overlay. The offsets `nDeltaX` and `nDeltaY` are applied to the current * center position. If zooming is involved as well the offsets are applied after the zooming. */ setPanAndZoom( /** * the move of the center in x-direction in pixels */ nDeltaX: int, /** * the move of the center in y-direction in pixels */ nDeltaY: int, /** * the zoom factor to apply to the current state */ fZoom: float ): void; /** * Sets the associated {@link #getTarget target}. * * * @returns Reference to `this` in order to allow method chaining */ setTarget( /** * ID of an element which becomes the new target of this target association; alternatively, an element instance * may be given */ oTarget: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getZoomOnResize zoomOnResize}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setZoomOnResize( /** * New value for property `zoomOnResize` */ bZoomOnResize?: boolean ): this; } /** * Aggregation element for the Overlay Control * * @since 1.32.0 * @deprecated As of version 1.120. This is not in use anymore. Please consider using Redline tool, see * {@link sap.ui.vk.RedlineTool} */ class OverlayArea extends sap.ui.core.Element { /** * Constructor for a new OverlayArea. * * 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?: sap.ui.vk.$OverlayAreaSettings ); /** * Constructor for a new OverlayArea. * * 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?: sap.ui.vk.$OverlayAreaSettings ); /** * Creates a new subclass of class sap.ui.vk.OverlayArea 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.OverlayArea. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * The event is raised when there is a click action on an OverlayArea. * * * @returns Reference to `this` in order to allow method chaining */ attachClick( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:click click} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * The event is raised when there is a click action on an OverlayArea. * * * @returns Reference to `this` in order to allow method chaining */ attachClick( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * The event is raised when there is a right click or a tap and hold action on an OverlayArea. * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * 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: OverlayArea$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * The event is raised when there is a right click or a tap and hold action on an OverlayArea. * * * @returns Reference to `this` in order to allow method chaining */ attachContextMenu( /** * The function to be called when the event occurs */ fnFunction: (p1: OverlayArea$ContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:edgeClick edgeClick} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the edge of an OverlayArea is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachEdgeClick( /** * 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: OverlayArea$EdgeClickEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:edgeClick edgeClick} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the edge of an OverlayArea is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachEdgeClick( /** * The function to be called when the event occurs */ fnFunction: (p1: OverlayArea$EdgeClickEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:edgeContextMenu edgeContextMenu} event of this * `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the edge of an OverlayArea is right clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachEdgeContextMenu( /** * 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: OverlayArea$EdgeContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:edgeContextMenu edgeContextMenu} event of this * `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the edge of an OverlayArea is right clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachEdgeContextMenu( /** * The function to be called when the event occurs */ fnFunction: (p1: OverlayArea$EdgeContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleClick handleClick} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleClick( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleClick handleClick} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleClick( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleContextMenu handleContextMenu} event of * this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is right clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleContextMenu( /** * 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: OverlayArea$HandleContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleContextMenu handleContextMenu} event of * this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is right clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleContextMenu( /** * The function to be called when the event occurs */ fnFunction: (p1: OverlayArea$HandleContextMenuEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleMoved handleMoved} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is moved. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleMoved( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:handleMoved handleMoved} event of this `sap.ui.vk.OverlayArea`. * * 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.OverlayArea` itself. * * This event is raised when the design handle of a changeable OverlayArea is moved. * * * @returns Reference to `this` in order to allow method chaining */ attachHandleMoved( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.OverlayArea` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:click click} event of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClick( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contextMenu contextMenu} event of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContextMenu( /** * The function to be called, when the event occurs */ fnFunction: (p1: OverlayArea$ContextMenuEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:edgeClick edgeClick} event of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEdgeClick( /** * The function to be called, when the event occurs */ fnFunction: (p1: OverlayArea$EdgeClickEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:edgeContextMenu edgeContextMenu} event of * this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEdgeContextMenu( /** * The function to be called, when the event occurs */ fnFunction: (p1: OverlayArea$EdgeContextMenuEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:handleClick handleClick} event of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHandleClick( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:handleContextMenu handleContextMenu} event * of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHandleContextMenu( /** * The function to be called, when the event occurs */ fnFunction: (p1: OverlayArea$HandleContextMenuEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:handleMoved handleMoved} event of this `sap.ui.vk.OverlayArea`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHandleMoved( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:click click} 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 */ fireClick( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:contextMenu contextMenu} 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 */ fireContextMenu( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.OverlayArea$ContextMenuEventParameters ): this; /** * Fires event {@link #event:edgeClick edgeClick} 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 */ fireEdgeClick( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.OverlayArea$EdgeClickEventParameters ): this; /** * Fires event {@link #event:edgeContextMenu edgeContextMenu} 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 */ fireEdgeContextMenu( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.OverlayArea$EdgeContextMenuEventParameters ): this; /** * Fires event {@link #event:handleClick handleClick} 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 */ fireHandleClick( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:handleContextMenu handleContextMenu} 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 */ fireHandleContextMenu( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.OverlayArea$HandleContextMenuEventParameters ): this; /** * Fires event {@link #event:handleMoved handleMoved} 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 */ fireHandleMoved( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getChangeable changeable}. * * Set to true if OverlayArea is changeable. * * Default value is `false`. * * * @returns Value of property `changeable` */ getChangeable(): boolean; /** * Gets current value of property {@link #getColor color}. * * The fill color of the OverlayArea. * * Default value is `"rgba(200, 50, 50, 0.3)"`. * * * @returns Value of property `color` */ getColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getColorBorder colorBorder}. * * The border color of the OverlayArea. * * Default value is `"rgba(200, 50, 50, 1.0)"`. * * * @returns Value of property `colorBorder` */ getColorBorder(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getColorNonSelect colorNonSelect}. * * The non-select color of the OverlayArea in case non-selection de-highlighting is desired. * * * @returns Value of property `colorNonSelect` */ getColorNonSelect(): string; /** * Gets current value of property {@link #getColorSelect colorSelect}. * * The select color of the OverlayArea in case selection highlighting is desired. * * * @returns Value of property `colorSelect` */ getColorSelect(): string; /** * Gets current value of property {@link #getDeltaColorHot deltaColorHot}. * * Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;) * * Default value is `"RHLSA(0;1.3;1.0;1.0)"`. * * * @returns Value of property `deltaColorHot` */ getDeltaColorHot(): string; /** * Gets current value of property {@link #getKey key}. * * Unique identifier for the object. This is optional. If not provided the default identifier sId is used. * However, sId is generated if template binding is used and thus it is not stable. Provide the key if the * object really needs a unique and stable identifier. * * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getPosition position}. * * The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0". * * * @returns Value of property `position` */ getPosition(): string; /** * Gets current value of property {@link #getSelect select}. * * set to true if the element is selected * * Default value is `false`. * * * @returns Value of property `select` */ getSelect(): boolean; /** * open the context menu */ openContextMenu( /** * the context menu to be opened */ oMenu: object ): void; /** * Sets a new value for property {@link #getChangeable changeable}. * * Set to true if OverlayArea is changeable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setChangeable( /** * New value for property `changeable` */ bChangeable?: boolean ): this; /** * Sets a new value for property {@link #getColor color}. * * The fill color of the OverlayArea. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(200, 50, 50, 0.3)"`. * * * @returns Reference to `this` in order to allow method chaining */ setColor( /** * New value for property `color` */ sColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getColorBorder colorBorder}. * * The border color of the OverlayArea. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(200, 50, 50, 1.0)"`. * * * @returns Reference to `this` in order to allow method chaining */ setColorBorder( /** * New value for property `colorBorder` */ sColorBorder?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getColorNonSelect colorNonSelect}. * * The non-select color of the OverlayArea in case non-selection de-highlighting is desired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColorNonSelect( /** * New value for property `colorNonSelect` */ sColorNonSelect?: string ): this; /** * Sets a new value for property {@link #getColorSelect colorSelect}. * * The select color of the OverlayArea in case selection highlighting is desired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColorSelect( /** * New value for property `colorSelect` */ sColorSelect?: string ): this; /** * Sets a new value for property {@link #getDeltaColorHot deltaColorHot}. * * Color or color delta when object is hovered. Color deltas can be declared in the format RHLSA(;;;) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"RHLSA(0;1.3;1.0;1.0)"`. * * * @returns Reference to `this` in order to allow method chaining */ setDeltaColorHot( /** * New value for property `deltaColorHot` */ sDeltaColorHot?: string ): this; /** * Sets a new value for property {@link #getKey key}. * * Unique identifier for the object. This is optional. If not provided the default identifier sId is used. * However, sId is generated if template binding is used and thus it is not stable. Provide the key if the * object really needs a unique and stable identifier. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getPosition position}. * * The position array for the OverlayArea. The format is "x0;y0;0;...;xN,yN,0". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPosition( /** * New value for property `position` */ sPosition?: string ): this; /** * Sets a new value for property {@link #getSelect select}. * * set to true if the element is selected * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSelect( /** * New value for property `select` */ bSelect?: boolean ): this; } /** * Provides the interface for the perspective camera. * * @since 1.52.0 */ class PerspectiveCamera extends sap.ui.vk.Camera { /** * Constructor for a new perspective camera. * * 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(); /** * Creates a new subclass of class sap.ui.vk.PerspectiveCamera 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.vk.Camera.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.PerspectiveCamera. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets current value of property {@link #getFov fov}. * * Camera frustum field of view in degree * * * @returns Value of property `fov` */ getFov(): float; /** * Sets a new value for property {@link #getFov fov}. * * Camera frustum field of view in degree * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setFov( /** * New value for property `fov` */ fFov: float ): this; } /** * Shows the progress of a process in a graphical way. To indicate the progress, the inside of the ProgressIndicator * is filled with a color. Additionally, a user-defined string can be displayed on the ProgressIndicator. * * @since 1.50.0 * @deprecated As of version 1.114.0. Use {@link sap.m.ProgressIndicator} instead. */ class ProgressIndicator extends sap.m.ProgressIndicator { /** * Constructor for a new ProgressIndicator. */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.vk.$ProgressIndicatorSettings ); /** * Constructor for a new ProgressIndicator. */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.vk.$ProgressIndicatorSettings ); } /** * Provides a base class control for RedlineCollaborations. * * @since 1.89.0 */ class RedlineCollaboration extends sap.ui.core.Element { /** * Constructor for a new RedlineCollaboration. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineCollaboration 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineCollaboration. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some conversation to the aggregation {@link #getConversations conversations}. * * * @returns Reference to `this` in order to allow method chaining */ addConversation( /** * The conversation to add; if empty, nothing is inserted */ oConversation: sap.ui.vk.RedlineConversation ): this; /** * Attaches event handler `fnFunction` to the {@link #event:conversationActivated conversationActivated } * event of this `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachConversationActivated( /** * 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: RedlineCollaboration$ConversationActivatedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:conversationActivated conversationActivated } * event of this `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachConversationActivated( /** * The function to be called when the event occurs */ fnFunction: ( p1: RedlineCollaboration$ConversationActivatedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:conversationActivating conversationActivating } * event of this `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachConversationActivating( /** * 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: RedlineCollaboration$ConversationActivatingEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:conversationActivating conversationActivating } * event of this `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachConversationActivating( /** * The function to be called when the event occurs */ fnFunction: ( p1: RedlineCollaboration$ConversationActivatingEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementClicked( /** * 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: RedlineCollaboration$ElementClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * 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: RedlineCollaboration$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementHovered( /** * 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: RedlineCollaboration$ElementHoveredEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.RedlineCollaboration`. * * 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.RedlineCollaboration` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementHovered( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementHoveredEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineCollaboration` itself */ oListener?: object ): this; /** * Destroys all the conversations in the aggregation {@link #getConversations conversations}. * * * @returns Reference to `this` in order to allow method chaining */ destroyConversations(): this; /** * Detaches event handler `fnFunction` from the {@link #event:conversationActivated conversationActivated } * event of this `sap.ui.vk.RedlineCollaboration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachConversationActivated( /** * The function to be called, when the event occurs */ fnFunction: ( p1: RedlineCollaboration$ConversationActivatedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:conversationActivating conversationActivating } * event of this `sap.ui.vk.RedlineCollaboration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachConversationActivating( /** * The function to be called, when the event occurs */ fnFunction: ( p1: RedlineCollaboration$ConversationActivatingEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementClicked elementClicked} event of this * `sap.ui.vk.RedlineCollaboration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineCollaboration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementCreatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementHovered elementHovered} event of this * `sap.ui.vk.RedlineCollaboration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementHovered( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineCollaboration$ElementHoveredEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:conversationActivated conversationActivated} 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 */ fireConversationActivated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineCollaboration$ConversationActivatedEventParameters ): this; /** * Fires event {@link #event:conversationActivating conversationActivating} 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 */ fireConversationActivating( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineCollaboration$ConversationActivatingEventParameters ): this; /** * Fires event {@link #event:elementClicked elementClicked} 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 */ fireElementClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineCollaboration$ElementClickedEventParameters ): this; /** * Fires event {@link #event:elementCreated elementCreated} 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 */ fireElementCreated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineCollaboration$ElementCreatedEventParameters ): this; /** * Fires event {@link #event:elementHovered elementHovered} 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 */ fireElementHovered( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineCollaboration$ElementHoveredEventParameters ): this; /** * ID of the element which is the current target of the association {@link #getActiveComment activeComment}, * or `null`. */ getActiveComment(): sap.ui.core.ID | null; /** * ID of the element which is the current target of the association {@link #getActiveConversation activeConversation}, * or `null`. */ getActiveConversation(): sap.ui.core.ID | null; /** * Gets content of aggregation {@link #getConversations conversations}. * * A list of available conversations. */ getConversations(): sap.ui.vk.RedlineConversation[]; /** * ID of the element which is the current target of the association {@link #getViewport viewport}, or `null`. */ getViewport(): sap.ui.core.ID | null; /** * Checks for the provided `sap.ui.vk.RedlineConversation` in the aggregation {@link #getConversations conversations}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfConversation( /** * The conversation whose index is looked for */ oConversation: sap.ui.vk.RedlineConversation ): int; /** * Inserts a conversation into the aggregation {@link #getConversations conversations}. * * * @returns Reference to `this` in order to allow method chaining */ insertConversation( /** * The conversation to insert; if empty, nothing is inserted */ oConversation: sap.ui.vk.RedlineConversation, /** * The `0`-based index the conversation should be inserted at; for a negative value of `iIndex`, the conversation * is inserted at position 0; for a value greater than the current size of the aggregation, the conversation * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getConversations conversations}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllConversations(): sap.ui.vk.RedlineConversation[]; /** * Removes a conversation from the aggregation {@link #getConversations conversations}. * * * @returns The removed conversation or `null` */ removeConversation( /** * The conversation to remove or its index or id */ vConversation: int | string | sap.ui.vk.RedlineConversation ): sap.ui.vk.RedlineConversation | null; /** * Sets the associated {@link #getActiveComment activeComment}. * * * @returns Reference to `this` in order to allow method chaining */ setActiveComment( /** * ID of an element which becomes the new target of this activeComment association; alternatively, an element * instance may be given */ oActiveComment: | sap.ui.core.ID | /* was: sap.ui.vk.RedlineComment */ any ): this; } /** * Provides a base class control for RedlineConversations. * * @since 1.89.0 */ class RedlineConversation extends sap.ui.core.Element { /** * Constructor for a new RedlineConversation. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineConversation 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineConversation. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some comment to the aggregation {@link #getComments comments}. * * * @returns Reference to `this` in order to allow method chaining */ addComment( /** * The comment to add; if empty, nothing is inserted */ oComment: sap.ui.vk.RedlineElementComment ): this; /** * Destroys all the comments in the aggregation {@link #getComments comments}. * * * @returns Reference to `this` in order to allow method chaining */ destroyComments(): this; /** * Gets current value of property {@link #getAnimationOffset animationOffset}. * * Default value is `0`. * * * @returns Value of property `animationOffset` */ getAnimationOffset(): float; /** * Gets content of aggregation {@link #getComments comments}. */ getComments(): sap.ui.vk.RedlineElementComment[]; /** * Gets current value of property {@link #getConversationName conversationName}. * * * @returns Value of property `conversationName` */ getConversationName(): string; /** * Gets current value of property {@link #getMeasurementScale measurementScale}. * * Default value is `1`. * * * @returns Value of property `measurementScale` */ getMeasurementScale(): float; /** * Gets current value of property {@link #getPageId pageId}. * * Default value is `-1`. * * * @returns Value of property `pageId` */ getPageId(): int; /** * Gets current value of property {@link #getTimestamp timestamp}. * * * @returns Value of property `timestamp` */ getTimestamp(): int; /** * Gets current value of property {@link #getViewId viewId}. * * Default value is `empty string`. * * * @returns Value of property `viewId` */ getViewId(): string; /** * Gets current value of property {@link #getViewInfo viewInfo}. * * * @returns Value of property `viewInfo` */ getViewInfo(): any; /** * Checks for the provided `sap.ui.vk.RedlineElementComment` in the aggregation {@link #getComments comments}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfComment( /** * The comment whose index is looked for */ oComment: sap.ui.vk.RedlineElementComment ): int; /** * Inserts a comment into the aggregation {@link #getComments comments}. * * * @returns Reference to `this` in order to allow method chaining */ insertComment( /** * The comment to insert; if empty, nothing is inserted */ oComment: sap.ui.vk.RedlineElementComment, /** * The `0`-based index the comment should be inserted at; for a negative value of `iIndex`, the comment * is inserted at position 0; for a value greater than the current size of the aggregation, the comment * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getComments comments}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllComments(): sap.ui.vk.RedlineElementComment[]; /** * Removes a comment from the aggregation {@link #getComments comments}. * * * @returns The removed comment or `null` */ removeComment( /** * The comment to remove or its index or id */ vComment: int | string | sap.ui.vk.RedlineElementComment ): sap.ui.vk.RedlineElementComment | null; /** * Sets a new value for property {@link #getAnimationOffset animationOffset}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setAnimationOffset( /** * New value for property `animationOffset` */ fAnimationOffset?: float ): this; /** * Sets a new value for property {@link #getConversationName conversationName}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setConversationName( /** * New value for property `conversationName` */ sConversationName: string ): this; /** * Sets a new value for property {@link #getMeasurementScale measurementScale}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setMeasurementScale( /** * New value for property `measurementScale` */ fMeasurementScale?: float ): this; /** * Sets a new value for property {@link #getPageId pageId}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `-1`. * * * @returns Reference to `this` in order to allow method chaining */ setPageId( /** * New value for property `pageId` */ iPageId?: int ): this; /** * Sets a new value for property {@link #getTimestamp timestamp}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTimestamp( /** * New value for property `timestamp` */ iTimestamp: int ): this; /** * Sets a new value for property {@link #getViewId viewId}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setViewId( /** * New value for property `viewId` */ sViewId?: string ): this; /** * Sets a new value for property {@link #getViewInfo viewInfo}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setViewInfo( /** * New value for property `viewInfo` */ oViewInfo?: any ): this; } /** * Provides a control for designing redlining shapes. * * @since 1.40.0 */ class RedlineDesign extends sap.ui.vk.RedlineSurface { /** * Constructor for a new RedlineDesign. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineDesign 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.vk.RedlineSurface.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineDesign. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineDesign`. * * 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.RedlineDesign` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * 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: RedlineDesign$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineDesign` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineDesign`. * * 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.RedlineDesign` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachElementCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineDesign$ElementCreatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineDesign` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:elementCreated elementCreated} event of this * `sap.ui.vk.RedlineDesign`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachElementCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineDesign$ElementCreatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:elementCreated elementCreated} 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 */ fireElementCreated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineDesign$ElementCreatedEventParameters ): this; /** * Prepares the RedlineDesign control for adding a new instance of {sap.ui.vk.RedlineElement}. * * * @returns `this` to allow method chaining. */ startAdding( /** * The redlining element which needs to be added. */ elementInstance: sap.ui.vk.RedlineElement ): this; /** * Stops the mode for adding redlining, which begins when the {@link sap.ui.vk.RedlineDesign#startAdding startAdding } * method is called. * * * @returns `this` to allow method chaining. */ stopAdding(): this; } /** * Provides a base class for redline elements. * * @since 1.40.0 */ class RedlineElement extends sap.ui.core.Element { /** * Base class for redline elements such as {@link sap.ui.vk.RedlineElementRectangle}, {@link sap.ui.vk.RedlineElementEllipse}, * {@link sap.ui.vk.RedlineElementFreehand}, {@link sap.ui.vk.RedlineElementLine}, {@link sap.ui.vk.RedlineElementText}. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElement 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElement. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Exports all the relevant data contained in the redline element to a JSON-like object. * * * @returns JSON Relevant data that can be serialized and later used to restore the redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the redline element to an SVG shape element. * * * @returns SVG shape element that can be used to restore the redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getCreatedByUser createdByUser}. * * Default value is `empty string`. * * * @returns Value of property `createdByUser` */ getCreatedByUser(): any; /** * Gets current value of property {@link #getCreateTimestamp createTimestamp}. * * * @returns Value of property `createTimestamp` */ getCreateTimestamp(): int; /** * Gets current value of property {@link #getDeletedByUser deletedByUser}. * * Default value is `empty string`. * * * @returns Value of property `deletedByUser` */ getDeletedByUser(): any; /** * Gets current value of property {@link #getDeleteTimestamp deleteTimestamp}. * * * @returns Value of property `deleteTimestamp` */ getDeleteTimestamp(): int; /** * Gets current value of property {@link #getElementId elementId}. * * * @returns Value of property `elementId` */ getElementId(): string; /** * Gets current value of property {@link #getHalo halo}. * * Default value is `false`. * * * @returns Value of property `halo` */ getHalo(): boolean; /** * Gets current value of property {@link #getHaloColor haloColor}. * * Default value is `"rgba(255, 0, 0, 1)"`. * * * @returns Value of property `haloColor` */ getHaloColor(): string; /** * Gets current value of property {@link #getOpacity opacity}. * * Default value is `1`. * * * @returns Value of property `opacity` */ getOpacity(): float; /** * Gets current value of property {@link #getOriginX originX}. * * Default value is `0`. * * * @returns Value of property `originX` */ getOriginX(): float; /** * Gets current value of property {@link #getOriginY originY}. * * Default value is `0`. * * * @returns Value of property `originY` */ getOriginY(): float; /** * Gets current value of property {@link #getStrokeColor strokeColor}. * * Default value is `"#e6600d"`. * * * @returns Value of property `strokeColor` */ getStrokeColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getStrokeDashArray strokeDashArray}. * * Default value is `[]`. * * * @returns Value of property `strokeDashArray` */ getStrokeDashArray(): float[]; /** * Gets current value of property {@link #getStrokeWidth strokeWidth}. * * Default value is `2`. * * * @returns Value of property `strokeWidth` */ getStrokeWidth(): float; /** * Gets current value of property {@link #getSuppress suppress}. * * Default value is `false`. * * * @returns Value of property `suppress` */ getSuppress(): boolean; /** * Imports data from a JSON-like object into the redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data that can be used to restore the redline element. */ json: object ): this; /** * Imports data from an SVG shape element into the redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG shape element that can be used to restore the redline element. */ svg: object ): this; /** * This method is called by the RenderManager. The current method is empty because this is a base class * and the classes extending this class have their own implementations of the `render` method. */ render( /** * Instance of RenderManager. */ renderManager: sap.ui.core.RenderManager ): void; /** * This method is called by the RenderManager. The current method is empty because this is a base class * and the classes extending this class have their own implementations of the `render` method. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ renderElement( /** * Instance of RenderManager. */ renderManager: sap.ui.core.RenderManager, /** * If set to true then halo effect is rendered, otherwise this will do normal object rendering */ halo: boolean ): void; /** * Sets a new value for property {@link #getCreatedByUser createdByUser}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setCreatedByUser( /** * New value for property `createdByUser` */ oCreatedByUser?: any ): this; /** * Sets a new value for property {@link #getCreateTimestamp createTimestamp}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setCreateTimestamp( /** * New value for property `createTimestamp` */ iCreateTimestamp?: int ): this; /** * Sets a new value for property {@link #getDeletedByUser deletedByUser}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setDeletedByUser( /** * New value for property `deletedByUser` */ oDeletedByUser?: any ): this; /** * Sets a new value for property {@link #getDeleteTimestamp deleteTimestamp}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDeleteTimestamp( /** * New value for property `deleteTimestamp` */ iDeleteTimestamp?: int ): this; /** * Sets a new value for property {@link #getElementId elementId}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setElementId( /** * New value for property `elementId` */ sElementId?: string ): this; /** * Sets a new value for property {@link #getHalo halo}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setHalo( /** * New value for property `halo` */ bHalo?: boolean ): this; /** * Sets a new value for property {@link #getHaloColor haloColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(255, 0, 0, 1)"`. * * * @returns Reference to `this` in order to allow method chaining */ setHaloColor( /** * New value for property `haloColor` */ sHaloColor?: string ): this; /** * Sets a new value for property {@link #getOpacity opacity}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setOpacity( /** * New value for property `opacity` */ fOpacity?: float ): this; /** * Sets a new value for property {@link #getOriginX originX}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setOriginX( /** * New value for property `originX` */ fOriginX?: float ): this; /** * Sets a new value for property {@link #getOriginY originY}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setOriginY( /** * New value for property `originY` */ fOriginY?: float ): this; /** * Sets a new value for property {@link #getStrokeColor strokeColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"#e6600d"`. * * * @returns Reference to `this` in order to allow method chaining */ setStrokeColor( /** * New value for property `strokeColor` */ sStrokeColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getStrokeDashArray strokeDashArray}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * * @returns Reference to `this` in order to allow method chaining */ setStrokeDashArray( /** * New value for property `strokeDashArray` */ sStrokeDashArray?: float[] ): this; /** * Sets a new value for property {@link #getStrokeWidth strokeWidth}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `2`. * * * @returns Reference to `this` in order to allow method chaining */ setStrokeWidth( /** * New value for property `strokeWidth` */ fStrokeWidth?: float ): this; /** * Sets a new value for property {@link #getSuppress suppress}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSuppress( /** * New value for property `suppress` */ bSuppress?: boolean ): this; } /** * Provides a control for creating RedlineElementComments. * * @since 1.89.0 */ class RedlineElementComment extends sap.ui.core.Element { /** * Redline element control for comment. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementComment 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementComment. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getCreatedByUser createdByUser}. * * Default value is `empty string`. * * * @returns Value of property `createdByUser` */ getCreatedByUser(): any; /** * Gets current value of property {@link #getCreateTimestamp createTimestamp}. * * * @returns Value of property `createTimestamp` */ getCreateTimestamp(): int; /** * Gets current value of property {@link #getText text}. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Sets a new value for property {@link #getCreatedByUser createdByUser}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setCreatedByUser( /** * New value for property `createdByUser` */ oCreatedByUser?: any ): this; /** * Sets a new value for property {@link #getCreateTimestamp createTimestamp}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setCreateTimestamp( /** * New value for property `createTimestamp` */ iCreateTimestamp?: int ): this; /** * Sets a new value for property {@link #getText text}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; } /** * Provides a control for creating ellipse redline elements. * * @since 1.40.0 */ class RedlineElementEllipse extends sap.ui.vk.RedlineElement { /** * Redline element control for ellipse. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementEllipse 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.vk.RedlineElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementEllipse. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Changes the current radiusX and radiusY of the ellipse redline element by a factor which gets passed * as parameter. * * * @returns `this` to allow method chaining. */ applyZoom( /** * The factor to be applied to the current radiusX and radiusY. */ zoomBy: number ): this; /** * Changes the current radiusX, radiusY, originX and originY of the ellipse redline element with the values * passed as parameters. * * * @returns `this` to allow method chaining. */ edit( /** * The value in pixels that radiusX and originX will be calculated from for the ellipse. */ offsetX: number, /** * The value in pixels that radiusY and originY will be calculated from for the ellipse. */ offsetY: number, /** * True if the element is circle or False/Undefined otherwise. */ isCircle: boolean ): this; /** * Exports all the relevant data contained in the ellipse redline element to a JSON object. * * * @returns Data that can be serialized and later used to restore the ellipse redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the ellipse redline element to an SVG ellipse element. * * * @returns SVG ellipse element that can be used to restore the ellipse redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getFillColor fillColor}. * * Default value is `"rgba(0, 0, 0, 0)"`. * * * @returns Value of property `fillColor` */ getFillColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getRadiusX radiusX}. * * Default value is `0.0001`. * * * @returns Value of property `radiusX` */ getRadiusX(): float; /** * Gets current value of property {@link #getRadiusY radiusY}. * * Default value is `0.0001`. * * * @returns Value of property `radiusY` */ getRadiusY(): float; /** * Imports data from a JSON object into the ellipse redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data used to restore the ellipse redline element. */ json: object ): this; /** * Imports data from an SVG ellipse element into the ellipse redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG ellipse element used to restore the ellipse redline element. */ svg: object ): this; /** * Sets a new value for property {@link #getFillColor fillColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(0, 0, 0, 0)"`. * * * @returns Reference to `this` in order to allow method chaining */ setFillColor( /** * New value for property `fillColor` */ sFillColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getRadiusX radiusX}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0001`. * * * @returns Reference to `this` in order to allow method chaining */ setRadiusX( /** * New value for property `radiusX` */ fRadiusX?: float ): this; /** * Sets a new value for property {@link #getRadiusY radiusY}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0001`. * * * @returns Reference to `this` in order to allow method chaining */ setRadiusY( /** * New value for property `radiusY` */ fRadiusY?: float ): this; } /** * Provides a control for creating freehand redline elements. * * @since 1.40.0 */ class RedlineElementFreehand extends sap.ui.vk.RedlineElement { /** * Redline element control for freehand. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementFreehand 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.vk.RedlineElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementFreehand. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Creates a string path based on the current `path` property. The string path can then be used to set the * "d" attribute of an SVG element. * * * @returns String to be used as "d" attribute value for element. */ _getProcessedPath(): string; /** * Applies a zoom factor to the current freehand redline element. * * * @returns `this` to allow method chaining. */ applyZoom( /** * The factor to be applied to the current freehand drawing. */ zoomBy: number ): this; /** * Adds a new point to the current freehand path. * * * @returns `this` to allow method chaining. */ edit( /** * The value in pixels that will be set as the origin of the x-coordinate for a new point in the freehand * path. */ offsetX: number, /** * The value in pixels that will be set as the origin of the y-coordinate for a new point in the freehand * path. */ offsetY: number ): this; /** * Exports all the relevant data contained in the freehand redline element to a JSON object. * * * @returns Data that can be serialized and later used to restore the freehand redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the freehand redline element to an SVG path element. * * * @returns SVG path element that can be used to restore the freehand redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getPath path}. * * * @returns Value of property `path` */ getPath(): float[]; /** * Imports data from JSON into the redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data that can be used to restore the freehand redline element. */ json: object ): this; /** * Imports data from SVG path element into the freehand redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG path element that can be used to restore the freehand redline element. */ svg: object ): this; /** * Sets a new value for property {@link #getPath path}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPath( /** * New value for property `path` */ sPath?: float[] ): this; } /** * Provides a control for creating line redline elements. * * @since 1.40.0 */ class RedlineElementLine extends sap.ui.vk.RedlineElement { /** * Redline element control for line. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementLine 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.vk.RedlineElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementLine. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Changes the current deltaX and deltaY of the line redline element by a factor which gets passed as parameter. * * * @returns `this` to allow method chaining. */ applyZoom( /** * The factor to be applied to the current deltaX and deltaY. */ zoomBy: number ): this; /** * Changes the current deltaX and deltaY of the line redline element with the values passed as parameters. * * * @returns `this` to allow method chaining. */ edit( /** * The value in pixels that will be set as deltaX for the line. */ offsetX: number, /** * The value in pixels that will be set as deltaY for the line. */ offsetY: number ): this; /** * Exports all the relevant data contained in the line redline element to a JSON object. * * * @returns Data that can be serialized and later used to restore the line redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the line redline element to an SVG line element. * * * @returns SVG line element that can be used to restore the line redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getDeltaX deltaX}. * * Default value is `0`. * * * @returns Value of property `deltaX` */ getDeltaX(): float; /** * Gets current value of property {@link #getDeltaY deltaY}. * * Default value is `0`. * * * @returns Value of property `deltaY` */ getDeltaY(): float; /** * Gets current value of property {@link #getEndArrowHead endArrowHead}. * * Default value is `false`. * * * @returns Value of property `endArrowHead` */ getEndArrowHead(): boolean; /** * Imports data from a JSON object into the line redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data used to restore the line redline element. */ json: object ): this; /** * Imports data from an SVG line element into the line redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG line element used to restore the line redline element. */ svg: object ): this; /** * Sets a new value for property {@link #getDeltaX deltaX}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setDeltaX( /** * New value for property `deltaX` */ fDeltaX?: float ): this; /** * Sets a new value for property {@link #getDeltaY deltaY}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setDeltaY( /** * New value for property `deltaY` */ fDeltaY?: float ): this; /** * Sets a new value for property {@link #getEndArrowHead endArrowHead}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEndArrowHead( /** * New value for property `endArrowHead` */ bEndArrowHead?: boolean ): this; } /** * Provides a control for creating rectangle redline elements. * * @since 1.40.0 */ class RedlineElementRectangle extends sap.ui.vk.RedlineElement { /** * Redline element control for rectangle. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementRectangle 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.vk.RedlineElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementRectangle. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Changes the current width and height of the rectangle redline element by a factor which gets passed as * parameter. * * * @returns `this` to allow method chaining. */ applyZoom( /** * The factor to be applied to the current width and height. */ zoomBy: number ): this; /** * Changes the current width and height of the rectangle redline element with the values passed as parameters. * * * @returns `this` to allow method chaining. */ edit( /** * The value in pixels that will be set as the width for the rectangle redline element. */ offsetX: number, /** * The value in pixels that will be set as the height for the rectangle redline element. */ offsetY: number, /** * True if the element is square False/Undefined otherwise. */ isSquare: boolean ): this; /** * Exports all the relevant data contained in the rectangle redline element to a JSON object. * * * @returns Data that can be serialized and later used to restore the rectangle redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the rectangle redline element to an SVG rect element. * * * @returns SVG rect element that can be used to restore the rectangle redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getFillColor fillColor}. * * Default value is `"rgba(0, 0, 0, 0)"`. * * * @returns Value of property `fillColor` */ getFillColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getHeight height}. * * Default value is `0.001`. * * * @returns Value of property `height` */ getHeight(): float; /** * Gets current value of property {@link #getWidth width}. * * Default value is `0.001`. * * * @returns Value of property `width` */ getWidth(): float; /** * Imports data from a JSON object into the rectangle redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data used to restore the rectangle redline element. */ json: object ): this; /** * Imports data from an SVG rect element into the rectangle redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG rect element used to restore the rectangle redline element. */ svg: object ): this; /** * Sets a new value for property {@link #getFillColor fillColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(0, 0, 0, 0)"`. * * * @returns Reference to `this` in order to allow method chaining */ setFillColor( /** * New value for property `fillColor` */ sFillColor?: sap.ui.core.CSSColor ): 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 `0.001`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ fHeight?: float ): 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 `0.001`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ fWidth?: float ): this; } /** * Provides a control for creating text redline elements. * * @since 1.40.0 */ class RedlineElementText extends sap.ui.vk.RedlineElement { /** * Redline element control for text. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineElementText 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.vk.RedlineElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineElementText. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Changes the current font size of the text redline element by a factor which gets passed as parameter. * * * @returns `this` to allow method chaining. */ applyZoom( /** * The factor to be applied to the current font size. */ zoomBy: number ): this; /** * Changes the current originX and originY of the text redline element with the values passed as parameters. * * * @returns `this` to allow method chaining. */ edit( /** * The value in pixels that will be set as originX for the text. */ posX: number, /** * The value in pixels that will be set as originY for the text. */ posY: number ): this; /** * Exports all the relevant data contained in the text redline element to a JSON object. * * * @returns Data that can be serialized and later used to restore the text redline element. */ exportJSON(): object; /** * Exports all the relevant data contained in the text redline element to an SVG text element. * * * @returns SVG text element that can be used to restore the text redline element. */ exportSVG(): object; /** * Gets current value of property {@link #getFillColor fillColor}. * * Default value is `"rgba(0,0,0,0)"`. * * * @returns Value of property `fillColor` */ getFillColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getFont font}. * * Default value is `empty string`. * * * @returns Value of property `font` */ getFont(): string; /** * Gets current value of property {@link #getFontSize fontSize}. * * Default value is `32`. * * * @returns Value of property `fontSize` */ getFontSize(): float; /** * Gets current value of property {@link #getHeight height}. * * Default value is `0`. * * * @returns Value of property `height` */ getHeight(): float; /** * Gets current value of property {@link #getText text}. * * Default value is `"Text"`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getWidth width}. * * Default value is `300`. * * * @returns Value of property `width` */ getWidth(): float; /** * Imports data from a JSON object into the text redline element. * * * @returns `this` to allow method chaining. */ importJSON( /** * Relevant data used to restore the text redline element. */ json: object ): this; /** * Imports data from an SVG text element into the text redline element. * * * @returns `this` to allow method chaining. */ importSVG( /** * SVG text element used to restore the text redline element. */ element: object ): this; /** * Sets a new value for property {@link #getFillColor fillColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(0,0,0,0)"`. * * * @returns Reference to `this` in order to allow method chaining */ setFillColor( /** * New value for property `fillColor` */ sFillColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getFont font}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setFont( /** * New value for property `font` */ sFont?: string ): this; /** * Sets a new value for property {@link #getFontSize fontSize}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `32`. * * * @returns Reference to `this` in order to allow method chaining */ setFontSize( /** * New value for property `fontSize` */ fFontSize?: float ): 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 `0`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ fHeight?: float ): this; /** * Sets a new value for property {@link #getText text}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Text"`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): 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 `300`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ fWidth?: float ): this; } /** * Provides a bass class control for redlining. * * @since 1.40.0 */ class RedlineSurface extends sap.ui.core.Control { /** * Constructor for a new RedlineSurface. * * 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(); /** * Creates a new subclass of class sap.ui.vk.RedlineSurface 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.RedlineSurface. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some redlineElement to the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ addRedlineElement( /** * The redlineElement to add; if empty, nothing is inserted */ oRedlineElement: sap.ui.vk.RedlineElement ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pan pan} event of this `sap.ui.vk.RedlineSurface`. * * 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.RedlineSurface` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPan( /** * 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: RedlineSurface$PanEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineSurface` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pan pan} event of this `sap.ui.vk.RedlineSurface`. * * 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.RedlineSurface` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachPan( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineSurface$PanEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineSurface` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:zoom zoom} event of this `sap.ui.vk.RedlineSurface`. * * 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.RedlineSurface` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachZoom( /** * 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: RedlineSurface$ZoomEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineSurface` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:zoom zoom} event of this `sap.ui.vk.RedlineSurface`. * * 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.RedlineSurface` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachZoom( /** * The function to be called when the event occurs */ fnFunction: (p1: RedlineSurface$ZoomEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.RedlineSurface` itself */ oListener?: object ): this; /** * Destroys all the redlineElements in the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRedlineElements(): this; /** * Detaches event handler `fnFunction` from the {@link #event:pan pan} event of this `sap.ui.vk.RedlineSurface`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPan( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineSurface$PanEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:zoom zoom} event of this `sap.ui.vk.RedlineSurface`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachZoom( /** * The function to be called, when the event occurs */ fnFunction: (p1: RedlineSurface$ZoomEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Exports all the current redline elements as an array of JSON objects. * * * @returns An array of JSON objects. */ exportJSON(): object[]; /** * Exports all the current redline elements as an array of SVG objects. * * * @returns An array of SVG objects. */ exportSVG(): object[]; /** * Fires event {@link #event:pan pan} 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 */ firePan( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineSurface$PanEventParameters ): this; /** * Fires event {@link #event:zoom zoom} 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 */ fireZoom( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.RedlineSurface$ZoomEventParameters ): this; /** * Gets current value of property {@link #getPanningRatio panningRatio}. * * Default value is `1`. * * * @returns Value of property `panningRatio` */ getPanningRatio(): float; /** * Gets content of aggregation {@link #getRedlineElements redlineElements}. */ getRedlineElements(): sap.ui.vk.RedlineElement[]; /** * Gets current value of property {@link #getVirtualLeft virtualLeft}. * * * @returns Value of property `virtualLeft` */ getVirtualLeft(): float; /** * Gets current value of property {@link #getVirtualSideLength virtualSideLength}. * * * @returns Value of property `virtualSideLength` */ getVirtualSideLength(): float; /** * Gets current value of property {@link #getVirtualTop virtualTop}. * * * @returns Value of property `virtualTop` */ getVirtualTop(): float; /** * Iterates through all JSON objects from the array passed as parameter, and creates and restores the redline * elements serialized in the array. * * * @returns `this` to allow method chaining. */ importJSON( /** * An array of serialized redline elements. */ jsonElements: object[] ): this; /** * Iterates through all SVG objects from the array passed as parameter, and creates and restores the redline * elements in the array. * * * @returns `this` to allow method chaining. */ importSVG( /** * An array of redline elements in SVG format. */ svg: object[] ): this; /** * Checks for the provided `sap.ui.vk.RedlineElement` in the aggregation {@link #getRedlineElements redlineElements}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRedlineElement( /** * The redlineElement whose index is looked for */ oRedlineElement: sap.ui.vk.RedlineElement ): int; /** * Inserts a redlineElement into the aggregation {@link #getRedlineElements redlineElements}. * * * @returns Reference to `this` in order to allow method chaining */ insertRedlineElement( /** * The redlineElement to insert; if empty, nothing is inserted */ oRedlineElement: sap.ui.vk.RedlineElement, /** * The `0`-based index the redlineElement should be inserted at; for a negative value of `iIndex`, the redlineElement * is inserted at position 0; for a value greater than the current size of the aggregation, the redlineElement * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getRedlineElements redlineElements}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRedlineElements(): sap.ui.vk.RedlineElement[]; /** * Removes a redlineElement from the aggregation {@link #getRedlineElements redlineElements}. * * * @returns The removed redlineElement or `null` */ removeRedlineElement( /** * The redlineElement to remove or its index or id */ vRedlineElement: int | string | sap.ui.vk.RedlineElement ): sap.ui.vk.RedlineElement | null; /** * Sets a new value for property {@link #getPanningRatio panningRatio}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setPanningRatio( /** * New value for property `panningRatio` */ fPanningRatio?: float ): this; /** * Sets a new value for property {@link #getVirtualLeft virtualLeft}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setVirtualLeft( /** * New value for property `virtualLeft` */ fVirtualLeft: float ): this; /** * Sets a new value for property {@link #getVirtualSideLength virtualSideLength}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setVirtualSideLength( /** * New value for property `virtualSideLength` */ fVirtualSideLength: float ): this; /** * Sets a new value for property {@link #getVirtualTop virtualTop}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setVirtualTop( /** * New value for property `virtualTop` */ fVirtualTop: float ): this; /** * Updates the panning ratio by making calculations based on virtual viewport size and actual viewport size. * * * @returns `this` to allow method chaining. */ updatePanningRatio(): this; } /** * SafeArea allows applications to define area of viewport which will be initially displayed regardless * of viewing device and its screen resolution or orientation. */ class SafeArea extends sap.ui.core.Control { /** * Constructor for a new SafeArea. * * 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(); /** * Creates a new subclass of class sap.ui.vk.SafeArea 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.SafeArea. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the settingsControl in the aggregation {@link #getSettingsControl settingsControl}. * * * @returns Reference to `this` in order to allow method chaining */ destroySettingsControl(): this; /** * Gets content of aggregation {@link #getSettingsControl settingsControl}. * * Application defined setting control which can be used to control SafeArea and aspect ratio settings */ getSettingsControl(): sap.ui.core.Control; /** * Sets the aggregated {@link #getSettingsControl settingsControl}. * * * @returns Reference to `this` in order to allow method chaining */ setSettingsControl( /** * The settingsControl to set */ oSettingsControl: sap.ui.core.Control ): this; } /** * Provides the interface for the 3D model. * * The objects of this class should not be created directly. They should be created via {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector}. */ abstract class Scene extends sap.ui.base.ManagedObject { /** * Constructor for a new Scene. * * The objects of this class should not be created directly. They should be created via {@link sap.ui.vk.ContentConnector sap.ui.vk.ContentConnector}. * * 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(); /** * Creates a new subclass of class sap.ui.vk.Scene 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Scene. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Add a sequence to the scene * * * @returns `this` to allow method chaining. */ addSequence( /** * sequence to add */ sequence: /* was: sap.ui.vk.AnimationSequence */ any ): this; /** * Add an animation track to the scene * * * @returns `this` to allow method chaining. */ addTrack( /** * animation track to add */ track: /* was: sap.ui.vk.AnimationTrack */ any ): this; /** * Creates a highlight. * * * @returns created highlight */ createHighlight( /** * persistent highlight ID */ sId: string, /** * highlight creation parameters */ parameters: any ): /* was: sap.ui.vk.Highlight */ any; /** * Creates an animation sequence. * * * @returns created sequence */ createSequence( /** * persistent sequence ID */ sId: string, /** * sequence creation parameters */ parameters: any ): /* was: sap.ui.vk.AnimationSequence */ any; /** * Creates an animation track. * * * @returns created track */ createTrack( /** * persistent track ID */ sId: string, /** * track creation parameters */ parameters: any ): /* was: sap.ui.vk.AnimationTrack */ any; /** * Finds sequence by ID * * * @returns sequence with given Id or undefined */ findSequence( /** * sequence ID */ sequenceId: string ): /* was: sap.ui.vk.AnimationSequence */ any; /** * Finds track by ID * * * @returns track with given Id or undefined */ findTrack( /** * track ID */ trackId: string ): /* was: sap.ui.vk.AnimationTrack */ any; /** * Gets the default node hierarchy in the Scene object. * * * @returns The default node hierarchy in the Scene object. */ getDefaultNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets current value of property {@link #getDoubleSided doubleSided}. * * Enables or disables double-sided materials * * Default value is `false`. * * * @returns Value of property `doubleSided` */ getDoubleSided(): boolean; /** * get highlight according to ID * * * @returns highlight */ getHighlight( /** * persistent highlight ID */ sId: string ): /* was: sap.ui.vk.Highlight */ any; /** * Gets the unique ID of the Scene object. * * * @returns The unique ID of the Scene object. */ getId(): string; /** * Get initial view * * * @returns initial view */ getInitialView(): sap.ui.vk.View; /** * Gets the scene reference that this Scene object wraps. * * * @returns The scene reference that this Scene object wraps. */ getSceneRef(): any; /** * Gets a list of sequences * * * @returns list of sequences */ getSequences(): /* was: sap.ui.vk.AnimationSequence */ any[]; /** * Gets a list of animation tracks * * * @returns list of animation tracks */ getTracks(): /* was: sap.ui.vk.AnimationTrack */ any[]; /** * Provides an array of all ViewGroups * * * @returns List of ViewGroups */ getViewGroups(): sap.ui.vk.ViewGroup[]; /** * Provides an array of all views * * * @returns List of Views */ getViews(): sap.ui.vk.View[]; /** * Gets index of a sequence in the scene * * * @returns sequence index of found or -1 otherwise */ indexOfSequence( /** * sequence to locate */ sequence: /* was: sap.ui.vk.AnimationSequence */ any ): int; /** * Gets index of an animation track in the scene * * * @returns sequence index of found or -1 otherwise */ indexOfTrack( /** * animation track to locate */ track: /* was: sap.ui.vk.AnimationTrack */ any ): int; /** * Inserts a sequence * * * @returns `this` to allow method chaining. */ insertSequence( /** * sequence to insert */ sequence: /* was: sap.ui.vk.AnimationSequence */ any, /** * index where to insert the sequence */ index: int ): this; /** * Inserts an animation track * * * @returns `this` to allow method chaining. */ insertTrack( /** * animation track to insert */ track: /* was: sap.ui.vk.AnimationTrack */ any, /** * index where to insert the animation track */ index: int ): this; /** * remove highlight according to ID * * * @returns `this` to allow method chaining. */ removeHighlight( /** * persistent highlight ID */ sId: string ): this; /** * Removes a sequence from the scene * * * @returns `this` to allow method chaining. */ removeSequence( /** * sequence to remove */ sequence: /* was: sap.ui.vk.AnimationSequence */ any ): this; /** * Removes all sequences from the scene * * * @returns `this` to allow method chaining. */ removeSequences(): this; /** * Removes an animation track from the scene * * * @returns `this` to allow method chaining. */ removeTrack( /** * animation track to remove */ track: /* was: sap.ui.vk.AnimationTrack */ any ): this; /** * Removes all animation tracks from the scene * * * @returns `this` to allow method chaining. */ removeTracks(): this; /** * Sets a new value for property {@link #getDoubleSided doubleSided}. * * Enables or disables double-sided materials * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDoubleSided( /** * New value for property `doubleSided` */ bDoubleSided?: boolean ): this; /** * Set initial view */ setInitialView( /** * Initial view */ view: sap.ui.vk.View ): void; } /** * Provides a hierarchical view of all the nodes in a given scene in table format. * * @since 1.32.0 */ class SceneTree extends sap.ui.core.Control { /** * Constructor for a new SceneTree. * * 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?: sap.ui.vk.$SceneTreeSettings ); /** * Constructor for a new SceneTree. * * 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?: sap.ui.vk.$SceneTreeSettings ); /** * Creates a new subclass of class sap.ui.vk.SceneTree 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.SceneTree. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.SceneTree`. * * 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.SceneTree` itself. * * This event will be fired when a scene tree 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.SceneTree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.SceneTree`. * * 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.SceneTree` itself. * * This event will be fired when a scene tree 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.SceneTree` itself */ oListener?: object ): this; /** * Destroys the treeTable in the aggregation {@link #getTreeTable treeTable}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTreeTable(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentChanged contentChanged} event of this * `sap.ui.vk.SceneTree`. * * 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: sap.ui.base.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(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getLegacyVisibilityMode legacyVisibilityMode}. * * In legacy visibility mode all changes in node visibility also apply to all descendent nodes * * Default value is `false`. * * * @returns Value of property `legacyVisibilityMode` */ getLegacyVisibilityMode(): boolean; /** * Gets current value of property {@link #getShowSearchField showSearchField}. * * Show or hide search field * * Default value is `true`. * * * @returns Value of property `showSearchField` */ getShowSearchField(): boolean; /** * Gets current value of property {@link #getShowTitle showTitle}. * * If set to `False` then title text will not bbe displayed * * Default value is `true`. * * * @returns Value of property `showTitle` */ getShowTitle(): boolean; /** * Gets current value of property {@link #getTitle title}. * * Text to be displayed in title bar of scene tree * * Default value is `...see text or source`. * * * @returns Value of property `title` */ getTitle(): string; /** * Gets content of aggregation {@link #getTreeTable treeTable}. */ getTreeTable(): sap.ui.table.TreeTable; /** * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager}, * or `null`. */ getViewStateManager(): sap.ui.core.ID | null; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Sets a new value for property {@link #getLegacyVisibilityMode legacyVisibilityMode}. * * In legacy visibility mode all changes in node visibility also apply to all descendent nodes * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setLegacyVisibilityMode( /** * New value for property `legacyVisibilityMode` */ bLegacyVisibilityMode?: boolean ): this; /** * Sets a new value for property {@link #getShowSearchField showSearchField}. * * Show or hide search field * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSearchField( /** * New value for property `showSearchField` */ bShowSearchField?: boolean ): this; /** * Sets a new value for property {@link #getShowTitle showTitle}. * * If set to `False` then title text will not bbe displayed * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowTitle( /** * New value for property `showTitle` */ bShowTitle?: boolean ): this; /** * Sets a new value for property {@link #getTitle title}. * * Text to be displayed in title bar of scene tree * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `...see text or source`. * * * @returns Reference to `this` in order to allow method chaining */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; /** * Sets the aggregated {@link #getTreeTable treeTable}. * * * @returns Reference to `this` in order to allow method chaining */ setTreeTable( /** * The treeTable to set */ oTreeTable: sap.ui.table.TreeTable ): 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: sap.ui.core.ID | sap.ui.vk.ViewStateManagerBase ): this; } /** * Enables capabilities for navigating and activating procedures and steps contained in a single 3D scene. * * @since 1.32.0 * @deprecated As of version 1.72.0. This class is used only with DVL namespace which will be removed in * future. Use {@link sap.ui.vk.ViewGallery} instead. */ class StepNavigation extends sap.ui.core.Control { /** * Constructor for a new StepNavigation. * * 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 Step Navigation control. */ mSettings?: sap.ui.vk.$StepNavigationSettings ); /** * Constructor for a new StepNavigation. * * 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. This ID is generated automatically if no ID is provided. */ sId?: string, /** * Initial settings for the new Step Navigation control. */ mSettings?: sap.ui.vk.$StepNavigationSettings ); /** * Creates a new subclass of class sap.ui.vk.StepNavigation 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.StepNavigation. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.StepNavigation`. * * 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.StepNavigation` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * 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: StepNavigation$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.StepNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.StepNavigation`. * * 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.StepNavigation` itself. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * The function to be called when the event occurs */ fnFunction: (p1: StepNavigation$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.StepNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepChanged stepChanged} event of this `sap.ui.vk.StepNavigation`. * * 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.StepNavigation` itself. * * Raised each time a step starts, changes, or finishes. * * * @returns Reference to `this` in order to allow method chaining */ attachStepChanged( /** * 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: StepNavigation$StepChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.StepNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepChanged stepChanged} event of this `sap.ui.vk.StepNavigation`. * * 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.StepNavigation` itself. * * Raised each time a step starts, changes, or finishes. * * * @returns Reference to `this` in order to allow method chaining */ attachStepChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: StepNavigation$StepChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.StepNavigation` itself */ oListener?: object ): this; /** * Clears the content of the Step Navigation control. * * * @returns Returns `true` if the method was called successfully. */ clear(): boolean; /** * Destroys the layout in the aggregation {@link #getLayout layout}. * * * @returns Reference to `this` in order to allow method chaining */ destroyLayout(): this; /** * Destroys the procedureItemTemplate in the aggregation {@link #getProcedureItemTemplate procedureItemTemplate}. * * * @returns Reference to `this` in order to allow method chaining */ destroyProcedureItemTemplate(): this; /** * Destroys the stepInfoPopup in the aggregation {@link #getStepInfoPopup stepInfoPopup}. * * * @returns Reference to `this` in order to allow method chaining */ destroyStepInfoPopup(): this; /** * Destroys the thumbnailsContainer in the aggregation {@link #getThumbnailsContainer thumbnailsContainer}. * * * @returns Reference to `this` in order to allow method chaining */ destroyThumbnailsContainer(): this; /** * Detaches event handler `fnFunction` from the {@link #event:resize resize} event of this `sap.ui.vk.StepNavigation`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachResize( /** * The function to be called, when the event occurs */ fnFunction: (p1: StepNavigation$ResizeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:stepChanged stepChanged} event of this `sap.ui.vk.StepNavigation`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachStepChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: StepNavigation$StepChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:resize resize} 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 */ fireResize( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.StepNavigation$ResizeEventParameters ): this; /** * Fires event {@link #event:stepChanged stepChanged} 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 */ fireStepChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.StepNavigation$StepChangedEventParameters ): this; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getHeight height}. * * Height of the Step Navigation control. * * Default value is `"100%"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets content of aggregation {@link #getLayout layout}. * * sap.m.Toolbar used to render the entire Step Navigation control's content. */ getLayout(): sap.m.Toolbar; /** * Cycles through steps and procedures for the lastLoadedScene and returns the step that follows after the * currentStepId. * * * @returns The step that follows after the current step. */ getNextStep( /** * Optional integer representing the index of the target procedure in the procedures list. */ procedureIndex?: number ): JSON; /** * Cycles through steps and procedures for the last loaded scene (`lastLoadedScene`), and returns the step * preceding the current step (currentStepId. * * * @returns The step preceding the current step. */ getPreviousStep( /** * Optional integer representing the index of the target procedure in the procedures list. */ procedureIndex?: number ): JSON; /** * Gets content of aggregation {@link #getProcedureItemTemplate procedureItemTemplate}. * * Template control for Procedure items. */ getProcedureItemTemplate(): sap.ui.core.Item; /** * Returns the procedures list with steps for the current scene, and appends base64 data as thumbnailData * and an image type as thumbnailType. * * * @returns For example: `{sceneId : string, hasThumbnails : boolean, "procedures" : [id:string, * name: string, steps: [{id: string, name: string, thumbnailData: string, thumbnailType: string}], "portfolios": * [] }` */ getProceduresAndSteps(): JSON; /** * Gets current value of property {@link #getSettings settings}. * * Managed settings and properties for Step Navigation events. * * * @returns Value of property `settings` */ getSettings(): object; /** * Gets current value of property {@link #getShowStepInfo showStepInfo}. * * Indicates that the Step Navigation control should display a popup containing information around the step * that is playing. If set to `true`, then the popup is rendered. If set to `false`, the popup is hidden. * * Default value is `false`. * * * @returns Value of property `showStepInfo` */ getShowStepInfo(): boolean; /** * Gets current value of property {@link #getShowThumbnails showThumbnails}. * * Indicates that the Step Navigation control should display thumbnails. If set to `true`, then thumbnails * are rendered. If set to `false`, then thumbnails are hidden. * * Default value is `true`. * * * @returns Value of property `showThumbnails` */ getShowThumbnails(): boolean; /** * Gets current value of property {@link #getShowToolbar showToolbar}. * * Indicates that the Step Navigation control should display a toolbar. If set to `true`, then the toolbar * is rendered. If set to `false`, then the toolbar is hidden. * * Default value is `true`. * * * @returns Value of property `showToolbar` */ getShowToolbar(): boolean; /** * Gets a step based on a positive or negative integer, which is used as an index relative to the index * of the current step. An index value of `0` can be used to retrieve the details of the current step. * * * @returns step */ getStep( /** * Positive or negative integer representing the number to add or subtract from the index of the current * step to return the desired step; for example, //next 1, current 0, previous -1 */ relIndex: number, /** * Optional integer representing the index of the target procedure in the procedures list. */ procedureIndex: number, /** * The ID of the step that we want to retrieve. */ specificStepId: string ): JSON; /** * Gets a step based on a positive or negative integer, which is used as an index relative to the index * of the current step. An index value of `0` can be used to retrieve the details of the current step. * * * @returns step */ getStep( /** * Positive or negative integer representing the number to add or subtract from the index of the current * step to return the desired step; for example, //next 1, current 0, previous -1 */ relIndex: number, /** * The ID of the step that we want to retrieve. */ specificStepId: string ): JSON; /** * Gets content of aggregation {@link #getStepInfoPopup stepInfoPopup}. * * sap.ui.core.Popup used to render step information in a popup. */ getStepInfoPopup(): sap.ui.core.Control; /** * Gets content of aggregation {@link #getThumbnailsContainer thumbnailsContainer}. * * sap.m.ScrollContainer used to render a list of thumbnails for the available steps. */ getThumbnailsContainer(): sap.m.ScrollContainer; /** * Gets current value of property {@link #getWidth width}. * * Width of the Step Navigation control. * * Default value is `"100%"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Pauses the step that is currently playing. */ pauseStep(): void; /** * Plays all the steps in the specified procedure. */ playAllSteps( /** * The ID of the procedure for which to play all steps. If `procedureId == null`, then only the first step * is played. */ procedureId?: string ): void; /** * Plays the specified procedure step. */ playStep( /** * The ID of the procedure step to play. */ stepId: string, /** * Default: true If `true`, tells the Viewer to play the step from the first frame. */ fromTheBeginning: boolean, /** * Default: false If `true`, tells the Viewer to play the next step in sequence. */ continueToTheNext: boolean ): void; /** * Rebuilds the content of the Step Navigation control from the current Scene. * * * @returns Returns `true` if the content of the Step Navigation control was rebuilt successfully. */ refresh( /** * The scene object to be used. */ oScene: object ): boolean; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Sets a new value for property {@link #getHeight height}. * * Height of the Step Navigation control. * * 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?: sap.ui.core.CSSSize ): this; /** * Sets the aggregated {@link #getLayout layout}. * * * @returns Reference to `this` in order to allow method chaining */ setLayout( /** * The layout to set */ oLayout: sap.m.Toolbar ): this; /** * Sets the aggregated {@link #getProcedureItemTemplate procedureItemTemplate}. * * * @returns Reference to `this` in order to allow method chaining */ setProcedureItemTemplate( /** * The procedureItemTemplate to set */ oProcedureItemTemplate: sap.ui.core.Item ): this; /** * Attaches a Scene object to the Step Navigation control so that it can access the Scene’s procedures and * steps. */ setScene( /** * The Scene object to attach to the Step Navigation control. */ scene: object ): void; /** * Sets a new value for property {@link #getSettings settings}. * * Managed settings and properties for Step Navigation events. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSettings( /** * New value for property `settings` */ oSettings: object ): this; /** * Sets a new value for property {@link #getShowStepInfo showStepInfo}. * * Indicates that the Step Navigation control should display a popup containing information around the step * that is playing. If set to `true`, then the popup is rendered. If set to `false`, the popup is hidden. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowStepInfo( /** * New value for property `showStepInfo` */ bShowStepInfo?: boolean ): this; /** * Sets a new value for property {@link #getShowThumbnails showThumbnails}. * * Indicates that the Step Navigation control should display thumbnails. If set to `true`, then thumbnails * are rendered. If set to `false`, then thumbnails are hidden. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowThumbnails( /** * New value for property `showThumbnails` */ bShowThumbnails?: boolean ): this; /** * Sets a new value for property {@link #getShowToolbar showToolbar}. * * Indicates that the Step Navigation control should display a toolbar. If set to `true`, then the toolbar * is rendered. If set to `false`, then the toolbar is hidden. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowToolbar( /** * New value for property `showToolbar` */ bShowToolbar?: boolean ): this; /** * Sets the aggregated {@link #getStepInfoPopup stepInfoPopup}. * * * @returns Reference to `this` in order to allow method chaining */ setStepInfoPopup( /** * The stepInfoPopup to set */ oStepInfoPopup: sap.ui.core.Control ): this; /** * Sets the aggregated {@link #getThumbnailsContainer thumbnailsContainer}. * * * @returns Reference to `this` in order to allow method chaining */ setThumbnailsContainer( /** * The thumbnailsContainer to set */ oThumbnailsContainer: sap.m.ScrollContainer ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of the Step Navigation control. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * Provides the interface for the texture. * * @since 1.58.0 */ class Texture extends sap.ui.base.ManagedObject { /** * Constructor for a new texture * * 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(); /** * Creates a new subclass of class sap.ui.vk.Texture 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Texture. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets current value of property {@link #getFilterMode filterMode}. * * filter mode - Bilinear = 0, NearestNeighbor = 1 * * Default value is `0`. * * * @returns Value of property `filterMode` */ getFilterMode(): int; /** * * @returns Texture reference that this texture class wraps */ getTextRef(): any; /** * Gets current value of property {@link #getUvHorizontalOffset uvHorizontalOffset}. * * Horizontal offset of uv coordinates * * Default value is `0.0`. * * * @returns Value of property `uvHorizontalOffset` */ getUvHorizontalOffset(): float; /** * Gets current value of property {@link #getUvHorizontalScale uvHorizontalScale}. * * Horizontal scale of uv coordinates * * Default value is `0.0`. * * * @returns Value of property `uvHorizontalScale` */ getUvHorizontalScale(): float; /** * Gets current value of property {@link #getUvHorizontalTilingEnabled uvHorizontalTilingEnabled}. * * Is the uv horizontal tiling enabled * * Default value is `true`. * * * @returns Value of property `uvHorizontalTilingEnabled` */ getUvHorizontalTilingEnabled(): boolean; /** * Gets current value of property {@link #getUvRotationAngle uvRotationAngle}. * * Rotation angle of uv coordinates * * Default value is `0.0`. * * * @returns Value of property `uvRotationAngle` */ getUvRotationAngle(): float; /** * Gets current value of property {@link #getUvVerticalOffset uvVerticalOffset}. * * VerticalOffset offset of uv coordinates * * Default value is `0.0`. * * * @returns Value of property `uvVerticalOffset` */ getUvVerticalOffset(): float; /** * Gets current value of property {@link #getUvVerticalScale uvVerticalScale}. * * Vertical scale of uv coordinates * * Default value is `0.0`. * * * @returns Value of property `uvVerticalScale` */ getUvVerticalScale(): float; /** * Gets current value of property {@link #getUvVerticalTilingEnabled uvVerticalTilingEnabled}. * * Is the uv vertical tiling enabled * * Default value is `true`. * * * @returns Value of property `uvVerticalTilingEnabled` */ getUvVerticalTilingEnabled(): boolean; /** * Load texture image. * * * @returns This allows method chaining */ load( /** * resource url for image. */ imageUrl: string ): sap.ui.vk.Texture; /** * Sets a new value for property {@link #getFilterMode filterMode}. * * filter mode - Bilinear = 0, NearestNeighbor = 1 * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setFilterMode( /** * New value for property `filterMode` */ iFilterMode?: int ): this; /** * Sets a new value for property {@link #getUvHorizontalOffset uvHorizontalOffset}. * * Horizontal offset of uv coordinates * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setUvHorizontalOffset( /** * New value for property `uvHorizontalOffset` */ fUvHorizontalOffset?: float ): this; /** * Sets a new value for property {@link #getUvHorizontalScale uvHorizontalScale}. * * Horizontal scale of uv coordinates * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setUvHorizontalScale( /** * New value for property `uvHorizontalScale` */ fUvHorizontalScale?: float ): this; /** * Sets a new value for property {@link #getUvHorizontalTilingEnabled uvHorizontalTilingEnabled}. * * Is the uv horizontal tiling enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setUvHorizontalTilingEnabled( /** * New value for property `uvHorizontalTilingEnabled` */ bUvHorizontalTilingEnabled?: boolean ): this; /** * Sets a new value for property {@link #getUvRotationAngle uvRotationAngle}. * * Rotation angle of uv coordinates * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setUvRotationAngle( /** * New value for property `uvRotationAngle` */ fUvRotationAngle?: float ): this; /** * Sets a new value for property {@link #getUvVerticalOffset uvVerticalOffset}. * * VerticalOffset offset of uv coordinates * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setUvVerticalOffset( /** * New value for property `uvVerticalOffset` */ fUvVerticalOffset?: float ): this; /** * Sets a new value for property {@link #getUvVerticalScale uvVerticalScale}. * * Vertical scale of uv coordinates * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0.0`. * * * @returns Reference to `this` in order to allow method chaining */ setUvVerticalScale( /** * New value for property `uvVerticalScale` */ fUvVerticalScale?: float ): this; /** * Sets a new value for property {@link #getUvVerticalTilingEnabled uvVerticalTilingEnabled}. * * Is the uv vertical tiling enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setUvVerticalTilingEnabled( /** * New value for property `uvVerticalTilingEnabled` */ bUvVerticalTilingEnabled?: boolean ): this; } /** * Enables users to trigger actions. */ class ToggleMenuButton extends sap.ui.core.Control implements sap.m.IOverflowToolbarContent { __implements__sap_m_IOverflowToolbarContent: boolean; /** * Constructor for a new `ToggleMenuButton`. * * 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?: sap.ui.vk.$ToggleMenuButtonSettings ); /** * Constructor for a new `ToggleMenuButton`. * * 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?: sap.ui.vk.$ToggleMenuButtonSettings ); /** * Creates a new subclass of class sap.ui.vk.ToggleMenuButton 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ToggleMenuButton. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: /* was: sap.ui.vk.ToggleMenuItem */ any ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeMenuOpen beforeMenuOpen} event of this * `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired before menu opening when the `buttonMode` is set to `Split` and the user presses the arrow button. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeMenuOpen( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeMenuOpen beforeMenuOpen} event of this * `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired before menu opening when the `buttonMode` is set to `Split` and the user presses the arrow button. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeMenuOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelected itemSelected} event of this `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired when a `ToggleMenuItem` is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelected( /** * 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: ToggleMenuButton$ItemSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelected itemSelected} event of this `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired when a `ToggleMenuItem` is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelected( /** * The function to be called when the event occurs */ fnFunction: (p1: ToggleMenuButton$ItemSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemToggled itemToggled} event of this `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired when a `ToggleMenuItem` is toggled. * * * @returns Reference to `this` in order to allow method chaining */ attachItemToggled( /** * 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: ToggleMenuButton$ItemToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemToggled itemToggled} event of this `sap.ui.vk.ToggleMenuButton`. * * 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.ToggleMenuButton` itself. * * Fired when a `ToggleMenuItem` is toggled. * * * @returns Reference to `this` in order to allow method chaining */ attachItemToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: ToggleMenuButton$ItemToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ToggleMenuButton` itself */ oListener?: object ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeMenuOpen beforeMenuOpen} event of this * `sap.ui.vk.ToggleMenuButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeMenuOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemSelected itemSelected} event of this `sap.ui.vk.ToggleMenuButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemSelected( /** * The function to be called, when the event occurs */ fnFunction: (p1: ToggleMenuButton$ItemSelectedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemToggled itemToggled} event of this `sap.ui.vk.ToggleMenuButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: ToggleMenuButton$ItemToggledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforeMenuOpen beforeMenuOpen} 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 */ fireBeforeMenuOpen( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:itemSelected itemSelected} 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 */ fireItemSelected( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ToggleMenuButton$ItemSelectedEventParameters ): this; /** * Fires event {@link #event:itemToggled itemToggled} 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 */ fireItemToggled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ToggleMenuButton$ItemToggledEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * ID of the element which is the current target of the association {@link #getDefaultItem defaultItem}, * or `null`. */ getDefaultItem(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getEnabled enabled}. * * Boolean property to enable the control (default is `true`). **Note:** Depending on custom settings, the * buttons that are disabled have other colors than the enabled ones. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getIconDensityAware iconDensityAware}. * * When set to `truefalse` to avoid the attempt of fetching density perfect image. * * Default value is `true`. * * * @returns Value of property `iconDensityAware` */ getIconDensityAware(): boolean; /** * Gets content of aggregation {@link #getItems items}. * * Defines the menu items contained within this control. */ getItems(): /* was: sap.ui.vk.ToggleMenuItem */ any[]; /** * Gets current value of property {@link #getMenuPosition menuPosition}. * * Specifies the position of the popup menu with enumerated options. By default, the control opens the menu * at its bottom left side. * * **Note:** In the case that the menu has no space to show itself in the view port of the current window * it tries to open itself to the inverted direction. * * Default value is `BeginBottom`. * * * @returns Value of property `menuPosition` */ getMenuPosition(): sap.ui.core.Popup.Dock; /** * Gets current value of property {@link #getPressed pressed}. * * The property is “true” when the control is toggled. The default state of this property is "false". * * Default value is `false`. * * * @returns Value of property `pressed` */ getPressed(): boolean; /** * Gets current value of property {@link #getTextDirection textDirection}. * * This property specifies the element's text directionality with enumerated options. By default, the control * inherits text direction from the DOM. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): sap.ui.core.TextDirection; /** * Gets current value of property {@link #getType type}. * * Defines the type of the button (for example, Default, Accept, Reject, Transparent). Values `Back`, `Up` * and `Unstyled` are ignored. * * Default value is `Default`. * * * @returns Value of property `type` */ getType(): sap.m.ButtonType; /** * Gets current value of property {@link #getWidth width}. * * Defines the width of the button. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.ui.vk.ToggleMenuItem` in the aggregation {@link #getItems items}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: /* was: sap.ui.vk.ToggleMenuItem */ any ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: /* was: sap.ui.vk.ToggleMenuItem */ any, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): sap.ui.core.ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): /* was: sap.ui.vk.ToggleMenuItem */ any[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | /* was: sap.ui.vk.ToggleMenuItem */ any ): /* was: sap.ui.vk.ToggleMenuItem */ any | null; /** * Sets the arrow state to down or not down. */ setArrowState( /** * Is the arrow down */ bIsDown: boolean ): void; /** * Sets the associated {@link #getDefaultItem defaultItem}. * * * @returns Reference to `this` in order to allow method chaining */ setDefaultItem( /** * ID of an element which becomes the new target of this defaultItem association; alternatively, an element * instance may be given */ oDefaultItem: sap.ui.core.ID | /* was: sap.ui.vk.ToggleMenuItem */ any ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Boolean property to enable the control (default is `true`). **Note:** Depending on custom settings, the * buttons that are disabled have other colors than the enabled ones. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getIconDensityAware iconDensityAware}. * * When set to `truefalse` to avoid the attempt of fetching density perfect image. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIconDensityAware( /** * New value for property `iconDensityAware` */ bIconDensityAware?: boolean ): this; /** * Sets a new value for property {@link #getMenuPosition menuPosition}. * * Specifies the position of the popup menu with enumerated options. By default, the control opens the menu * at its bottom left side. * * **Note:** In the case that the menu has no space to show itself in the view port of the current window * it tries to open itself to the inverted direction. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `BeginBottom`. * * * @returns Reference to `this` in order to allow method chaining */ setMenuPosition( /** * New value for property `menuPosition` */ sMenuPosition?: sap.ui.core.Popup.Dock ): this; /** * Sets a new value for property {@link #getPressed pressed}. * * The property is “true” when the control is toggled. The default state of this property is "false". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setPressed( /** * New value for property `pressed` */ bPressed?: boolean ): this; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * This property specifies the element's text directionality with enumerated options. By default, the control * inherits text direction from the DOM. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: sap.ui.core.TextDirection ): this; /** * Sets a new value for property {@link #getType type}. * * Defines the type of the button (for example, Default, Accept, Reject, Transparent). Values `Back`, `Up` * and `Unstyled` are ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType?: sap.m.ButtonType ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines the width of the button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * Provides buttons to hide or show certain sap.ui.vk controls. * * @since 1.32.0 */ class Toolbar extends sap.ui.core.Control { /** * Constructor for a new Toolbar. * * 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?: sap.ui.vk.$ToolbarSettings ); /** * Constructor for a new Toolbar. * * 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?: sap.ui.vk.$ToolbarSettings ); /** * Creates a new subclass of class sap.ui.vk.Toolbar 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Toolbar. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets content of aggregation {@link #getContent content}. * * Toolbar content, this can be used to add/remove buttons and other SAP UI5 controls to the toolbar */ getContent(): sap.ui.core.Control[]; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; } /** * Provides the interface for the view. */ class View extends sap.ui.base.ManagedObject implements sap.ui.vk.IPlaybackCollection { __implements__sap_ui_vk_IPlaybackCollection: boolean; /** * Constructor for a new View. * * The objects of this class contain necessary information to reproduce current view including camera type, * position and orientation as well as objects visibility property and their positions (if different from * default) * * 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(); /** * Creates a new subclass of class sap.ui.vk.View 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.View. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets current value of property {@link #getAspectRatio aspectRatio}. * * Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be * ignored. * * * @returns Value of property `aspectRatio` */ getAspectRatio(): float; /** * Gets current value of property {@link #getAutoPlayAnimation autoPlayAnimation}. * * Flag for auto-playing animation on view activation (optional) * * Default value is `true`. * * * @returns Value of property `autoPlayAnimation` */ getAutoPlayAnimation(): boolean; /** * Gets current value of property {@link #getBottomColor bottomColor}. * * Background bottom color (optional) * * Default value is `"rgba(255, 255, 255, 1)"`. * * * @returns Value of property `bottomColor` */ getBottomColor(): sap.ui.core.CSSColor; /** * Returns view camera * * @since 1.73.0 * * @returns View camera */ getCamera(): sap.ui.vk.Camera; /** * Gets current value of property {@link #getDescription description}. * * View description (optional) * * * @returns Value of property `description` */ getDescription(): string; /** * Gets current value of property {@link #getDimension dimension}. * * Dimension (optional) * * * @returns Value of property `dimension` */ getDimension(): int; /** * Gets current value of property {@link #getName name}. * * View name (optional) * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getNavigationMode navigationMode}. * * Navigation mode (optional) * * Default value is `NoChange`. * * * @returns Value of property `navigationMode` */ getNavigationMode(): sap.ui.vk.NavigationMode; /** * Get parameters of nodes defined in view * * @since 1.73.0 * * @returns Array of objects containing node information, each object contains the following fields * ```javascript * * { * target: object - node reference * transform: float[] - transformation matrix, array of 16 or 12 * meshId: string - optional, node mesh Id * materialId: string - optional, node material Id * visible: boolean - node visibility * opacity: float - node opacity * } * ``` */ getNodeInfos(): object[]; /** * Gets current value of property {@link #getTopColor topColor}. * * Background top color (optional) * * Default value is `"rgba(238, 238, 238, 1)"`. * * * @returns Value of property `topColor` */ getTopColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getViewId viewId}. * * View persistent ID (optional) * * * @returns Value of property `viewId` */ getViewId(): string; /** * Sets a new value for property {@link #getAspectRatio aspectRatio}. * * Aspect ratio for Safe Area (optional). This can be 0 to 25. Values above or below this range will be * ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setAspectRatio( /** * New value for property `aspectRatio` */ fAspectRatio: float ): this; /** * Sets a new value for property {@link #getAutoPlayAnimation autoPlayAnimation}. * * Flag for auto-playing animation on view activation (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoPlayAnimation( /** * New value for property `autoPlayAnimation` */ bAutoPlayAnimation?: boolean ): this; /** * Sets a new value for property {@link #getBottomColor bottomColor}. * * Background bottom color (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(255, 255, 255, 1)"`. * * * @returns Reference to `this` in order to allow method chaining */ setBottomColor( /** * New value for property `bottomColor` */ sBottomColor?: sap.ui.core.CSSColor ): this; /** * Set view camera. * * @since 1.73.0 * * @returns return this */ setCamera( /** * View camera */ camera: sap.ui.vk.Camera ): sap.ui.vk.View; /** * Sets a new value for property {@link #getDescription description}. * * View description (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDescription( /** * New value for property `description` */ sDescription: string ): this; /** * Sets a new value for property {@link #getDimension dimension}. * * Dimension (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDimension( /** * New value for property `dimension` */ iDimension: int ): this; /** * Sets a new value for property {@link #getName name}. * * View name (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; /** * Sets a new value for property {@link #getNavigationMode navigationMode}. * * Navigation mode (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `NoChange`. * * * @returns Reference to `this` in order to allow method chaining */ setNavigationMode( /** * New value for property `navigationMode` */ sNavigationMode?: sap.ui.vk.NavigationMode ): this; /** * Set parameters of nodes defined in view * * @since 1.73.0 * * @returns Reference to this in order to allow method chaining */ setNodeInfos( /** * Array of objects containing node information, each object contains the following fields */ infos: Array<{ /** * Node reference */ target: object; /** * Node transformation matrix, array of 16 or 12 */ transform: float[]; /** * Optional, node mesh Id */ meshId: string; /** * Optional, node material Id */ materialId: string; /** * Node visibility */ visible: boolean; /** * Node opacity */ opacity: float; /** * Optional, annotation id */ annotationId: float; }> ): this; /** * Sets a new value for property {@link #getTopColor topColor}. * * Background top color (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(238, 238, 238, 1)"`. * * * @returns Reference to `this` in order to allow method chaining */ setTopColor( /** * New value for property `topColor` */ sTopColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getViewId viewId}. * * View persistent ID (optional) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setViewId( /** * New value for property `viewId` */ sViewId: string ): this; /** * Update parameters of nodes if nodes are already defined, add parameters if the node is not defined in * view * * @since 1.73.0 * * @returns Reference to this in order to allow method chaining */ updateNodeInfos( /** * Infos array of objects containing node information, each object contains the following fields */ update: Array<{ /** * Node reference */ target: object; /** * Node transformation matrix, array of 16 or 12 */ transform: float[]; /** * Optional, node mesh Id */ meshId: string; /** * Optional, node material Id */ materialId: string; /** * Node visibility */ visible: boolean; /** * Node opacity */ opacity: float; }> ): this; } /** * 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 */ class Viewer extends sap.ui.core.Control { /** * Constructor for a new Viewer. * * 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 Viewer control */ mSettings?: sap.ui.vk.$ViewerSettings ); /** * Constructor for a new Viewer. * * 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 Viewer control, generated automatically if no ID is given */ sId?: string, /** * initial settings for the new Viewer control */ mSettings?: sap.ui.vk.$ViewerSettings ); /** * Creates a new subclass of class sap.ui.vk.Viewer 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Viewer. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * It activates or deactivates full screen mode. * * * @returns `this` to allow method chaining. */ activateFullScreenMode(): this; /** * Activates the redline design control. * * @deprecated As of version 1.77.0. Use {@link sap.ui.vk.tools.RedlineTool} instead * * @returns `this` to allow method chaining. */ activateRedlineDesign( /** * The redline element/elements which will be rendered as soon as the redline design control is activated. */ redlineElements: sap.ui.vk.RedlineElement | sap.ui.vk.RedlineElement[] ): this; /** * Adds some contentResource to the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ addContentResource( /** * The contentResource to add; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentResourceChangesProcessed contentResourceChangesProcessed } * event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentResourceChangesProcessed( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contentResourceChangesProcessed contentResourceChangesProcessed } * event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when any content resource or the contentResources aggregation has been changed * and processed. * * * @returns Reference to `this` in order to allow method chaining */ attachContentResourceChangesProcessed( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreen fullScreen} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event is fired when viewer enters/exits full screen mode. * * * @returns Reference to `this` in order to allow method chaining */ attachFullScreen( /** * 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: Viewer$FullScreenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreen fullScreen} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event is fired when viewer enters/exits full screen mode. * * * @returns Reference to `this` in order to allow method chaining */ attachFullScreen( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$FullScreenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a node is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * 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: Viewer$NodeClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a node is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$NodeClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneDestroying sceneDestroying} event of this * `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when scene / image loaded in Viewer is about to be destroyed. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneDestroying( /** * 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: Viewer$SceneDestroyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneDestroying sceneDestroying} event of this * `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when scene / image loaded in Viewer is about to be destroyed. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneDestroying( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$SceneDestroyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneLoadingFailed sceneLoadingFailed} event * of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a critical error occurs during scene / image loading. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneLoadingFailed( /** * 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: Viewer$SceneLoadingFailedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneLoadingFailed sceneLoadingFailed} event * of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a critical error occurs during scene / image loading. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneLoadingFailed( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$SceneLoadingFailedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneLoadingSucceeded sceneLoadingSucceeded } * event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a scene / image has been loaded into the Viewer. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneLoadingSucceeded( /** * 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: Viewer$SceneLoadingSucceededEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sceneLoadingSucceeded sceneLoadingSucceeded } * event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a scene / image has been loaded into the Viewer. * * * @returns Reference to `this` in order to allow method chaining */ attachSceneLoadingSucceeded( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$SceneLoadingSucceededEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event is fired when the nodes are selected/unselected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * 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: Viewer$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event is fired when the nodes are selected/unselected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a URL in a note is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachUrlClicked( /** * 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: Viewer$UrlClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.Viewer`. * * 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.Viewer` itself. * * This event will be fired when a URL in a note is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachUrlClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: Viewer$UrlClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.Viewer` itself */ oListener?: object ): this; /** * Destroys all the contentResources in the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContentResources(): this; /** * Destroys the drawerToolbar in the aggregation {@link #getDrawerToolbar drawerToolbar}. * * * @returns Reference to `this` in order to allow method chaining */ destroyDrawerToolbar(): this; /** * It destroys the current instance of {sap.ui.vk.RedlineDesign}. * * @deprecated As of version 1.77.0. Use {@link sap.ui.vk.tools.RedlineTool} instead * * @returns `this` to allow method chaining. */ destroyRedlineDesign(): this; /** * Destroys the viewGallery in the aggregation {@link #getViewGallery viewGallery}. * * * @returns Reference to `this` in order to allow method chaining */ destroyViewGallery(): this; /** * Detaches event handler `fnFunction` from the {@link #event:contentResourceChangesProcessed contentResourceChangesProcessed } * event of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachContentResourceChangesProcessed( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fullScreen fullScreen} event of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFullScreen( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$FullScreenEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$NodeClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sceneDestroying sceneDestroying} event of * this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSceneDestroying( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$SceneDestroyingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sceneLoadingFailed sceneLoadingFailed} event * of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSceneLoadingFailed( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$SceneLoadingFailedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sceneLoadingSucceeded sceneLoadingSucceeded } * event of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSceneLoadingSucceeded( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$SceneLoadingSucceededEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$SelectionChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.Viewer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachUrlClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: Viewer$UrlClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:contentResourceChangesProcessed contentResourceChangesProcessed} 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 */ fireContentResourceChangesProcessed( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:fullScreen fullScreen} 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 */ fireFullScreen( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$FullScreenEventParameters ): this; /** * Fires event {@link #event:nodeClicked nodeClicked} 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 */ fireNodeClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$NodeClickedEventParameters ): this; /** * Fires event {@link #event:sceneDestroying sceneDestroying} 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 */ fireSceneDestroying( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$SceneDestroyingEventParameters ): this; /** * Fires event {@link #event:sceneLoadingFailed sceneLoadingFailed} 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 */ fireSceneLoadingFailed( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$SceneLoadingFailedEventParameters ): this; /** * Fires event {@link #event:sceneLoadingSucceeded sceneLoadingSucceeded} 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 */ fireSceneLoadingSucceeded( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$SceneLoadingSucceededEventParameters ): this; /** * Fires event {@link #event:selectionChanged selectionChanged} 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 */ fireSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$SelectionChangedEventParameters ): this; /** * Fires event {@link #event:urlClicked urlClicked} 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 */ fireUrlClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.Viewer$UrlClickedEventParameters ): this; /** * Gets content of aggregation {@link #getContentResources contentResources}. * * Content resources to load and display in the Viewer control. */ getContentResources(): sap.ui.vk.ContentResource[]; /** * Gets the drawer toolbar control. * * * @returns The drawer toolbar control. */ getDrawerToolbar(): sap.ui.vk.DrawerToolbar; /** * Gets current value of property {@link #getEnableElementsPanel enableElementsPanel}. * * Disables the ECAD elements panel control * * Default value is `true`. * * * @returns Value of property `enableElementsPanel` */ getEnableElementsPanel(): boolean; /** * Gets current value of property {@link #getEnableLayersPanel enableLayersPanel}. * * Disables the ECAD layers panel control * * Default value is `true`. * * * @returns Value of property `enableLayersPanel` */ getEnableLayersPanel(): boolean; /** * Gets current value of property {@link #getEnableMiniMap enableMiniMap}. * * Disables the mini map control * * Default value is `true`. * * * @returns Value of property `enableMiniMap` */ getEnableMiniMap(): boolean; /** * Gets current value of property {@link #getEnableNotifications enableNotifications}. * * Disables the Message Popover Control * * Default value is `true`. * * * @returns Value of property `enableNotifications` */ getEnableNotifications(): boolean; /** * Gets current value of property {@link #getEnablePageGallery enablePageGallery}. * * Disables the page gallery control * * Default value is `true`. * * * @returns Value of property `enablePageGallery` */ getEnablePageGallery(): boolean; /** * Gets current value of property {@link #getEnableProgressIndicator enableProgressIndicator}. * * Enable / disable progress indicator for downloading and rendering VDS files * * Default value is `true`. * * * @returns Value of property `enableProgressIndicator` */ getEnableProgressIndicator(): boolean; /** * Gets current value of property {@link #getEnableSceneTree enableSceneTree}. * * Disables the scene tree control Button on the menu * * Default value is `true`. * * * @returns Value of property `enableSceneTree` */ getEnableSceneTree(): boolean; /** * Gets current value of property {@link #getEnableStepNavigation enableStepNavigation}. * * Disables the Step Navigation Control Button on the menu * * Default value is `true`. * * * @returns Value of property `enableStepNavigation` */ getEnableStepNavigation(): boolean; /** * Gets current value of property {@link #getEnableToolbar enableToolbar}. * * Shows or hides Toolbar control * * Default value is `true`. * * * @returns Value of property `enableToolbar` */ getEnableToolbar(): boolean; /** * Gets the GraphicsCore object if the currently loaded content is a 3D model. * * @deprecated As of version 1.50.0. DVL namespace wil be removed in future and `GraphicsCore` does not * have direct replacement. Use {@link sap.ui.vk.ContentConnector} for scene loading events. * * @returns The GraphicsCore object. If there is no 3D scene loaded then `null` is returned. */ getGraphicsCore(): sap.ui.vk.dvl.GraphicsCore; /** * Gets current value of property {@link #getHeight height}. * * Height of the Viewer control * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getHotspotColor hotspotColor}. * * Color used for highlighting Smart2D hotspots in the CSS Color format. * * Default value is `"rgba(89, 0, 0, 0.73)"`. * * * @returns Value of property `hotspotColor` */ getHotspotColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getHotspotColorABGR hotspotColorABGR}. * * Color used for highlighting Smart2D hotspots in the ABGR format. * * Default value is `0x590000BB`. * * * @returns Value of property `hotspotColorABGR` */ getHotspotColorABGR(): int; /** * Gets current value of property {@link #getHotspotsEnabled hotspotsEnabled}. * * Shows or hides showing of all hotspots toggle button * * Default value is `true`. * * * @returns Value of property `hotspotsEnabled` */ getHotspotsEnabled(): boolean; /** * Gets the 2D viewport used for displaying format natively supported by the browser - 2D images etc. * * @deprecated As of version 1.96.0. Use {@link sap.ui.vk.Viewport#getViewport} instead. * * @returns The 2D viewport. */ getNativeViewport(): sap.ui.vk.NativeViewport; /** * Gets current value of property {@link #getOverlayStepNavigation overlayStepNavigation}. * * If enabled the Step Navigation will be overlayed on top of the viewport. Only set this during initialization. * Will not work when set at runtime. * * Default value is `false`. * * * @returns Value of property `overlayStepNavigation` */ getOverlayStepNavigation(): boolean; /** * Gets current value of property {@link #getRecursiveSelection recursiveSelection}. * * Whether or not we want ViewStateManager to have recursive selection. * * Default value is `false`. * * * @returns Value of property `recursiveSelection` */ getRecursiveSelection(): boolean; /** * Gets the RedlineDesign instance used for creating redlining shapes. * * @deprecated As of version 1.77.0. Use {@link sap.ui.vk.tools.RedlineTool} instead * * @returns The RedlineDesign instance. */ getRedlineDesign(): sap.ui.vk.RedlineDesign; /** * Gets current value of property {@link #getRuntimeSettings runtimeSettings}. * * Optional Emscripten runtime module settings. A JSON object with the following properties: * - totalMemory {int} size of Emscripten module memory in bytes, default value: 512 MB. * - logElementId {string} ID of a textarea DOM element to write the log to. * - statusElementId {string} ID of a DOM element to write the status messages to. Emscripten runtime * module settings cannot be changed after the control is fully initialized. * * Default value is `{}`. * * * @returns Value of property `runtimeSettings` */ getRuntimeSettings(): object; /** * Gets the Scene currently loaded in the Viewer control. * * * @returns The scene loaded in the control. */ getScene(): sap.ui.vk.Scene; /** * Gets the scene tree control to customize it. * * * @returns The scene tree control. */ getSceneTree(): sap.ui.vk.SceneTree; /** * Gets current value of property {@link #getShouldTrackVisibilityChanges shouldTrackVisibilityChanges}. * * Whether or not we want ViewStateManager to keep track of visibility changes. * * Default value is `false`. * * * @returns Value of property `shouldTrackVisibilityChanges` */ getShouldTrackVisibilityChanges(): boolean; /** * Gets current value of property {@link #getShowAllHotspots showAllHotspots}. * * Enables or disables showing of all hotspots * * Default value is `false`. * * * @returns Value of property `showAllHotspots` */ getShowAllHotspots(): boolean; /** * Gets current value of property {@link #getShowDrawerToolbar showDrawerToolbar}. * * Shows or hides the drawer toolbar * * Default value is `true`. * * * @returns Value of property `showDrawerToolbar` */ getShowDrawerToolbar(): boolean; /** * Gets current value of property {@link #getShowElementsPanel showElementsPanel}. * * Shows or hides the ECAD elements panel control * * Default value is `true`. * * * @returns Value of property `showElementsPanel` */ getShowElementsPanel(): boolean; /** * Gets current value of property {@link #getShowLayersPanel showLayersPanel}. * * Shows or hides the ECAD layers panel control * * Default value is `true`. * * * @returns Value of property `showLayersPanel` */ getShowLayersPanel(): boolean; /** * Gets current value of property {@link #getShowMiniMap showMiniMap}. * * Shows or hides the mini map control * * Default value is `false`. * * * @returns Value of property `showMiniMap` */ getShowMiniMap(): boolean; /** * Gets current value of property {@link #getShowPageGallery showPageGallery}. * * Shows or hides the page gallery control * * Default value is `true`. * * * @returns Value of property `showPageGallery` */ getShowPageGallery(): boolean; /** * Gets current value of property {@link #getShowSceneTree showSceneTree}. * * Shows or hides the scene tree control * * Default value is `true`. * * * @returns Value of property `showSceneTree` */ getShowSceneTree(): boolean; /** * Gets current value of property {@link #getShowStepNavigation showStepNavigation}. * * Shows or hides the Step Navigation Control * * Default value is `false`. * * * @returns Value of property `showStepNavigation` */ getShowStepNavigation(): boolean; /** * Gets current value of property {@link #getShowStepNavigationThumbnails showStepNavigationThumbnails}. * * Shows or hides the Step Navigation thumbnails * * Default value is `true`. * * * @returns Value of property `showStepNavigationThumbnails` */ getShowStepNavigationThumbnails(): boolean; /** * Gets the toolbar control to customize it - add or remove buttons * * * @returns The toolbar control. */ getToolbar(): sap.ui.vk.Toolbar; /** * Gets current value of property {@link #getToolbarTitle toolbarTitle}. * * The toolbar title * * Default value is `empty string`. * * * @returns Value of property `toolbarTitle` */ getToolbarTitle(): string; /** * Gets the view gallery control. * * * @returns The view gallery control. */ getViewGallery(): sap.ui.vk.ViewGallery; /** * Gets the 3D viewport. * * * @returns The 3D viewport. */ getViewport(): sap.ui.vk.Viewport; /** * Gets the view state manager object used for handling visibility and selection of nodes. * * * @returns The view state manager object. */ getViewStateManager(): sap.ui.vk.ViewStateManager; /** * Gets current value of property {@link #getWebGLContextAttributes webGLContextAttributes}. * * Optional WebGL context attributes. A JSON object with the following boolean properties: * - antialias {boolean} default value `true`. If set to `true`, the context will attempt to perform antialiased * rendering if possible. * - alpha {boolean} default value `true`. If set to `true`, the context will have an alpha (transparency) * channel. * - premultipliedAlpha {boolean} default value `false`. If set to `true`, the color channels in the framebuffer * will be stored premultiplied by the alpha channel to improve performance. Other {@link https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2 WebGL context attributes } * are also supported. WebGL context attributes cannot be changed after the control is fully initialized. * * Default value is `...see text or source`. * * * @returns Value of property `webGLContextAttributes` */ getWebGLContextAttributes(): object; /** * Gets current value of property {@link #getWidth width}. * * Width of the Viewer control * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.ui.vk.ContentResource` in the aggregation {@link #getContentResources contentResources}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContentResource( /** * The contentResource whose index is looked for */ oContentResource: sap.ui.vk.ContentResource ): int; /** * Inserts a contentResource into the aggregation {@link #getContentResources contentResources}. * * * @returns Reference to `this` in order to allow method chaining */ insertContentResource( /** * The contentResource to insert; if empty, nothing is inserted */ oContentResource: sap.ui.vk.ContentResource, /** * The `0`-based index the contentResource should be inserted at; for a negative value of `iIndex`, the * contentResource is inserted at position 0; for a value greater than the current size of the aggregation, * the contentResource is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContentResources contentResources}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContentResources(): sap.ui.vk.ContentResource[]; /** * Removes a contentResource from the aggregation {@link #getContentResources contentResources}. * * * @returns The removed contentResource or `null` */ removeContentResource( /** * The contentResource to remove or its index or id */ vContentResource: int | string | sap.ui.vk.ContentResource ): sap.ui.vk.ContentResource | null; /** * Sets an callback function used to authorize user and provide authorization token. * * * @returns `this` to allow method chaining. */ setAuthorizationHandler( /** * An callback function. */ handler: sap.ui.vk.AuthorizationHandler ): this; /** * Set the consumption scenario (used in SAP/partner applications). * * * @returns `this` to allow method chaining. */ setConsumptionScenario( /** * The consumption scenario. */ consumptionScenario: string ): this; /** * Sets an object that decrypts content of encrypted models. * * * @returns `this` to allow method chaining. */ setDecryptionHandler( /** * An object that decrypts content of encrypted models. */ handler: sap.ui.vk.DecryptionHandler ): this; /** * Sets the aggregated {@link #getDrawerToolbar drawerToolbar}. * * * @returns Reference to `this` in order to allow method chaining */ setDrawerToolbar( /** * The drawerToolbar to set */ oDrawerToolbar: sap.ui.vk.DrawerToolbar ): this; /** * Sets a new value for property {@link #getEnableElementsPanel enableElementsPanel}. * * Disables the ECAD elements panel control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableElementsPanel( /** * New value for property `enableElementsPanel` */ bEnableElementsPanel?: boolean ): this; /** * Sets a new value for property {@link #getEnableLayersPanel enableLayersPanel}. * * Disables the ECAD layers panel control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableLayersPanel( /** * New value for property `enableLayersPanel` */ bEnableLayersPanel?: boolean ): this; /** * Sets a new value for property {@link #getEnableMiniMap enableMiniMap}. * * Disables the mini map control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableMiniMap( /** * New value for property `enableMiniMap` */ bEnableMiniMap?: boolean ): this; /** * Sets a new value for property {@link #getEnableNotifications enableNotifications}. * * Disables the Message Popover Control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableNotifications( /** * New value for property `enableNotifications` */ bEnableNotifications?: boolean ): this; /** * Sets a new value for property {@link #getEnablePageGallery enablePageGallery}. * * Disables the page gallery control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnablePageGallery( /** * New value for property `enablePageGallery` */ bEnablePageGallery?: boolean ): this; /** * Sets a new value for property {@link #getEnableProgressIndicator enableProgressIndicator}. * * Enable / disable progress indicator for downloading and rendering VDS files * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableProgressIndicator( /** * New value for property `enableProgressIndicator` */ bEnableProgressIndicator?: boolean ): this; /** * Sets a new value for property {@link #getEnableSceneTree enableSceneTree}. * * Disables the scene tree control Button on the menu * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableSceneTree( /** * New value for property `enableSceneTree` */ bEnableSceneTree?: boolean ): this; /** * Sets a new value for property {@link #getEnableStepNavigation enableStepNavigation}. * * Disables the Step Navigation Control Button on the menu * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableStepNavigation( /** * New value for property `enableStepNavigation` */ bEnableStepNavigation?: boolean ): this; /** * Sets a new value for property {@link #getEnableToolbar enableToolbar}. * * Shows or hides Toolbar control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableToolbar( /** * New value for property `enableToolbar` */ bEnableToolbar?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Height of the Viewer control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getHotspotColor hotspotColor}. * * Color used for highlighting Smart2D hotspots in the CSS Color format. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(89, 0, 0, 0.73)"`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotColor( /** * New value for property `hotspotColor` */ sHotspotColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getHotspotColorABGR hotspotColorABGR}. * * Color used for highlighting Smart2D hotspots in the ABGR format. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0x590000BB`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotColorABGR( /** * New value for property `hotspotColorABGR` */ iHotspotColorABGR?: int ): this; /** * Sets a new value for property {@link #getHotspotsEnabled hotspotsEnabled}. * * Shows or hides showing of all hotspots toggle button * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotsEnabled( /** * New value for property `hotspotsEnabled` */ bHotspotsEnabled?: boolean ): this; /** * Sets a new value for property {@link #getOverlayStepNavigation overlayStepNavigation}. * * If enabled the Step Navigation will be overlayed on top of the viewport. Only set this during initialization. * Will not work when set at runtime. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setOverlayStepNavigation( /** * New value for property `overlayStepNavigation` */ bOverlayStepNavigation?: boolean ): this; /** * Sets a new value for property {@link #getRecursiveSelection recursiveSelection}. * * Whether or not we want ViewStateManager to have recursive selection. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setRecursiveSelection( /** * New value for property `recursiveSelection` */ bRecursiveSelection?: boolean ): this; /** * Sets a new value for property {@link #getRuntimeSettings runtimeSettings}. * * Optional Emscripten runtime module settings. A JSON object with the following properties: * - totalMemory {int} size of Emscripten module memory in bytes, default value: 512 MB. * - logElementId {string} ID of a textarea DOM element to write the log to. * - statusElementId {string} ID of a DOM element to write the status messages to. Emscripten runtime * module settings cannot be changed after the control is fully initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `{}`. * * * @returns Reference to `this` in order to allow method chaining */ setRuntimeSettings( /** * New value for property `runtimeSettings` */ oRuntimeSettings?: object ): this; /** * Sets a new value for property {@link #getShouldTrackVisibilityChanges shouldTrackVisibilityChanges}. * * Whether or not we want ViewStateManager to keep track of visibility changes. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShouldTrackVisibilityChanges( /** * New value for property `shouldTrackVisibilityChanges` */ bShouldTrackVisibilityChanges?: boolean ): this; /** * Sets a new value for property {@link #getShowAllHotspots showAllHotspots}. * * Enables or disables showing of all hotspots * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowAllHotspots( /** * New value for property `showAllHotspots` */ bShowAllHotspots?: boolean ): this; /** * Sets a new value for property {@link #getShowDrawerToolbar showDrawerToolbar}. * * Shows or hides the drawer toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowDrawerToolbar( /** * New value for property `showDrawerToolbar` */ bShowDrawerToolbar?: boolean ): this; /** * Sets a new value for property {@link #getShowElementsPanel showElementsPanel}. * * Shows or hides the ECAD elements panel control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowElementsPanel( /** * New value for property `showElementsPanel` */ bShowElementsPanel?: boolean ): this; /** * Sets a new value for property {@link #getShowLayersPanel showLayersPanel}. * * Shows or hides the ECAD layers panel control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowLayersPanel( /** * New value for property `showLayersPanel` */ bShowLayersPanel?: boolean ): this; /** * Sets a new value for property {@link #getShowMiniMap showMiniMap}. * * Shows or hides the mini map control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowMiniMap( /** * New value for property `showMiniMap` */ bShowMiniMap?: boolean ): this; /** * Sets a new value for property {@link #getShowPageGallery showPageGallery}. * * Shows or hides the page gallery control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowPageGallery( /** * New value for property `showPageGallery` */ bShowPageGallery?: boolean ): this; /** * Sets a new value for property {@link #getShowSceneTree showSceneTree}. * * Shows or hides the scene tree control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSceneTree( /** * New value for property `showSceneTree` */ bShowSceneTree?: boolean ): this; /** * Sets a new value for property {@link #getShowStepNavigation showStepNavigation}. * * Shows or hides the Step Navigation Control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowStepNavigation( /** * New value for property `showStepNavigation` */ bShowStepNavigation?: boolean ): this; /** * Sets a new value for property {@link #getShowStepNavigationThumbnails showStepNavigationThumbnails}. * * Shows or hides the Step Navigation thumbnails * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowStepNavigationThumbnails( /** * New value for property `showStepNavigationThumbnails` */ bShowStepNavigationThumbnails?: boolean ): this; /** * Sets a new value for property {@link #getToolbarTitle toolbarTitle}. * * The toolbar title * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setToolbarTitle( /** * New value for property `toolbarTitle` */ sToolbarTitle?: string ): this; /** * Sets the aggregated {@link #getViewGallery viewGallery}. * * * @returns Reference to `this` in order to allow method chaining */ setViewGallery( /** * The viewGallery to set */ oViewGallery: sap.ui.vk.ViewGallery ): this; /** * Sets a new value for property {@link #getWebGLContextAttributes webGLContextAttributes}. * * Optional WebGL context attributes. A JSON object with the following boolean properties: * - antialias {boolean} default value `true`. If set to `true`, the context will attempt to perform antialiased * rendering if possible. * - alpha {boolean} default value `true`. If set to `true`, the context will have an alpha (transparency) * channel. * - premultipliedAlpha {boolean} default value `false`. If set to `true`, the color channels in the framebuffer * will be stored premultiplied by the alpha channel to improve performance. Other {@link https://www.khronos.org/registry/webgl/specs/latest/1.0/#5.2 WebGL context attributes } * are also supported. WebGL context attributes cannot be changed after the control is fully initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `...see text or source`. * * * @returns Reference to `this` in order to allow method chaining */ setWebGLContextAttributes( /** * New value for property `webGLContextAttributes` */ oWebGLContextAttributes?: object ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of the Viewer control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * Enables capabilities for navigating and activating procedures and steps contained in a single 3D scene. * * @since 1.62.0 */ class ViewGallery extends sap.ui.core.Control { /** * Constructor for a new ViewGallery. * * 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 View Gallery control. */ mSettings?: sap.ui.vk.$ViewGallerySettings ); /** * Constructor for a new ViewGallery. * * 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. This ID is generated automatically if no ID is provided. */ sId?: string, /** * Initial settings for the new View Gallery control. */ mSettings?: sap.ui.vk.$ViewGallerySettings ); /** * Creates a new subclass of class sap.ui.vk.ViewGallery 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewGallery. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.vk.ViewGallery`. * * 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.ViewGallery` itself. * * Fires when selection is changed via user interaction inside the control. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * 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: ViewGallery$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewGallery` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.vk.ViewGallery`. * * 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.ViewGallery` itself. * * Fires when selection is changed via user interaction inside the control. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewGallery$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewGallery` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewOrderChange viewOrderChange} event of this * `sap.ui.vk.ViewGallery`. * * 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.ViewGallery` itself. * * Fires when views are reordered * * * @returns Reference to `this` in order to allow method chaining */ attachViewOrderChange( /** * 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: ViewGallery$ViewOrderChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewGallery` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewOrderChange viewOrderChange} event of this * `sap.ui.vk.ViewGallery`. * * 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.ViewGallery` itself. * * Fires when views are reordered * * * @returns Reference to `this` in order to allow method chaining */ attachViewOrderChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewGallery$ViewOrderChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewGallery` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of * this `sap.ui.vk.ViewGallery`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewGallery$SelectionChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewOrderChange viewOrderChange} event of * this `sap.ui.vk.ViewGallery`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewOrderChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewGallery$ViewOrderChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:selectionChange selectionChange} 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 */ fireSelectionChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewGallery$SelectionChangeEventParameters ): this; /** * Fires event {@link #event:viewOrderChange viewOrderChange} 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 */ fireViewOrderChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewGallery$ViewOrderChangeEventParameters ): this; /** * ID of the element which is the current target of the association {@link #getAnimationPlayer animationPlayer}, * or `null`. */ getAnimationPlayer(): sap.ui.core.ID | null; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getEnabled enabled}. * * If disabled, view gallery is non-interactive and greyed out * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getEnableViewReordering enableViewReordering}. * * Indicates that the View Gallery control should allow view reordering * * Default value is `false`. * * * @returns Value of property `enableViewReordering` */ getEnableViewReordering(): boolean; /** * ID of the element which is the current target of the association {@link #getHost host}, or `null`. */ getHost(): sap.ui.core.ID | null; /** * Retrieves the index of the selected view group. * * * @returns An integer specifying the index of selected view group, or -1 if nothing is selected. */ getSelectedViewGroupIndex(): int; /** * Retrieves the index of the selected view. * * * @returns An integer specifying the index of selected view, or -1 if nothing is selected. */ getSelectedViewIndex(): int; /** * Gets current value of property {@link #getShowAnimationTimeSlider showAnimationTimeSlider}. * * Indicates that the View Gallery control should display animation slider showing time of animation in * current view. * * Default value is `true`. * * * @returns Value of property `showAnimationTimeSlider` */ getShowAnimationTimeSlider(): boolean; /** * Gets current value of property {@link #getShowThumbnailContainer showThumbnailContainer}. * * Indicates that the View Gallery control should display thumbnails * * Default value is `true`. * * * @returns Value of property `showThumbnailContainer` */ getShowThumbnailContainer(): boolean; /** * Gets current value of property {@link #getShowToolbar showToolbar}. * * Indicates that the View Gallery control should display toolbar * * Default value is `true`. * * * @returns Value of property `showToolbar` */ getShowToolbar(): boolean; /** * Gets current value of property {@link #getTransparency transparency}. * * Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% * opaque * * Default value is `1`. * * * @returns Value of property `transparency` */ getTransparency(): float; /** * ID of the element which is the current target of the association {@link #getViewManager viewManager}, * or `null`. */ getViewManager(): sap.ui.core.ID | null; /** * Sets the associated {@link #getAnimationPlayer animationPlayer}. * * * @returns Reference to `this` in order to allow method chaining */ setAnimationPlayer( /** * ID of an element which becomes the new target of this animationPlayer association; alternatively, an * element instance may be given */ oAnimationPlayer: sap.ui.core.ID | sap.ui.vk.AnimationPlayer ): this; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * If disabled, view gallery is non-interactive and greyed out * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getEnableViewReordering enableViewReordering}. * * Indicates that the View Gallery control should allow view reordering * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableViewReordering( /** * New value for property `enableViewReordering` */ bEnableViewReordering?: boolean ): this; /** * Sets the associated {@link #getHost host}. * * * @returns Reference to `this` in order to allow method chaining */ setHost( /** * ID of an element which becomes the new target of this host association; alternatively, an element instance * may be given */ oHost: sap.ui.core.ID | sap.ui.vk.ViewportBase ): this; /** * Set if playing animation when activating view or playing procedure */ setPlayingAnimation( /** * true if playing animation */ play: boolean ): void; /** * Attaches a Scene object to the View Gallery control so that it can access the Scene’s procedures and * steps. */ setScene( /** * The Scene object to attach to the View Gallery control. */ scene: object ): void; /** * Selects view group with given index. This will reload list of views. */ setSelectedViewGroupIndex( /** * Index of view group to become selected. */ index: int, /** * Index of view in view group to become selected */ viewIndex: int ): void; /** * Selects view with given view index. */ setSelectedViewIndex( /** * Index of view to become selected. */ index: int ): void; /** * Sets a new value for property {@link #getShowAnimationTimeSlider showAnimationTimeSlider}. * * Indicates that the View Gallery control should display animation slider showing time of animation in * current view. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowAnimationTimeSlider( /** * New value for property `showAnimationTimeSlider` */ bShowAnimationTimeSlider?: boolean ): this; /** * Sets a new value for property {@link #getShowThumbnailContainer showThumbnailContainer}. * * Indicates that the View Gallery control should display thumbnails * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowThumbnailContainer( /** * New value for property `showThumbnailContainer` */ bShowThumbnailContainer?: boolean ): this; /** * Sets a new value for property {@link #getShowToolbar showToolbar}. * * Indicates that the View Gallery control should display toolbar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowToolbar( /** * New value for property `showToolbar` */ bShowToolbar?: boolean ): this; /** * Sets a new value for property {@link #getTransparency transparency}. * * Sets the transparency level of the view gallery. Range is 0-1, with 1 being 100% opaque and 0 being 0% * opaque * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setTransparency( /** * New value for property `transparency` */ fTransparency?: float ): this; /** * Sets the associated {@link #getViewManager viewManager}. * * * @returns Reference to `this` in order to allow method chaining */ setViewManager( /** * ID of an element which becomes the new target of this viewManager association; alternatively, an element * instance may be given */ oViewManager: sap.ui.core.ID | sap.ui.vk.ViewManager ): this; } /** * Provides the interface for the view group. */ class ViewGroup extends sap.ui.base.ManagedObject { /** * Constructor for a new View Group. * * The objects of this class contain necessary information about View Group * * 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(); /** * Creates a new subclass of class sap.ui.vk.ViewGroup 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewGroup. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Add a view to the view group * * * @returns `this` to allow method chaining. */ addView( /** * view to add */ view: sap.ui.vk.View ): this; /** * Gets current value of property {@link #getDescription description}. * * * @returns Value of property `description` */ getDescription(): string; /** * Gets current value of property {@link #getName name}. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getViewGroupId viewGroupId}. * * * @returns Value of property `viewGroupId` */ getViewGroupId(): string; /** * Gets a list of views * * * @returns list of views */ getViews(): sap.ui.vk.View[]; /** * Gets index of a view in the view group * * * @returns view index of found or -1 otherwise */ indexOfView( /** * view to locate */ view: sap.ui.vk.View ): int; /** * Inserts a view * * * @returns `this` to allow method chaining. */ insertView( /** * view to insert */ view: sap.ui.vk.View, /** * index where to insert the view */ index: int ): this; /** * Removes a view from the view group * * * @returns `this` to allow method chaining. */ removeView( /** * view to remove */ view: sap.ui.vk.View ): this; /** * Removes all views from the view group * * * @returns `this` to allow method chaining. */ removeViews(): this; /** * Sets a new value for property {@link #getDescription description}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDescription( /** * New value for property `description` */ sDescription: string ): this; /** * Sets a new value for property {@link #getName name}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName: string ): this; /** * Sets a new value for property {@link #getViewGroupId viewGroupId}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setViewGroupId( /** * New value for property `viewGroupId` */ sViewGroupId: string ): this; } /** * An instance of the ViewManager class is responsible for tracking the current view, activating views and * playing views in view groups. */ class ViewManager extends sap.ui.core.Element { /** * Constructor for a new ViewManager. * * 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 ViewManager object. */ mSettings?: sap.ui.vk.$ViewManagerSettings ); /** * Constructor for a new ViewManager. * * 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 ViewManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewManager object. */ mSettings?: sap.ui.vk.$ViewManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.ViewManager 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Activates a view. * * * @returns A promise which resolves with the view when the view is fully activated. */ activateView( /** * A view to activate. */ view: sap.ui.vk.View, /** * An indicator to skip camera transition animation. */ skipCameraTransitionAnimation?: boolean, /** * An indicator to skip playing animation after activating the view whose property {@link sap.ui.vk.View#autoPlayAnimation autoPlayAnimation } * equals `true`. */ skipViewAnimation?: boolean ): Promise; /** * Gets the active view or the view being activated. * * * @returns The active view or the view being activated. */ getActiveView(): sap.ui.vk.View; /** * ID of the element which is the current target of the association {@link #getAnimationPlayer animationPlayer}, * or `null`. */ getAnimationPlayer(): sap.ui.core.ID | null; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Plays views in the specified view group. * * The playing starts with the view provided and continues to the next views until the very last in the * view group. * * * @returns `this` to allow method chaining. */ playViewGroup( /** * A view to start playing. */ view: sap.ui.vk.View, /** * A view group to play. */ viewGroup: sap.ui.vk.ViewGroup, /** * A delay in milliseconds between view activations when views do not have animations or there is no {@link sap.ui.vk.AnimationPlayer AnimationPlayer } * associated with the ViewManager. */ autoAdvanceViewTimeout?: int ): this; /** * Sets the associated {@link #getAnimationPlayer animationPlayer}. * * * @returns Reference to `this` in order to allow method chaining */ setAnimationPlayer( /** * ID of an element which becomes the new target of this animationPlayer association; alternatively, an * element instance may be given */ oAnimationPlayer: sap.ui.core.ID | sap.ui.vk.AnimationPlayer ): this; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Stops playing views in the currently active view group. * * * @returns `this` to allow method chaining. */ stopPlayingViewGroup(): this; } /** * Provides a rendering canvas for the 3D elements of a loaded scene. * * @since 1.50.0 */ class Viewport extends sap.ui.vk.ViewportBase { /** * Constructor for a new Viewport. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewportBase#constructor sap.ui.vk.ViewportBase } * can be used. */ constructor( /** * Initial settings for the new Viewport control. */ mSettings?: sap.ui.vk.$ViewportSettings ); /** * Constructor for a new Viewport. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewportBase#constructor sap.ui.vk.ViewportBase } * can be used. */ constructor( /** * ID for the new Viewport control. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Viewport control. */ mSettings?: sap.ui.vk.$ViewportSettings ); /** * Creates a new subclass of class sap.ui.vk.Viewport 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.vk.ViewportBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.Viewport. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Calls activateView with view definition * * * @returns returns this */ activateView( /** * object definition */ view: sap.ui.vk.View, /** * true if view activation is part of playing view group */ playViewGroup: boolean, /** * true if not animating the change of camera */ skipCameraTransitionAnimation: boolean ): sap.ui.vk.Viewport; /** * Get current view - remembered when activateView function is called * * * @returns current view */ getCurrentView(): sap.ui.vk.View; /** * Returns viewport content as an image of desired size. * * * @returns Base64 encoded PNG image */ getImage( /** * Requested image width in pixels (allowed values 8 to 2048) */ width: int, /** * Requested image height in pixels (allowed values 8 to 2048) */ height: int, /** * The sap.ui.core.CSSColor to be used for top background color */ topColor: string, /** * The sap.ui.core.CSSColor to be used for bottom background color */ bottomColor: string, /** * Include selected nodes */ includeSelection: boolean ): string; /** * Get the Symbol node from nodeId, if nodeId is not set, returns a collection of all Symbol nodes * * @since 1.82.0 * * @returns An array of nodes */ getSymbolNodes( /** * node Id string, optional */ nodeId: string ): any[]; /** * Retrieves information about the current camera view in the scene, and saves the information in a JSON-like * object. The information can then be used at a later time to restore the scene to the same camera view * using the {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} method. * * * * @returns JSON-like object which holds the current view information. See {@link sap.ui.vk.Viewport#setViewInfo setViewInfo}. * In addition to properties defined in {@link sap.ui.vk.Viewport#setViewInfo setViewInfo} the output from * {@link sap.ui.vk.Viewport#getViewInfo getViewInfo} contains camera view and projection matrices * ```javascript * * { * ... * camera: { * ... * matrices: { * view: [number, ...], * projection: [number, ...], * } * ... * }, * ... * } * ``` */ getViewInfo( /** * Query object which indicates what information to be retrieved. */ query?: { /** * Indicator to retrieve camera information. */ camera?: | boolean | { /** * Indicator to retrieve camera view and projection matrices. */ matrices?: boolean; /** * Indicator to retrieve the transition camera properties instead of regular one's. */ useTransitionCamera?: boolean; }; /** * Indicator to retrieve animation information. */ animation?: boolean; /** * Indicator to retrieve visibility information. */ visibility?: | boolean | { /** * Indicator to retrieve the complete visibility definition or just the difference. */ mode?: /* was: sap.ui.vk.VisibilityMode */ any; }; /** * Indicator to retrieve selection information. */ selection?: boolean | object; /** * Indicator to retrieve cross-section information. */ crossSection?: boolean | object; } ): object; /** * Sets the current scene to use the camera view information acquired from the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. * Internally, the `setViewInfo` method activates certain steps at certain animation times, and then changes * the camera position, rotation and field of view (FOV) / zoom factor. * * * @returns `this` to allow method chaining. */ setViewInfo( /** * A JSON-like object containing view information acquired using the {@link sap.ui.vk.Viewport#getViewInfo getViewInfo } * method. */ viewInfo: { /** * A JSON-like object containing the camera information. */ camera?: { /** * Rotation defined in {@link https://en.wikipedia.org/wiki/Aircraft_principal_axes Aircraft principal axes}. */ rotation: { /** * Angle around the vertical axis in degrees. */ yaw: float; /** * Angle around the lateral axis in degrees. */ pitch: float; /** * Angle around the longitudinal axis in degrees. */ roll: float; }; /** * Position defined in 3-dimensional space. */ position: { /** * X coordinate. */ x: float; /** * Y coordinate. */ y: float; /** * Z coordinate. */ z: float; }; /** * Camera field of view binding type. */ bindingType: sap.ui.vk.CameraFOVBindingType; /** * Camera projection type. */ projectionType: sap.ui.vk.CameraProjectionType; /** * Camera field of view in degrees. Applicable only to perspective cameras. */ fieldOfView: float; /** * Camera zoom factor. Applicable only to orthographic cameras. */ zoomFactor: float; }; /** * A JSON-like object containing the animation information. */ animation?: { /** * Step VE ID. If it is omitted then procedure and step indices are used. */ stepVeId?: string; /** * Procedure index in the list of procedures. */ procedureIndex?: int; /** * Step index in the list of steps in the procedure. */ stepIndex?: int; /** * Time at which to activate the step. */ animationTime?: float; }; /** * A JSON-like object containing the visibility information. */ visibility?: { /** * If the mode equals to {@link sap.ui.vk.VisibilityMode.Complete complete} then the visible and hidden * fields are defined. If the mode equals {@link sap.ui.vk.VisibilityMode.Differences differences} then * the changes field is defined. */ mode: /* was: sap.ui.vk.VisibilityMode */ any; /** * List of Ids of visible nodes. */ visible: string[]; /** * List of Ids of hidden nodes. */ hidden: string[]; /** * List of Ids of nodes with inverted visibility. */ changes: string[]; }; }, /** * Fly-to animation duration in seconds. */ flyToDuration?: float ): this; /** * * @returns `this` to allow method chaining. */ showHotspots( /** * The node reference or the array of node references that we want to tint. */ nodeRefs: any | any[], /** * Whether to highlight the nodes or remove the highlight. */ show: boolean, /** * The color to use for highlighting the nodes passed as argument. */ color: int | sap.ui.core.CSSColor ): this; /** * Executes a click or tap gesture. * * * @returns `this` to allow method chaining. */ tap( /** * The tap gesture's x-coordinate. */ x: int, /** * The tap gesture's y-coordinate. */ y: int, /** * Indicates whether the tap gesture should be interpreted as a double-click. A value of `true` indicates * a double-click gesture, and `false` indicates a single click gesture. */ isDoubleClick: boolean ): this; /** * Zooms the scene to a bounding box created from a particular set of nodes. * * * @returns this */ zoomTo( /** * What set of nodes to zoom to. */ what: sap.ui.vk.ZoomTo | sap.ui.vk.ZoomTo[], /** * Is only used if what == sap.ui.vk.ZoomTo.Node. */ nodeRef: any, /** * Time to perform the "fly to" animation. Set to 0 to do this immediately. */ crossFadeSeconds: float, /** * Margin. Set to 0 to zoom to the entire screen. */ margin: float ): sap.ui.vk.Viewport; } /** * Provides a rendering canvas for the 3D elements of a loaded scene. * * @since 1.50.0 */ abstract class ViewportBase extends sap.ui.core.Control { /** * Constructor for a new Viewport. * * 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 Viewport control. */ mSettings?: sap.ui.vk.$ViewportBaseSettings ); /** * Constructor for a new Viewport. * * 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 Viewport control. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new Viewport control. */ mSettings?: sap.ui.vk.$ViewportBaseSettings ); /** * Creates a new subclass of class sap.ui.vk.ViewportBase 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>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewportBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Sets a scene obtained as content from the associated content connector. * * This method should be overridden in derived classes. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining. */ _setContent( /** * New content or `null`. */ content: sap.ui.vk.Scene ): this; /** * Calls activateView with view definition * * * @returns return this */ activateView( /** * view object definition */ view: sap.ui.vk.View, /** * true if view activation is part of playing view group */ playViewGroup: boolean, /** * true if not animating the change of camera */ skipCameraTransitionAnimation: boolean ): sap.ui.vk.ViewportBase; /** * Adds some annotation to the aggregation {@link #getAnnotations annotations}. * * * @returns Reference to `this` in order to allow method chaining */ addAnnotation( /** * The annotation to add; if empty, nothing is inserted */ oAnnotation: sap.ui.vk.Annotation ): this; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * Adds some tool into the association {@link #getTools tools}. * * * @returns Reference to `this` in order to allow method chaining */ addTool( /** * The tools to add; if empty, nothing is inserted */ vTool: sap.ui.core.ID | sap.ui.vk.tools.Tool ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event will be fired when a node is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * 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: ViewportBase$NodeClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event will be fired when a node is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$NodeClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodesPicked nodesPicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when nodes in the scene are picked by user action. If application requires different * selection behaviour then it can handle this event and implement its own selection method. In this case * {@link sap.ui.vk.Viewport#selectionMode selectionMode} property should be set to `sap.ui.vk.SelectionMode.None` * Application can modify list of picked node references to alter selection behaviour. * * * @returns Reference to `this` in order to allow method chaining */ attachNodesPicked( /** * 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: ViewportBase$NodesPickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodesPicked nodesPicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when nodes in the scene are picked by user action. If application requires different * selection behaviour then it can handle this event and implement its own selection method. In this case * {@link sap.ui.vk.Viewport#selectionMode selectionMode} property should be set to `sap.ui.vk.SelectionMode.None` * Application can modify list of picked node references to alter selection behaviour. * * * @returns Reference to `this` in order to allow method chaining */ attachNodesPicked( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$NodesPickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeZoomed nodeZoomed} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a node in the scene is zoomed in/out by double-clicking. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeZoomed( /** * 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: ViewportBase$NodeZoomedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeZoomed nodeZoomed} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a node in the scene is zoomed in/out by double-clicking. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeZoomed( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$NodeZoomedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when viewport size is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * 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: ViewportBase$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when viewport size is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a URL in a note is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachUrlClicked( /** * 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: ViewportBase$UrlClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a URL in a note is clicked. * * * @returns Reference to `this` in order to allow method chaining */ attachUrlClicked( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$UrlClickedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewActivated viewActivated} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a view in the viewport is activated * * * @returns Reference to `this` in order to allow method chaining */ attachViewActivated( /** * 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: ViewportBase$ViewActivatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewActivated viewActivated} event of this `sap.ui.vk.ViewportBase`. * * 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.ViewportBase` itself. * * This event is fired when a view in the viewport is activated * * * @returns Reference to `this` in order to allow method chaining */ attachViewActivated( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewportBase$ViewActivatedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewportBase` itself */ oListener?: object ): this; /** * Destroys all the annotations in the aggregation {@link #getAnnotations annotations}. * * * @returns Reference to `this` in order to allow method chaining */ destroyAnnotations(): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Destroys the outputSettings in the aggregation {@link #getOutputSettings outputSettings}. * * * @returns Reference to `this` in order to allow method chaining */ destroyOutputSettings(): this; /** * Destroys the safeArea in the aggregation {@link #getSafeArea safeArea}. * * * @returns Reference to `this` in order to allow method chaining */ destroySafeArea(): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeClicked nodeClicked} event of this `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$NodeClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodesPicked nodesPicked} event of this `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodesPicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$NodesPickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeZoomed nodeZoomed} event of this `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeZoomed( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$NodeZoomedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:resize resize} event of this `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachResize( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$ResizeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:urlClicked urlClicked} event of this `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachUrlClicked( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$UrlClickedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewActivated viewActivated} event of this * `sap.ui.vk.ViewportBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewActivated( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewportBase$ViewActivatedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Helper method used to provide exclusive selection method. If this method is used then nodes are marked * as selected while all previously selected objects are deselected. If this is called with empty nodes * list then all already selected nodes are deselected. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ exclusiveSelectionHandler( /** * Array of node references */ nodes: any[] ): void; /** * Fires event {@link #event:nodeClicked nodeClicked} 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 */ fireNodeClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$NodeClickedEventParameters ): this; /** * Fires event {@link #event:nodesPicked nodesPicked} 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 */ fireNodesPicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$NodesPickedEventParameters ): this; /** * Fires event {@link #event:nodeZoomed nodeZoomed} 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 */ fireNodeZoomed( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$NodeZoomedEventParameters ): this; /** * Fires event {@link #event:resize resize} 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 */ fireResize( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$ResizeEventParameters ): this; /** * Fires event {@link #event:urlClicked urlClicked} 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 */ fireUrlClicked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$UrlClickedEventParameters ): this; /** * Fires event {@link #event:viewActivated viewActivated} 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 */ fireViewActivated( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewportBase$ViewActivatedEventParameters ): this; /** * Gets content of aggregation {@link #getAnnotations annotations}. * * HTML Annotations present in the active view */ getAnnotations(): sap.ui.vk.Annotation[]; /** * Gets current value of property {@link #getAutoStartRendering autoStartRendering}. * * Automatically start rendering This will allow client code to control if viewport rendering should commence * automatically or not. * * Default value is `true`. * * * @returns Value of property `autoStartRendering` */ getAutoStartRendering(): boolean; /** * Gets current value of property {@link #getBackgroundColorBottom backgroundColorBottom}. * * Viewport background bottom color in the CSS Color format * * Default value is `"rgba(255, 255, 255, 1)"`. * * * @returns Value of property `backgroundColorBottom` */ getBackgroundColorBottom(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getBackgroundColorTop backgroundColorTop}. * * Viewport background top color in the CSS Color format * * Default value is `"rgba(50, 50, 50, 1)"`. * * * @returns Value of property `backgroundColorTop` */ getBackgroundColorTop(): sap.ui.core.CSSColor; /** * Gets current camera to the viewport * * * @returns Current camera in this viewport. */ getCamera(): sap.ui.vk.Camera; /** * Gets content of aggregation {@link #getContent content}. * * The controls inside the viewport. */ getContent(): sap.ui.core.Control[]; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getDisableHotspotHovering disableHotspotHovering}. * * Disables hotspot hovering * * Default value is `false`. * * * @returns Value of property `disableHotspotHovering` */ getDisableHotspotHovering(): boolean; /** * Gets current value of property {@link #getFreezeCamera freezeCamera}. * * Freeze camera * * Default value is `false`. * * * @returns Value of property `freezeCamera` */ getFreezeCamera(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Viewport height * * Default value is `"100%"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getHotspotColor hotspotColor}. * * Color used for highlighting hotspots in the CSS Color format * * Default value is `"rgba(89, 0, 0, 0.73)"`. * * * @returns Value of property `hotspotColor` */ getHotspotColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getHotspotColorABGR hotspotColorABGR}. * * Color used for highlighting hotspots in the ABGR format * * Default value is `0x590000BB`. * * * @returns Value of property `hotspotColorABGR` */ getHotspotColorABGR(): int; /** * Gets current value of property {@link #getHotspotCustomTextHaloWidth hotspotCustomTextHaloWidth}. * * Default value is `10`. * * * @returns Value of property `hotspotCustomTextHaloWidth` */ getHotspotCustomTextHaloWidth(): float; /** * Gets current value of property {@link #getHotspotCustomTextOutlineColor hotspotCustomTextOutlineColor}. * * Default value is `"white"`. * * * @returns Value of property `hotspotCustomTextOutlineColor` */ getHotspotCustomTextOutlineColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getHotspotCustomTextOutlineWidth hotspotCustomTextOutlineWidth}. * * Default value is `1`. * * * @returns Value of property `hotspotCustomTextOutlineWidth` */ getHotspotCustomTextOutlineWidth(): float; /** * Gets current value of property {@link #getKeepOutputSize keepOutputSize}. * * Default value is `false`. * * * @returns Value of property `keepOutputSize` */ getKeepOutputSize(): boolean; /** * Gets current value of property {@link #getMaxCameraPitch maxCameraPitch}. * * Default value is `90`. * * * @returns Value of property `maxCameraPitch` */ getMaxCameraPitch(): float; /** * Gets current value of property {@link #getMinCameraPitch minCameraPitch}. * * Default value is `-90`. * * * @returns Value of property `minCameraPitch` */ getMinCameraPitch(): float; /** * Gets content of aggregation {@link #getOutputSettings outputSettings}. * * Output size settings of the viewport */ getOutputSettings(): sap.ui.vk.OutputSettings; /** * Gets current value of property {@link #getRenderMode renderMode}. * * Viewport render mode * * Default value is `Default`. * * * @returns Value of property `renderMode` */ getRenderMode(): sap.ui.vk.RenderMode; /** * Gets content of aggregation {@link #getSafeArea safeArea}. * * SafeArea control for viewport */ getSafeArea(): sap.ui.vk.SafeArea; /** * Gets current value of property {@link #getSelectionDisplayMode selectionDisplayMode}. * * Selection display mode * * Default value is `Highlight`. * * * @returns Value of property `selectionDisplayMode` */ getSelectionDisplayMode(): sap.ui.vk.SelectionDisplayMode; /** * Gets current value of property {@link #getSelectionMode selectionMode}. * * Selection mode * * Default value is `Sticky`. * * * @returns Value of property `selectionMode` */ getSelectionMode(): sap.ui.vk.SelectionMode; /** * Gets current value of property {@link #getShowAllDynamicContents showAllDynamicContents}. * * Enables or disables showing of all dynamic contents * * Default value is `false`. * * * @returns Value of property `showAllDynamicContents` */ getShowAllDynamicContents(): boolean; /** * Gets current value of property {@link #getShowAllHotspots showAllHotspots}. * * Enables or disables showing of all hotspots * * Default value is `false`. * * * @returns Value of property `showAllHotspots` */ getShowAllHotspots(): boolean; /** * Gets current value of property {@link #getShowAllHotspotsTintColor showAllHotspotsTintColor}. * * Color used to highlight all hotspots when the showAllHotspots property has a value of true. * * Default value is `"rgba(255, 255, 0, .35)"`. * * * @returns Value of property `showAllHotspotsTintColor` */ getShowAllHotspotsTintColor(): sap.ui.core.CSSColor; /** * Gets current value of property {@link #getShowDebugInfo showDebugInfo}. * * Shows or hides the debug info. * * Default value is `false`. * * * @returns Value of property `showDebugInfo` */ getShowDebugInfo(): boolean; /** * Gets current value of property {@link #getShowSafeArea showSafeArea}. * * Shows or hides the Safe Area * * Default value is `false`. * * * @returns Value of property `showSafeArea` */ getShowSafeArea(): boolean; /** * Gets current value of property {@link #getShowSelectionBoundingBoxes showSelectionBoundingBoxes}. * * Show selection bounding boxes * * Default value is `true`. * * * @returns Value of property `showSelectionBoundingBoxes` */ getShowSelectionBoundingBoxes(): boolean; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getTools tools}. */ getTools(): sap.ui.core.ID[]; /** * ID of the element which is the current target of the association {@link #getViewStateManager viewStateManager}, * or `null`. */ getViewStateManager(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * Viewport width * * Default value is `"100%"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.ui.vk.Annotation` in the aggregation {@link #getAnnotations annotations}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfAnnotation( /** * The annotation whose index is looked for */ oAnnotation: sap.ui.vk.Annotation ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Inserts a annotation into the aggregation {@link #getAnnotations annotations}. * * * @returns Reference to `this` in order to allow method chaining */ insertAnnotation( /** * The annotation to insert; if empty, nothing is inserted */ oAnnotation: sap.ui.vk.Annotation, /** * The `0`-based index the annotation should be inserted at; for a negative value of `iIndex`, the annotation * is inserted at position 0; for a value greater than the current size of the aggregation, the annotation * is inserted at the last position */ iIndex: int ): this; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Performs a `pan` gesture to pan across the Viewport. * * * @returns return this */ pan( /** * The change in distance along the x-coordinate. */ dx: int, /** * The change in distance along the y-coordinate. */ dy: int ): sap.ui.vk.ViewportBase; /** * Removes all the controls from the aggregation {@link #getAnnotations annotations}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllAnnotations(): sap.ui.vk.Annotation[]; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes all the controls in the association named {@link #getTools tools}. * * * @returns An array of the removed elements (might be empty) */ removeAllTools(): sap.ui.core.ID[]; /** * Removes a annotation from the aggregation {@link #getAnnotations annotations}. * * * @returns The removed annotation or `null` */ removeAnnotation( /** * The annotation to remove or its index or id */ vAnnotation: int | string | sap.ui.vk.Annotation ): sap.ui.vk.Annotation | null; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes an tool from the association named {@link #getTools tools}. * * * @returns The removed tool or `null` */ removeTool( /** * The tool to be removed or its index or ID */ vTool: int | sap.ui.core.ID | sap.ui.vk.tools.Tool ): sap.ui.core.ID | null; /** * Renders viewport content. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ renderContent( /** * the RenderManager that can be used for writing to the Render-Output-Buffer */ rm: sap.ui.core.RenderManager ): void; /** * Renders viewport tools. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ renderTools( /** * the RenderManager that can be used for writing to the Render-Output-Buffer */ rm: sap.ui.core.RenderManager ): void; /** * Rotates the content resource displayed on the Viewport. * * * @returns return this */ rotate( /** * The change in x-coordinate used to define the desired rotation. */ dx: int, /** * The change in y-coordinate used to define the desired rotation. */ dy: int ): sap.ui.vk.ViewportBase; /** * Sets a new value for property {@link #getAutoStartRendering autoStartRendering}. * * Automatically start rendering This will allow client code to control if viewport rendering should commence * automatically or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setAutoStartRendering( /** * New value for property `autoStartRendering` */ bAutoStartRendering?: boolean ): this; /** * Sets a new value for property {@link #getBackgroundColorBottom backgroundColorBottom}. * * Viewport background bottom color in the CSS Color format * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(255, 255, 255, 1)"`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundColorBottom( /** * New value for property `backgroundColorBottom` */ sBackgroundColorBottom?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getBackgroundColorTop backgroundColorTop}. * * Viewport background top color in the CSS Color format * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(50, 50, 50, 1)"`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundColorTop( /** * New value for property `backgroundColorTop` */ sBackgroundColorTop?: sap.ui.core.CSSColor ): this; /** * Sets current camera to the viewport * * @since 1.52.0 * * @returns `this` to allow method chaining. */ setCamera( /** * If the `camera` parameter is not `null`, the camera is replaced. If the `camera` parameter is `null`, * the current camera is destroyed. */ camera: sap.ui.vk.Camera ): this; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Sets a new value for property {@link #getDisableHotspotHovering disableHotspotHovering}. * * Disables hotspot hovering * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDisableHotspotHovering( /** * New value for property `disableHotspotHovering` */ bDisableHotspotHovering?: boolean ): this; /** * Sets a new value for property {@link #getFreezeCamera freezeCamera}. * * Freeze camera * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setFreezeCamera( /** * New value for property `freezeCamera` */ bFreezeCamera?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Viewport 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?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getHotspotColor hotspotColor}. * * Color used for highlighting hotspots in the CSS Color format * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(89, 0, 0, 0.73)"`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotColor( /** * New value for property `hotspotColor` */ sHotspotColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getHotspotColorABGR hotspotColorABGR}. * * Color used for highlighting hotspots in the ABGR format * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0x590000BB`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotColorABGR( /** * New value for property `hotspotColorABGR` */ iHotspotColorABGR?: int ): this; /** * Sets a new value for property {@link #getHotspotCustomTextHaloWidth hotspotCustomTextHaloWidth}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `10`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotCustomTextHaloWidth( /** * New value for property `hotspotCustomTextHaloWidth` */ fHotspotCustomTextHaloWidth?: float ): this; /** * Sets a new value for property {@link #getHotspotCustomTextOutlineColor hotspotCustomTextOutlineColor}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"white"`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotCustomTextOutlineColor( /** * New value for property `hotspotCustomTextOutlineColor` */ sHotspotCustomTextOutlineColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getHotspotCustomTextOutlineWidth hotspotCustomTextOutlineWidth}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setHotspotCustomTextOutlineWidth( /** * New value for property `hotspotCustomTextOutlineWidth` */ fHotspotCustomTextOutlineWidth?: float ): this; /** * Sets a new value for property {@link #getKeepOutputSize keepOutputSize}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setKeepOutputSize( /** * New value for property `keepOutputSize` */ bKeepOutputSize?: boolean ): this; /** * Sets a new value for property {@link #getMaxCameraPitch maxCameraPitch}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `90`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxCameraPitch( /** * New value for property `maxCameraPitch` */ fMaxCameraPitch?: float ): this; /** * Sets a new value for property {@link #getMinCameraPitch minCameraPitch}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `-90`. * * * @returns Reference to `this` in order to allow method chaining */ setMinCameraPitch( /** * New value for property `minCameraPitch` */ fMinCameraPitch?: float ): this; /** * Sets the aggregated {@link #getOutputSettings outputSettings}. * * * @returns Reference to `this` in order to allow method chaining */ setOutputSettings( /** * The outputSettings to set */ oOutputSettings: sap.ui.vk.OutputSettings ): this; /** * Sets a new value for property {@link #getRenderMode renderMode}. * * Viewport render mode * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setRenderMode( /** * New value for property `renderMode` */ sRenderMode?: sap.ui.vk.RenderMode ): this; /** * Sets the aggregated {@link #getSafeArea safeArea}. * * * @returns Reference to `this` in order to allow method chaining */ setSafeArea( /** * The safeArea to set */ oSafeArea: sap.ui.vk.SafeArea ): this; /** * Sets a new value for property {@link #getSelectionDisplayMode selectionDisplayMode}. * * Selection display mode * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Highlight`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionDisplayMode( /** * New value for property `selectionDisplayMode` */ sSelectionDisplayMode?: sap.ui.vk.SelectionDisplayMode ): this; /** * Sets a new value for property {@link #getSelectionMode selectionMode}. * * Selection mode * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Sticky`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionMode( /** * New value for property `selectionMode` */ sSelectionMode?: sap.ui.vk.SelectionMode ): this; /** * Sets a new value for property {@link #getShowAllDynamicContents showAllDynamicContents}. * * Enables or disables showing of all dynamic contents * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowAllDynamicContents( /** * New value for property `showAllDynamicContents` */ bShowAllDynamicContents?: boolean ): this; /** * Sets a new value for property {@link #getShowAllHotspots showAllHotspots}. * * Enables or disables showing of all hotspots * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowAllHotspots( /** * New value for property `showAllHotspots` */ bShowAllHotspots?: boolean ): this; /** * Sets a new value for property {@link #getShowAllHotspotsTintColor showAllHotspotsTintColor}. * * Color used to highlight all hotspots when the showAllHotspots property has a value of true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"rgba(255, 255, 0, .35)"`. * * * @returns Reference to `this` in order to allow method chaining */ setShowAllHotspotsTintColor( /** * New value for property `showAllHotspotsTintColor` */ sShowAllHotspotsTintColor?: sap.ui.core.CSSColor ): this; /** * Sets a new value for property {@link #getShowDebugInfo showDebugInfo}. * * Shows or hides the debug info. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowDebugInfo( /** * New value for property `showDebugInfo` */ bShowDebugInfo?: boolean ): this; /** * Sets a new value for property {@link #getShowSafeArea showSafeArea}. * * Shows or hides the Safe Area * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSafeArea( /** * New value for property `showSafeArea` */ bShowSafeArea?: boolean ): this; /** * Sets a new value for property {@link #getShowSelectionBoundingBoxes showSelectionBoundingBoxes}. * * Show selection bounding boxes * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowSelectionBoundingBoxes( /** * New value for property `showSelectionBoundingBoxes` */ bShowSelectionBoundingBoxes?: boolean ): 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: sap.ui.core.ID | sap.ui.vk.ViewStateManagerBase ): this; /** * Sets a new value for property {@link #getWidth width}. * * Viewport width * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; /** * Helper method to provide "sticky" selection method. If this method is used then nodes are added into * selection if they were not selected before, otherwise they are removed from selection. If this is called * with empty nodes list then all already selected nodes are deselected. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ stickySelectionHandler( /** * Array of node references */ nodes: any[] ): void; /** * Performs a `zoom` gesture to zoom in or out on the beginGesture coordinate. * * * @returns return this */ zoom( /** * Zoom factor. A scale factor that specifies how much to zoom in or out by. */ dy: float ): sap.ui.vk.ViewportBase; } /** * Manages the visibility and selection states of nodes in the scene. * * @since 1.32.0 */ class ViewStateManager extends sap.ui.vk.ViewStateManagerBase { /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.$ViewStateManagerSettings ); /** * Constructor for a new ViewStateManager. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.vk.ViewStateManagerBase#constructor sap.ui.vk.ViewStateManagerBase } * can be used. */ constructor( /** * ID for the new ViewStateManager object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewStateManager object. */ mSettings?: sap.ui.vk.$ViewStateManagerSettings ); /** * Creates a new subclass of class sap.ui.vk.ViewStateManager 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.vk.ViewStateManagerBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewStateManager. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Enumerates IDs of the outlined nodes. * * * @returns `this` to allow method chaining. */ enumerateOutlinedNodes( /** * A function to call when the outlined nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Enumerates IDs of the selected nodes. * * * @returns `this` to allow method chaining. */ enumerateSelection( /** * A function to call when the selected nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Gets the Animation player associated with viewManager. * * * @returns animation player */ getAnimationPlayer(): sap.ui.vk.AnimationPlayer; /** * Gets the default highlighting color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getHighlightColor( /** * This flag indicates to return the default highlighting color in the ABGR format, if it equals `false` * then the color is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the NodeHierarchy object associated with this ViewStateManager object. * * * @returns The node hierarchy associated with this ViewStateManager object. */ getNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the opacity of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own opacity should * be used. */ getOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): float | float[]; /** * Gets the outline color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getOutlineColor( /** * This flag indicates to return the outline color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the outline width * * * @returns Width of outline */ getOutlineWidth(): float; /** * Gets the outlining state of the node. * * If a single node reference is passed to the method then a single outlining state is returned. * If an array of node references is passed to the method then an array of outlining states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getOutliningState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Get node's opacity stored in active view. * * * @returns node opacity */ getRestOpacity( /** * The node reference. */ nodeRef: any ): float; /** * Get node's rest transformation stored in active view. * * * @returns object that contains `translation`, `scale` and `quaternion` components. */ getRestTransformation( /** * The node reference. */ nodeRef: any ): any; /** * Gets the selection state of the node. * * If a single node reference is passed to the method then a single selection state is returned. * If an array of node references is passed to the method then an array of selection states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets if showing the bounding box when nodes are selected * * * @returns `true` if bounding boxes of selected nodes are shown, `false` otherwise. */ getShowSelectionBoundingBox(): boolean; /** * Get the Symbol node from nodeId, if nodeId is not set, returns a collection of all Symbol nodes * * @since 1.82.0 * * @returns An array of nodes */ getSymbolNodes( /** * node Id string, optional */ nodeId: string ): any[]; /** * Gets the tint color of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * This flag indicates to return the tint color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[] | int | int[]; /** * Get total opacity - product of all the ancestors' opacities and its own opacity * * * @returns total opacity */ getTotalOpacity( /** * The node reference of the opacity track */ nodeRef: any ): float; /** * Gets the visibility changes in the current ViewStateManager object. * * * @returns The visibility changes are in the form of an array. The array is a list of node VE ids which * suffered a visibility changed relative to the default state. */ getVisibilityChanges(): string[]; /** * Gets the visibility state of nodes. * * If a single node reference is passed to the method then a single visibility state is returned. * If an array of node references is passed to the method then an array of visibility states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is visible, `false` * otherwise. */ getVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Resets the visibility states of all nodes to the initial states. * * * @returns `this` to allow method chaining. */ resetVisibility(): this; /** * Replace node's current opacity with its rest opacity stored in active view.. * * * @returns `this` to allow method chaining. */ restoreRestOpacity( /** * The node reference. */ nodeRef: any ): this; /** * Replace node's current transformation with its rest transformation stored in active view.. * * * @returns `this` to allow method chaining. */ restoreRestTransformation( /** * The node reference. */ nodeRef: any ): this; /** * Sets the default highlighting color * * * @returns `this` to allow method chaining. */ setHighlightColor( /** * The new default highlighting color. The value can be defined as a string in the CSS color format or as * an integer in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint * color should be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Set highlight display state. * * * @returns `this` to allow method chaining. */ setHighlightDisplayState( /** * State for playing highlight - playing, pausing, and stopped */ state: /* was: sap.ui.vk.HighlightDisplayState */ any ): this; /** * Sets the opacity of the nodes. * * * @returns `this` to allow method chaining. */ setOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new opacity of the nodes. If `null` is passed then the opacity is reset and the node's own opacity * should be used. */ opacity: float | null, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the outline color * * * @returns `this` to allow method chaining. */ setOutlineColor( /** * The new outline color. The value can be defined as a string in the CSS color format or as an integer * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should * be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Sets the outline width * * * @returns `this` to allow method chaining. */ setOutlineWidth( /** * Width of outline */ width: float ): this; /** * Sets or resets the outlining state of the nodes. * * * @returns `this` to allow method chaining. */ setOutliningStates( /** * The node reference or the array of node references of selected nodes. */ outlinedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unoutlinedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean ): this; /** * Set node's opacity stored in active view. * * * @returns `this` to allow method chaining. */ setRestOpacity( /** * The node reference. */ nodeRef: any, /** * The node opacity */ opacity: float ): this; /** * Set node's rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ setRestTransformation( /** * The node reference. */ nodeRef: any, /** * vector for position, array of size 3. */ translation: float[], /** * quaternion for rotation, array of size 3. */ quaternion: float[], /** * vector for scaling, array of size 3. */ scale: float[] ): this; /** * Sets the selection state of the nodes. * * @deprecated As of version 1.56.3. Use {@link sap.ui.vk.ViewStateManager#setSelectionStates} instead. * * @returns `this` to allow method chaining. */ setSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets or resets the selection state of the nodes. * * * @returns `this` to allow method chaining. */ setSelectionStates( /** * The node reference or the array of node references of selected nodes. */ selectedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unselectedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets if showing the bounding box when nodes are selected */ setShowSelectionBoundingBox( /** * `true` if bounding boxes of selected nodes are shown, `false` otherwise. */ val: boolean ): void; /** * Sets the tint color of the nodes. * * * @returns `this` to allow method chaining. */ setTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an * integer in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint * color should be used. */ tintColor: sap.ui.core.CSSColor | int | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Set total opacity using current opacity - product of all the ancestors' opacities and its own opacity * The node's opacity is re-calculated based on the total opacity if the parent's total opacity is zero, * the node's total opacity is zero, the node's opacity is not changed * * * @returns object contains `opacity` and `totalOpacity` */ setTotalOpacity( /** * The node reference of the opacity track */ nodeRef: any, /** * product of all the ancestors' opacities and its own opacity */ totalOpacity: float ): any; /** * Sets the visibility state of the nodes. * * * @returns `this` to allow method chaining. */ setVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new visibility state of the nodes. */ visible: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag * will force node to be visible regardless of parent's state. */ force: boolean ): this; /** * Copy nodes' current transformation into their rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ updateNodesRestTransformation( /** * Array of node references. */ nodeRefs: any[] ): this; /** * Copy node's current opacity into its rest opacity stored in active view. * * * @returns `this` to allow method chaining. */ updateRestOpacity( /** * The node reference. */ nodeRef: any ): this; /** * Copy node's current transformation into its rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ updateRestTransformation( /** * The node reference. */ nodeRef: any, /** * Do not trigger the sequence changed event in case other node references are not updated. */ doNotFireSequenceChanged: boolean ): this; } /** * Manages the visibility and selection states of nodes in the scene. * * @since 1.32.0 */ abstract class ViewStateManagerBase extends sap.ui.core.Element { /** * Constructor for a new ViewStateManagerBase. * * 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 ViewStateManagerBase object. */ mSettings?: sap.ui.vk.$ViewStateManagerBaseSettings ); /** * Constructor for a new ViewStateManagerBase. * * 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 ViewStateManagerBase object. Generated automatically if no ID is given. */ sId?: string, /** * Initial settings for the new ViewStateManagerBase object. */ mSettings?: sap.ui.vk.$ViewStateManagerBaseSettings ); /** * Creates a new subclass of class sap.ui.vk.ViewStateManagerBase 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.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.ViewStateManagerBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Sets a scene obtained as content from the associated content connector. * * This method should be overridden in derived classes. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining. */ _setContent( /** * New content or `null`. */ content: sap.ui.vk.Scene ): this; /** * Attaches event handler `fnFunction` to the {@link #event:highlightColorChanged highlightColorChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when highlighting color is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachHighlightColorChanged( /** * 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: ViewStateManagerBase$HighlightColorChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:highlightColorChanged highlightColorChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when highlighting color is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachHighlightColorChanged( /** * The function to be called when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$HighlightColorChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeHierarchyReplaced nodeHierarchyReplaced } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the node hierarchy is replaced. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeHierarchyReplaced( /** * 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: ViewStateManagerBase$NodeHierarchyReplacedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:nodeHierarchyReplaced nodeHierarchyReplaced } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the node hierarchy is replaced. * * * @returns Reference to `this` in order to allow method chaining */ attachNodeHierarchyReplaced( /** * The function to be called when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$NodeHierarchyReplacedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:opacityChanged opacityChanged} event of this * `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when opacity of the nodes is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOpacityChanged( /** * 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: ViewStateManagerBase$OpacityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:opacityChanged opacityChanged} event of this * `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when opacity of the nodes is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOpacityChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$OpacityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outlineColorChanged outlineColorChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when outlining color is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOutlineColorChanged( /** * 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: ViewStateManagerBase$OutlineColorChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outlineColorChanged outlineColorChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when outlining color is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOutlineColorChanged( /** * The function to be called when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$OutlineColorChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outlineWidthChanged outlineWidthChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when outline width is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOutlineWidthChanged( /** * 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: ViewStateManagerBase$OutlineWidthChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outlineWidthChanged outlineWidthChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when outline width is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachOutlineWidthChanged( /** * The function to be called when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$OutlineWidthChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outliningChanged outliningChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the nodes are outlined/unoutlined. * * * @returns Reference to `this` in order to allow method chaining */ attachOutliningChanged( /** * 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: ViewStateManagerBase$OutliningChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:outliningChanged outliningChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the nodes are outlined/unoutlined. * * * @returns Reference to `this` in order to allow method chaining */ attachOutliningChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$OutliningChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:readyForAnimation readyForAnimation} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when viewport is ready for playing animation (e.g, camera is ready). * * * @returns Reference to `this` in order to allow method chaining */ attachReadyForAnimation( /** * 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: ViewStateManagerBase$ReadyForAnimationEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:readyForAnimation readyForAnimation} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when viewport is ready for playing animation (e.g, camera is ready). * * * @returns Reference to `this` in order to allow method chaining */ attachReadyForAnimation( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ReadyForAnimationEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the nodes are selected/unselected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * 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: ViewStateManagerBase$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the nodes are selected/unselected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$SelectionChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tintColorChanged tintColorChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when tint color of the nodes is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachTintColorChanged( /** * 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: ViewStateManagerBase$TintColorChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tintColorChanged tintColorChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when tint color of the nodes is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachTintColorChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$TintColorChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:transformationChanged transformationChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when node's transformation changed. * * * @returns Reference to `this` in order to allow method chaining */ attachTransformationChanged( /** * 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: ViewStateManagerBase$TransformationChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:transformationChanged transformationChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when node's transformation changed. * * * @returns Reference to `this` in order to allow method chaining */ attachTransformationChanged( /** * The function to be called when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$TransformationChangedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewStateApplied viewStateApplied} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when View activated. * * * @returns Reference to `this` in order to allow method chaining */ attachViewStateApplied( /** * 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: ViewStateManagerBase$ViewStateAppliedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewStateApplied viewStateApplied} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when View activated. * * * @returns Reference to `this` in order to allow method chaining */ attachViewStateApplied( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ViewStateAppliedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewStateApplying viewStateApplying} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when View is about to be activated. * * * @returns Reference to `this` in order to allow method chaining */ attachViewStateApplying( /** * 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: ViewStateManagerBase$ViewStateApplyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:viewStateApplying viewStateApplying} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when View is about to be activated. * * * @returns Reference to `this` in order to allow method chaining */ attachViewStateApplying( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ViewStateApplyingEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityChanged visibilityChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the visibility of the node changes. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityChanged( /** * 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: ViewStateManagerBase$VisibilityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibilityChanged visibilityChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * 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.ViewStateManagerBase` itself. * * This event is fired when the visibility of the node changes. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibilityChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: ViewStateManagerBase$VisibilityChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.vk.ViewStateManagerBase` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:highlightColorChanged highlightColorChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachHighlightColorChanged( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$HighlightColorChangedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:nodeHierarchyReplaced nodeHierarchyReplaced } * event of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNodeHierarchyReplaced( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$NodeHierarchyReplacedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:opacityChanged opacityChanged} event of this * `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachOpacityChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$OpacityChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:outlineColorChanged outlineColorChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachOutlineColorChanged( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$OutlineColorChangedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:outlineWidthChanged outlineWidthChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachOutlineWidthChanged( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$OutlineWidthChangedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:outliningChanged outliningChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachOutliningChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$OutliningChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:readyForAnimation readyForAnimation} event * of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachReadyForAnimation( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ReadyForAnimationEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChanged selectionChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$SelectionChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:tintColorChanged tintColorChanged} event of * this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachTintColorChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$TintColorChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:transformationChanged transformationChanged } * event of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachTransformationChanged( /** * The function to be called, when the event occurs */ fnFunction: ( p1: ViewStateManagerBase$TransformationChangedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewStateApplied viewStateApplied} event of * this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewStateApplied( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ViewStateAppliedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:viewStateApplying viewStateApplying} event * of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachViewStateApplying( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$ViewStateApplyingEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibilityChanged visibilityChanged} event * of this `sap.ui.vk.ViewStateManagerBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibilityChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: ViewStateManagerBase$VisibilityChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Enumerates IDs of the outlined nodes. * * * @returns `this` to allow method chaining. */ enumerateOutlinedNodes( /** * A function to call when the outlined nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Enumerates IDs of the selected nodes. * * * @returns `this` to allow method chaining. */ enumerateSelection( /** * A function to call when the selected nodes are enumerated. The function takes one parameter of type `string`. */ callback: Function ): this; /** * Fires event {@link #event:highlightColorChanged highlightColorChanged} 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 */ fireHighlightColorChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$HighlightColorChangedEventParameters ): this; /** * Fires event {@link #event:nodeHierarchyReplaced nodeHierarchyReplaced} 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 */ fireNodeHierarchyReplaced( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$NodeHierarchyReplacedEventParameters ): this; /** * Fires event {@link #event:opacityChanged opacityChanged} 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 */ fireOpacityChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$OpacityChangedEventParameters ): this; /** * Fires event {@link #event:outlineColorChanged outlineColorChanged} 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 */ fireOutlineColorChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$OutlineColorChangedEventParameters ): this; /** * Fires event {@link #event:outlineWidthChanged outlineWidthChanged} 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 */ fireOutlineWidthChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$OutlineWidthChangedEventParameters ): this; /** * Fires event {@link #event:outliningChanged outliningChanged} 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 */ fireOutliningChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$OutliningChangedEventParameters ): this; /** * Fires event {@link #event:readyForAnimation readyForAnimation} 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 */ fireReadyForAnimation( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$ReadyForAnimationEventParameters ): this; /** * Fires event {@link #event:selectionChanged selectionChanged} 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 */ fireSelectionChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$SelectionChangedEventParameters ): this; /** * Fires event {@link #event:tintColorChanged tintColorChanged} 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 */ fireTintColorChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$TintColorChangedEventParameters ): this; /** * Fires event {@link #event:transformationChanged transformationChanged} 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 */ fireTransformationChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$TransformationChangedEventParameters ): this; /** * Fires event {@link #event:viewStateApplied viewStateApplied} 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 */ fireViewStateApplied( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$ViewStateAppliedEventParameters ): this; /** * Fires event {@link #event:viewStateApplying viewStateApplying} 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 */ fireViewStateApplying( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$ViewStateApplyingEventParameters ): this; /** * Fires event {@link #event:visibilityChanged visibilityChanged} 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 */ fireVisibilityChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.vk.ViewStateManagerBase$VisibilityChangedEventParameters ): this; /** * ID of the element which is the current target of the association {@link #getContentConnector contentConnector}, * or `null`. */ getContentConnector(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getFeatures features}. * * Default value is `[]`. * * * @returns Value of property `features` */ getFeatures(): string[]; /** * Gets the NodeHierarchy object associated with this ViewStateManagerBase object. * * * @returns The node hierarchy associated with this ViewStateManagerBase object. */ getNodeHierarchy(): sap.ui.vk.NodeHierarchy; /** * Gets the opacity of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. */ getOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): void; /** * Gets the outline color * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getOutlineColor( /** * This flag indicates to return the outline color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | string | int; /** * Gets the outline width * * * @returns width of outline */ getOutlineWidth(): float; /** * Gets the outlining state of the node. * * If a single node reference is passed to the method then a single outlining state is returned. * If an array of node references is passed to the method then an array of outlining states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is outlined, `false` * otherwise. */ getOutliningState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets current value of property {@link #getRecursiveOutlining recursiveOutlining}. * * Default value is `false`. * * * @returns Value of property `recursiveOutlining` */ getRecursiveOutlining(): boolean; /** * Gets current value of property {@link #getRecursiveSelection recursiveSelection}. * * Default value is `false`. * * * @returns Value of property `recursiveSelection` */ getRecursiveSelection(): boolean; /** * Gets the node transformation rotation component in specified format. * * * @returns vector A rotation component of node(s) transformation matrix. */ getRotation( /** * The node reference or the array of node references. */ nodeRef: any | any[], /** * Rotation representation type. */ rotationType: /* was: sap.ui.vk.RotationType */ any ): float[] | float[][]; /** * Gets the node transformation scale component. * * * @returns vector A scale component of node's transformation matrix. */ getScale( /** * The node reference. */ nodeRef: any | any[] ): float[] | float[][]; /** * Gets the `selectable` property of the nodes. * * ***Selectable*** nodes can be selected in the viewport by mouse click or by using a selection tool. This * property does not affect rendering. * * By default nodes are ***selectable***. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * @since 1.111.0 * * @returns A single value or an array of values. Value `null` means that the node's own `selectable` property * should be used. */ getSelectable( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): float | float[]; /** * Gets the selection state of the node. * * If a single node reference is passed to the method then a single selection state is returned. * If an array of node references is passed to the method then an array of selection states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is selected, `false` * otherwise. */ getSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Gets current value of property {@link #getShouldTrackVisibilityChanges shouldTrackVisibilityChanges}. * * Default value is `false`. * * * @returns Value of property `shouldTrackVisibilityChanges` */ getShouldTrackVisibilityChanges(): boolean; /** * Gets the tint color of the node. * * If a single node reference is passed to the method then a single value is returned. * If an array of node references is passed to the method then an array of values is returned. * * * @returns A single value or an array of values. Value `null` means that the node's own tint color should * be used. */ getTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * This flag indicates to return the tint color in the ABGR format, if it equals `false` then the color * is returned in the CSS color format. */ inABGRFormat?: boolean ): sap.ui.core.CSSColor | sap.ui.core.CSSColor[] | int | int[]; /** * Gets the decomposed node local transformation matrix. * * * @returns object that contains `translation`, `scale` and `quaternion` components. */ getTransformation( /** * The node reference. */ nodeRef: any | any[] ): any | any[]; /** * Gets the node transformation translation component. * * * @returns vector A translation component of node's transformation matrix. */ getTranslation( /** * The node reference. */ nodeRef: any ): float[] | float[][]; /** * ID of the element which is the current target of the association {@link #getViewManager viewManager}, * or `null`. */ getViewManager(): sap.ui.core.ID | null; /** * Gets the visibility changes in the current ViewStateManagerBase object. * * * @returns The visibility changes are in the form of an array. The array is a list of node VE ids which * suffered a visibility changed relative to the default state. */ getVisibilityChanges(): string[]; /** * Gets the visibility state of nodes. * * If a single node reference is passed to the method then a single visibility state is returned. * If an array of node references is passed to the method then an array of visibility states is returned. * * * @returns A single value or an array of values where the value is `true` if the node is visible, `false` * otherwise. */ getVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[] ): boolean | boolean[]; /** * Resets the visibility states of all nodes to the initial states. * * * @returns `this` to allow method chaining. */ resetVisibility(): this; /** * Replace node's current transformation with its rest transformation stored in active view.. * * * @returns `this` to allow method chaining. */ restoreRestTransformation( /** * The node reference. */ nodeRef: any ): this; /** * 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: sap.ui.core.ID | sap.ui.vk.ContentConnector ): this; /** * Sets a new value for property {@link #getFeatures features}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * * @returns Reference to `this` in order to allow method chaining */ setFeatures( /** * New value for property `features` */ sFeatures?: string[] ): this; /** * Set highlight display state. * * * @returns `this` to allow method chaining. */ setHighlightDisplayState( /** * for playing highlight - playing, pausing, and stopped */ state: /* was: sap.ui.vk.HighlightDisplayState */ any ): this; /** * Sets the opacity of the nodes. * * * @returns `this` to allow method chaining. */ setOpacity( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new opacity of the nodes. If `null` is passed then the opacity is reset and the node's own opacity * should be used. */ opacity: float | null, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the outline color * * * @returns `this` to allow method chaining. */ setOutlineColor( /** * The new outline color. The value can be defined as a string in the CSS color format or as an integer * in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint color should * be used. */ color: sap.ui.core.CSSColor | string | int ): this; /** * Sets the outline width * * * @returns `this` to allow method chaining. */ setOutlineWidth( /** * width of outline */ width: float ): this; /** * Sets or resets the outlining state of the nodes. * * * @returns `this` to allow method chaining. */ setOutliningStates( /** * The node reference or the array of node references of outlined nodes. */ outlinedNodeRefs: any | any[], /** * The node reference or the array of node references of unoutlined nodes. */ unoutlinedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress outlineChanged event. */ blockNotification: boolean ): this; /** * Sets a new value for property {@link #getRecursiveOutlining recursiveOutlining}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setRecursiveOutlining( /** * New value for property `recursiveOutlining` */ bRecursiveOutlining?: boolean ): this; /** * Sets a new value for property {@link #getRecursiveSelection recursiveSelection}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setRecursiveSelection( /** * New value for property `recursiveSelection` */ bRecursiveSelection?: boolean ): this; /** * Sets the `selectable` property of the nodes. * * ***Selectable*** nodes can be selected in the viewport by mouse click or by using a selection tool. This * property does not affect rendering. * * By default nodes are ***selectable***. * * If a grouping node is ***unselectable*** then all its descendant nodes are ***unselectable*** too. If * a grouping node is ***selectable*** then its descendants can be either ***selectable*** or ***unselectable*** * based on their `selectable` property. * * @since 1.111.0 * * @returns `this` to allow method chaining. */ setSelectable( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new value of the `selectable` property. If `null` is passed then the `selectable` property is reset * and the value of the node's own `selectable` property is in use. */ selectable: boolean | null ): this; /** * Sets the selection state of the nodes. * * @deprecated As of version 1.56.3. Use {@link sap.ui.vk.ViewStateManagerBase#setSelectionStates} instead. * * @returns `this` to allow method chaining. */ setSelectionState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new selection state of the nodes. */ selected: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets or resets the selection state of the nodes. * * * @returns `this` to allow method chaining. */ setSelectionStates( /** * The node reference or the array of node references of selected nodes. */ selectedNodeRefs: any | any[], /** * The node reference or the array of node references of unselected nodes. */ unselectedNodeRefs: any | any[], /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * The flag to suppress selectionChanged event. */ blockNotification: boolean ): this; /** * Sets a new value for property {@link #getShouldTrackVisibilityChanges shouldTrackVisibilityChanges}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShouldTrackVisibilityChanges( /** * New value for property `shouldTrackVisibilityChanges` */ bShouldTrackVisibilityChanges?: boolean ): this; /** * Sets the tint color of the nodes. * * * @returns `this` to allow method chaining. */ setTintColor( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an * integer in the ABGR format. If `null` is passed then the tint color is reset and the node's own tint * color should be used. */ tintColor: sap.ui.core.CSSColor | int | null, /** * This flag indicates if the change needs to propagate recursively to child nodes. */ recursive?: boolean ): this; /** * Sets the node transformation components. * * * @returns `this` to allow method chaining. */ setTransformation( /** * The node reference. */ nodeRef: any | any[], /** * Node's transformation matrix or it components or array of such. Each object should contain one transform * matrix or exactly one of angleAxis, euler or quaternion components. */ transformations: any | any[] ): this; /** * Sets the associated {@link #getViewManager viewManager}. * * * @returns Reference to `this` in order to allow method chaining */ setViewManager( /** * ID of an element which becomes the new target of this viewManager association; alternatively, an element * instance may be given */ oViewManager: sap.ui.core.ID | sap.ui.vk.ViewManager ): this; /** * Sets the visibility state of the nodes. * * * @returns `this` to allow method chaining. */ setVisibilityState( /** * The node reference or the array of node references. */ nodeRefs: any | any[], /** * The new visibility state of the nodes. */ visible: boolean, /** * The flags indicates if the change needs to propagate recursively to child nodes. */ recursive: boolean, /** * If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag * will force node to be visible regardless of parent's state. */ force: boolean ): this; /** * Copy node's current transformation into its rest transformation stored in active view. * * * @returns `this` to allow method chaining. */ updateRestTransformation( /** * The node reference. */ nodeRef: any, /** * Do not trigger the sequence changed event in case other node references are not updated. */ doNotFireSequenceChanged: boolean ): this; } /** * Sets the animation style type for annotation text. */ enum AnnotationStyle { /** * Style 1 */ Default = "Default", /** * Style 5 */ Expand = "Expand", /** * Style 2 */ Explode = "Explode", /** * Style 4 */ Random = "Random", /** * Style 3 */ Square = "Square", } /** * Camera field of view binding types. */ enum CameraFOVBindingType { /** * The field of view is bound to the width of the viewport. */ Horizontal = "horizontal", /** * The field of view is bound to the width or the height of the viewport, whichever is bigger. */ Maximum = "maximum", /** * The field of view is bound to the width or the height of the viewport, whichever is smaller. */ Minimum = "minimum", /** * The field of view is bound to the height of the viewport. */ Vertical = "vertical", } /** * Camera projection type. */ enum CameraProjectionType { /** * {@link https://en.wikipedia.org/wiki/3D_projection#Orthographic_projection Orthographic projection} */ Orthographic = "orthographic", /** * {@link https://en.wikipedia.org/wiki/3D_projection#Perspective_projection Perspective projection} */ Perspective = "perspective", } /** * Button identifiers for {@link sap.ui.vk.DrawerToolbar}. */ enum DrawerToolbarButton { CrossSection = "VIT-Cross-Section", CrossSectionSeparator = "VIT-Cross-Section-Separator", CrossSectionSettings = "VIT-Cross-Section-Settings", EcadSeparator = "VIT-ECAD-Separator", FitToPage = "VIT-Fit-To-Page", FitToView = "VIT-Fit-To-View", FitToViewSeparator = "VIT-Fit-To-View-Separator", FitToWidth = "VIT-Fit-To-Width", Flip = "VIT-Flip", FullScreen = "VIT-Fullscreen", GestureButtonsSeparator = "VIT-Gesture-Buttons-Separator", Hide = "VIT-Hide", Measurements = "VIT-Measurements", MeasurementsSeparator = "VIT-Measurements-Separator", Orbit = "VIT-Orbit", PageNavigation = "VIT-Page-Navigation", PageNavigationSeparator = "VIT-Page-Navigation-Separator", Pan = "VIT-Pan", PMI = "VIT-PMI", PMISeparator = "VIT-PMI-Separator", PredefinedViews = "VIT-Predefined-Views", PredefinedViewsSeparator = "VIT-Predefined-Views-Separator", RectangularSelection = "VIT-Rectangular-Selection", RectangularSelectionSeparator = "VIT-Rectangular-Selection-Separator", RotateCCW = "VIT-Rotate-CCW", RotateCW = "VIT-Rotate-CW", Show = "VIT-Show", ShowHideSeparator = "VIT-Show-Hide-Separator", Turntable = "VIT-Turntable", Zoom = "VIT-Zoom", ZoomIn = "VIT-Zoom-In", ZoomOut = "VIT-Zoom-Out", } /** * Types of custom buttons supported on the MapContainer toolbar * * @deprecated As of version 1.120.2. This object is moved to sap.ui.vbm namespace, see {@link sap.ui.vbm.MapContainerButtonType} */ enum MapContainerButtonType { Click = "Click", Toggle = "Toggle", } /** * Navigation mode */ enum NavigationMode { /** * Navigation mode stays the same. */ NoChange = "NoChange", /** * The orbit navigation mode. */ Orbit = "Orbit", /** * The pan navigation mode. */ Pan = "Pan", /** * The turntable navigation mode. */ Turntable = "Turntable", /** * The zoom navigation mode. */ Zoom = "Zoom", } /** * Node content type for {@link sap.ui.vk.NodeHierarchy.createNode}. */ enum NodeContentType { /** * Annotation node */ Annotation = "Annotation", /** * Background node */ Background = "Background", /** * Dynamic content node */ DynamicContent = "DynamicContent", /** * Hotspot node */ Hotspot = "Hotspot", /** * PMI node */ PMI = "PMI", /** * Point cloud group node */ PointCloudGroup = "PointCloudGroup", /** * Reference node */ Reference = "Reference", /** * Regular node */ Regular = "Regular", /** * Svg image node */ SvgImage = "SvgImage", /** * Symbol node */ Symbol = "Symbol", } /** * Object type */ enum ObjectType { DynamicContent = "2", Hotspot = "1", PMI = "0", } /** * Render mode for {@link sap.ui.vk.Viewport}. */ enum RenderMode { /** * The default render mode. */ Default = "Default", /** * The line illustration render mode. */ LineIllustration = "LineIllustration", /** * The shaded illustration render mode. */ ShadedIllustration = "ShadedIllustration", /** * The solid outline render mode. */ SolidOutline = "SolidOutline", /** * The XRay render mode. */ XRay = "XRay", } /** * Selection display options. */ enum SelectionDisplayMode { Highlight = "Highlight", Outline = "Outline", } /** * SelectionMode options. */ enum SelectionMode { Exclusive = "exclusive", None = "none", Sticky = "sticky", } /** * ZoomTo options. */ enum ZoomTo { All = "all", Node = "node", NodeSetIsolation = "node_setisolation", Restore = "restore", RestoreRemoveIsolation = "restore_removeisolation", Selected = "selected", ViewBack = "view_back", ViewBottom = "view_bottom", ViewFront = "view_front", ViewLeft = "view_left", ViewRight = "view_right", ViewTop = "view_top", Visible = "visible", } /** * Event object of the AnimationPlayer#beforeTimeChanged event. */ type AnimationPlayer$BeforeTimeChangedEvent = sap.ui.base.Event< AnimationPlayer$BeforeTimeChangedEventParameters, AnimationPlayer >; /** * Event object of the AnimationPlayer#stateChanged event. */ type AnimationPlayer$StateChangedEvent = sap.ui.base.Event< AnimationPlayer$StateChangedEventParameters, AnimationPlayer >; /** * Event object of the AnimationPlayer#timeChanged event. */ type AnimationPlayer$TimeChangedEvent = sap.ui.base.Event< AnimationPlayer$TimeChangedEventParameters, AnimationPlayer >; /** * Event object of the AnimationPlayer#viewActivated event. */ type AnimationPlayer$ViewActivatedEvent = sap.ui.base.Event< AnimationPlayer$ViewActivatedEventParameters, AnimationPlayer >; /** * Event object of the ContainerBase#contentChange event. */ type ContainerBase$ContentChangeEvent = sap.ui.base.Event< ContainerBase$ContentChangeEventParameters, ContainerBase >; /** * Event object of the ContainerBase#settingsPressed event. */ type ContainerBase$SettingsPressedEvent = sap.ui.base.Event< ContainerBase$SettingsPressedEventParameters, ContainerBase >; /** * Event object of the ContentConnector#contentChangesFinished event. */ type ContentConnector$ContentChangesFinishedEvent = sap.ui.base.Event< ContentConnector$ContentChangesFinishedEventParameters, ContentConnector >; /** * Event object of the ContentConnector#contentChangesProgress event. */ type ContentConnector$ContentChangesProgressEvent = sap.ui.base.Event< ContentConnector$ContentChangesProgressEventParameters, ContentConnector >; /** * Event object of the ContentConnector#contentChangesStarted event. */ type ContentConnector$ContentChangesStartedEvent = sap.ui.base.Event< ContentConnector$ContentChangesStartedEventParameters, ContentConnector >; /** * Event object of the ContentConnector#contentDestroying event. */ type ContentConnector$ContentDestroyingEvent = sap.ui.base.Event< ContentConnector$ContentDestroyingEventParameters, ContentConnector >; /** * Event object of the ContentConnector#contentLoadingFinished event. */ type ContentConnector$ContentLoadingFinishedEvent = sap.ui.base.Event< ContentConnector$ContentLoadingFinishedEventParameters, ContentConnector >; /** * Event object of the ContentConnector#contentReplaced event. */ type ContentConnector$ContentReplacedEvent = sap.ui.base.Event< ContentConnector$ContentReplacedEventParameters, ContentConnector >; /** * Event object of the ContentManager#contentChangesFinished event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ContentManager$ContentChangesFinishedEvent = sap.ui.base.Event< ContentManager$ContentChangesFinishedEventParameters, ContentManager >; /** * Event object of the ContentManager#contentChangesProgress event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ContentManager$ContentChangesProgressEvent = sap.ui.base.Event< ContentManager$ContentChangesProgressEventParameters, ContentManager >; /** * Event object of the ContentManager#contentChangesStarted event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ContentManager$ContentChangesStartedEvent = sap.ui.base.Event< ContentManager$ContentChangesStartedEventParameters, ContentManager >; /** * Event object of the ContentManager#contentLoadingFinished event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ContentManager$ContentLoadingFinishedEvent = sap.ui.base.Event< ContentManager$ContentLoadingFinishedEventParameters, ContentManager >; /** * Event object of the DrawerToolbar#expanded event. */ type DrawerToolbar$ExpandedEvent = sap.ui.base.Event< DrawerToolbar$ExpandedEventParameters, DrawerToolbar >; /** * Event object of the ListPanel#expand event. */ type ListPanel$ExpandEvent = sap.ui.base.Event< ListPanel$ExpandEventParameters, ListPanel >; /** * Event object of the ListPanel#headerIconPress event. */ type ListPanel$HeaderIconPressEvent = sap.ui.base.Event< ListPanel$HeaderIconPressEventParameters, ListPanel >; /** * Event object of the ListPanel#itemPress event. */ type ListPanel$ItemPressEvent = sap.ui.base.Event< ListPanel$ItemPressEventParameters, ListPanel >; /** * Event object of the ListPanel#selectionChange event. */ type ListPanel$SelectionChangeEvent = sap.ui.base.Event< ListPanel$SelectionChangeEventParameters, ListPanel >; /** * Event object of the NativeViewport#move event. */ type NativeViewport$MoveEvent = sap.ui.base.Event< NativeViewport$MoveEventParameters, NativeViewport >; /** * Event object of the NativeViewport#resize event. */ type NativeViewport$ResizeEvent = sap.ui.base.Event< NativeViewport$ResizeEventParameters, NativeViewport >; /** * Event object of the NodeHierarchy#changed event. */ type NodeHierarchy$ChangedEvent = sap.ui.base.Event< NodeHierarchy$ChangedEventParameters, NodeHierarchy >; /** * Event object of the NodeHierarchy#nodeCreated event. */ type NodeHierarchy$NodeCreatedEvent = sap.ui.base.Event< NodeHierarchy$NodeCreatedEventParameters, NodeHierarchy >; /** * Event object of the NodeHierarchy#nodeRemoving event. */ type NodeHierarchy$NodeRemovingEvent = sap.ui.base.Event< NodeHierarchy$NodeRemovingEventParameters, NodeHierarchy >; /** * Event object of the NodeHierarchy#nodeReplaced event. */ type NodeHierarchy$NodeReplacedEvent = sap.ui.base.Event< NodeHierarchy$NodeReplacedEventParameters, NodeHierarchy >; /** * Event object of the NodeHierarchy#nodeUpdated event. */ type NodeHierarchy$NodeUpdatedEvent = sap.ui.base.Event< NodeHierarchy$NodeUpdatedEventParameters, NodeHierarchy >; /** * Event object of the Notifications#allMessagesCleared event. */ type Notifications$AllMessagesClearedEvent = sap.ui.base.Event< Notifications$AllMessagesClearedEventParameters, Notifications >; /** * Event object of the Notifications#messageAdded event. */ type Notifications$MessageAddedEvent = sap.ui.base.Event< Notifications$MessageAddedEventParameters, Notifications >; /** * Event object of the Overlay#click event. */ type Overlay$ClickEvent = sap.ui.base.Event< Overlay$ClickEventParameters, Overlay >; /** * Event object of the Overlay#contextMenu event. */ type Overlay$ContextMenuEvent = sap.ui.base.Event< Overlay$ContextMenuEventParameters, Overlay >; /** * Event object of the OverlayArea#click event. */ type OverlayArea$ClickEvent = sap.ui.base.Event< OverlayArea$ClickEventParameters, OverlayArea >; /** * Event object of the OverlayArea#contextMenu event. */ type OverlayArea$ContextMenuEvent = sap.ui.base.Event< OverlayArea$ContextMenuEventParameters, OverlayArea >; /** * Event object of the OverlayArea#edgeClick event. */ type OverlayArea$EdgeClickEvent = sap.ui.base.Event< OverlayArea$EdgeClickEventParameters, OverlayArea >; /** * Event object of the OverlayArea#edgeContextMenu event. */ type OverlayArea$EdgeContextMenuEvent = sap.ui.base.Event< OverlayArea$EdgeContextMenuEventParameters, OverlayArea >; /** * Event object of the OverlayArea#handleClick event. */ type OverlayArea$HandleClickEvent = sap.ui.base.Event< OverlayArea$HandleClickEventParameters, OverlayArea >; /** * Event object of the OverlayArea#handleContextMenu event. */ type OverlayArea$HandleContextMenuEvent = sap.ui.base.Event< OverlayArea$HandleContextMenuEventParameters, OverlayArea >; /** * Event object of the OverlayArea#handleMoved event. */ type OverlayArea$HandleMovedEvent = sap.ui.base.Event< OverlayArea$HandleMovedEventParameters, OverlayArea >; /** * Event object of the RedlineCollaboration#conversationActivated event. */ type RedlineCollaboration$ConversationActivatedEvent = sap.ui.base.Event< RedlineCollaboration$ConversationActivatedEventParameters, RedlineCollaboration >; /** * Event object of the RedlineCollaboration#conversationActivating event. */ type RedlineCollaboration$ConversationActivatingEvent = sap.ui.base.Event< RedlineCollaboration$ConversationActivatingEventParameters, RedlineCollaboration >; /** * Event object of the RedlineCollaboration#elementClicked event. */ type RedlineCollaboration$ElementClickedEvent = sap.ui.base.Event< RedlineCollaboration$ElementClickedEventParameters, RedlineCollaboration >; /** * Event object of the RedlineCollaboration#elementCreated event. */ type RedlineCollaboration$ElementCreatedEvent = sap.ui.base.Event< RedlineCollaboration$ElementCreatedEventParameters, RedlineCollaboration >; /** * Event object of the RedlineCollaboration#elementHovered event. */ type RedlineCollaboration$ElementHoveredEvent = sap.ui.base.Event< RedlineCollaboration$ElementHoveredEventParameters, RedlineCollaboration >; /** * Event object of the RedlineDesign#elementCreated event. */ type RedlineDesign$ElementCreatedEvent = sap.ui.base.Event< RedlineDesign$ElementCreatedEventParameters, RedlineDesign >; /** * Event object of the RedlineSurface#pan event. */ type RedlineSurface$PanEvent = sap.ui.base.Event< RedlineSurface$PanEventParameters, RedlineSurface >; /** * Event object of the RedlineSurface#zoom event. */ type RedlineSurface$ZoomEvent = sap.ui.base.Event< RedlineSurface$ZoomEventParameters, RedlineSurface >; /** * Event object of the SceneTree#contentChanged event. */ type SceneTree$ContentChangedEvent = sap.ui.base.Event< SceneTree$ContentChangedEventParameters, SceneTree >; /** * Event object of the StepNavigation#resize event. */ type StepNavigation$ResizeEvent = sap.ui.base.Event< StepNavigation$ResizeEventParameters, StepNavigation >; /** * Event object of the StepNavigation#stepChanged event. */ type StepNavigation$StepChangedEvent = sap.ui.base.Event< StepNavigation$StepChangedEventParameters, StepNavigation >; /** * Event object of the ToggleMenuButton#beforeMenuOpen event. */ type ToggleMenuButton$BeforeMenuOpenEvent = sap.ui.base.Event< ToggleMenuButton$BeforeMenuOpenEventParameters, ToggleMenuButton >; /** * Event object of the ToggleMenuButton#itemSelected event. */ type ToggleMenuButton$ItemSelectedEvent = sap.ui.base.Event< ToggleMenuButton$ItemSelectedEventParameters, ToggleMenuButton >; /** * Event object of the ToggleMenuButton#itemToggled event. */ type ToggleMenuButton$ItemToggledEvent = sap.ui.base.Event< ToggleMenuButton$ItemToggledEventParameters, ToggleMenuButton >; /** * Event object of the Viewer#contentResourceChangesProcessed event. */ type Viewer$ContentResourceChangesProcessedEvent = sap.ui.base.Event< Viewer$ContentResourceChangesProcessedEventParameters, Viewer >; /** * Event object of the Viewer#fullScreen event. */ type Viewer$FullScreenEvent = sap.ui.base.Event< Viewer$FullScreenEventParameters, Viewer >; /** * Event object of the Viewer#nodeClicked event. */ type Viewer$NodeClickedEvent = sap.ui.base.Event< Viewer$NodeClickedEventParameters, Viewer >; /** * Event object of the Viewer#sceneDestroying event. */ type Viewer$SceneDestroyingEvent = sap.ui.base.Event< Viewer$SceneDestroyingEventParameters, Viewer >; /** * Event object of the Viewer#sceneLoadingFailed event. */ type Viewer$SceneLoadingFailedEvent = sap.ui.base.Event< Viewer$SceneLoadingFailedEventParameters, Viewer >; /** * Event object of the Viewer#sceneLoadingSucceeded event. */ type Viewer$SceneLoadingSucceededEvent = sap.ui.base.Event< Viewer$SceneLoadingSucceededEventParameters, Viewer >; /** * Event object of the Viewer#selectionChanged event. */ type Viewer$SelectionChangedEvent = sap.ui.base.Event< Viewer$SelectionChangedEventParameters, Viewer >; /** * Event object of the Viewer#urlClicked event. */ type Viewer$UrlClickedEvent = sap.ui.base.Event< Viewer$UrlClickedEventParameters, Viewer >; /** * Event object of the ViewGallery#selectionChange event. */ type ViewGallery$SelectionChangeEvent = sap.ui.base.Event< ViewGallery$SelectionChangeEventParameters, ViewGallery >; /** * Event object of the ViewGallery#viewOrderChange event. */ type ViewGallery$ViewOrderChangeEvent = sap.ui.base.Event< ViewGallery$ViewOrderChangeEventParameters, ViewGallery >; /** * Event object of the ViewportBase#nodeClicked event. */ type ViewportBase$NodeClickedEvent = sap.ui.base.Event< ViewportBase$NodeClickedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#nodesPicked event. */ type ViewportBase$NodesPickedEvent = sap.ui.base.Event< ViewportBase$NodesPickedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#nodeZoomed event. */ type ViewportBase$NodeZoomedEvent = sap.ui.base.Event< ViewportBase$NodeZoomedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#procedureFinished event. */ type ViewportBase$ProcedureFinishedEvent = sap.ui.base.Event< ViewportBase$ProcedureFinishedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#resize event. */ type ViewportBase$ResizeEvent = sap.ui.base.Event< ViewportBase$ResizeEventParameters, ViewportBase >; /** * Event object of the ViewportBase#urlClicked event. */ type ViewportBase$UrlClickedEvent = sap.ui.base.Event< ViewportBase$UrlClickedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#viewActivated event. */ type ViewportBase$ViewActivatedEvent = sap.ui.base.Event< ViewportBase$ViewActivatedEventParameters, ViewportBase >; /** * Event object of the ViewportBase#viewFinished event. */ type ViewportBase$ViewFinishedEvent = sap.ui.base.Event< ViewportBase$ViewFinishedEventParameters, ViewportBase >; /** * Event object of the ViewStateManagerBase#highlightColorChanged event. */ type ViewStateManagerBase$HighlightColorChangedEvent = sap.ui.base.Event< ViewStateManagerBase$HighlightColorChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#nodeHierarchyReplaced event. */ type ViewStateManagerBase$NodeHierarchyReplacedEvent = sap.ui.base.Event< ViewStateManagerBase$NodeHierarchyReplacedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#opacityChanged event. */ type ViewStateManagerBase$OpacityChangedEvent = sap.ui.base.Event< ViewStateManagerBase$OpacityChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#outlineColorChanged event. */ type ViewStateManagerBase$OutlineColorChangedEvent = sap.ui.base.Event< ViewStateManagerBase$OutlineColorChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#outlineWidthChanged event. */ type ViewStateManagerBase$OutlineWidthChangedEvent = sap.ui.base.Event< ViewStateManagerBase$OutlineWidthChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#outliningChanged event. */ type ViewStateManagerBase$OutliningChangedEvent = sap.ui.base.Event< ViewStateManagerBase$OutliningChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#readyForAnimation event. */ type ViewStateManagerBase$ReadyForAnimationEvent = sap.ui.base.Event< ViewStateManagerBase$ReadyForAnimationEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#selectionChanged event. */ type ViewStateManagerBase$SelectionChangedEvent = sap.ui.base.Event< ViewStateManagerBase$SelectionChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#tintColorChanged event. */ type ViewStateManagerBase$TintColorChangedEvent = sap.ui.base.Event< ViewStateManagerBase$TintColorChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#transformationChanged event. */ type ViewStateManagerBase$TransformationChangedEvent = sap.ui.base.Event< ViewStateManagerBase$TransformationChangedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#viewStateApplied event. */ type ViewStateManagerBase$ViewStateAppliedEvent = sap.ui.base.Event< ViewStateManagerBase$ViewStateAppliedEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#viewStateApplying event. */ type ViewStateManagerBase$ViewStateApplyingEvent = sap.ui.base.Event< ViewStateManagerBase$ViewStateApplyingEventParameters, ViewStateManagerBase >; /** * Event object of the ViewStateManagerBase#visibilityChanged event. */ type ViewStateManagerBase$VisibilityChangedEvent = sap.ui.base.Event< ViewStateManagerBase$VisibilityChangedEventParameters, ViewStateManagerBase >; } } interface IUI5DefineDependencyNames { "sap/ui/vk/AnimationPlayer": undefined; "sap/ui/vk/Annotation": undefined; "sap/ui/vk/AnnotationStyle": undefined; "sap/ui/vk/BaseNodeProxy": undefined; "sap/ui/vk/Camera": undefined; "sap/ui/vk/CameraFOVBindingType": undefined; "sap/ui/vk/CameraProjectionType": undefined; "sap/ui/vk/ContainerBase": undefined; "sap/ui/vk/ContainerContent": undefined; "sap/ui/vk/ContentConnector": undefined; "sap/ui/vk/ContentManager": undefined; "sap/ui/vk/ContentResource": undefined; "sap/ui/vk/ContentResourceSourceCategory": undefined; "sap/ui/vk/DrawerToolbar": undefined; "sap/ui/vk/DrawerToolbarButton": undefined; "sap/ui/vk/dvl/BaseNodeProxy": undefined; "sap/ui/vk/dvl/ContentManager": undefined; "sap/ui/vk/dvl/GraphicsCore": undefined; "sap/ui/vk/dvl/GraphicsCoreApi": undefined; "sap/ui/vk/dvl/LayerProxy": undefined; "sap/ui/vk/dvl/NodeHierarchy": undefined; "sap/ui/vk/dvl/NodeProxy": undefined; "sap/ui/vk/dvl/Scene": undefined; "sap/ui/vk/dvl/Viewport": undefined; "sap/ui/vk/dvl/ViewStateManager": undefined; "sap/ui/vk/ecad/ElementsPanel": undefined; "sap/ui/vk/ecad/LayersPanel": undefined; "sap/ui/vk/FlexibleControl": undefined; "sap/ui/vk/FlexibleControlLayoutData": undefined; "sap/ui/vk/ImageContentManager": undefined; "sap/ui/vk/IncludeUsageIdType": undefined; "sap/ui/vk/LayerProxy": undefined; "sap/ui/vk/LegendItem": undefined; "sap/ui/vk/library": undefined; "sap/ui/vk/ListPanel": undefined; "sap/ui/vk/ListPanelStack": undefined; "sap/ui/vk/Loco": undefined; "sap/ui/vk/MapContainer": undefined; "sap/ui/vk/MapContainerButtonType": undefined; "sap/ui/vk/Material": undefined; "sap/ui/vk/NativeViewport": undefined; "sap/ui/vk/NavigationMode": undefined; "sap/ui/vk/NodeContentType": undefined; "sap/ui/vk/NodeHierarchy": undefined; "sap/ui/vk/NodeProxy": undefined; "sap/ui/vk/Notifications": undefined; "sap/ui/vk/ObjectType": undefined; "sap/ui/vk/OrthographicCamera": undefined; "sap/ui/vk/OutputSettings": undefined; "sap/ui/vk/Overlay": undefined; "sap/ui/vk/OverlayArea": undefined; "sap/ui/vk/pdf/Viewport": undefined; "sap/ui/vk/PerspectiveCamera": undefined; "sap/ui/vk/ProgressIndicator": undefined; "sap/ui/vk/RedlineCollaboration": undefined; "sap/ui/vk/RedlineConversation": undefined; "sap/ui/vk/RedlineDesign": undefined; "sap/ui/vk/RedlineElement": undefined; "sap/ui/vk/RedlineElementComment": undefined; "sap/ui/vk/RedlineElementEllipse": undefined; "sap/ui/vk/RedlineElementFreehand": undefined; "sap/ui/vk/RedlineElementLine": undefined; "sap/ui/vk/RedlineElementRectangle": undefined; "sap/ui/vk/RedlineElementText": undefined; "sap/ui/vk/RedlineSurface": undefined; "sap/ui/vk/RenderMode": undefined; "sap/ui/vk/SafeArea": undefined; "sap/ui/vk/Scene": undefined; "sap/ui/vk/SceneTree": undefined; "sap/ui/vk/SelectionDisplayMode": undefined; "sap/ui/vk/SelectionMode": undefined; "sap/ui/vk/StepNavigation": undefined; "sap/ui/vk/svg/BaseNodeProxy": undefined; "sap/ui/vk/svg/ContentManager": undefined; "sap/ui/vk/svg/NodeHierarchy": undefined; "sap/ui/vk/svg/NodeProxy": undefined; "sap/ui/vk/svg/OrthographicCamera": undefined; "sap/ui/vk/svg/Scene": undefined; "sap/ui/vk/svg/Viewport": undefined; "sap/ui/vk/svg/ViewStateManager": undefined; "sap/ui/vk/Texture": undefined; "sap/ui/vk/threejs/BaseNodeProxy": undefined; "sap/ui/vk/threejs/ContentManager": undefined; "sap/ui/vk/threejs/Material": undefined; "sap/ui/vk/threejs/MaterialType": undefined; "sap/ui/vk/threejs/NodeHierarchy": undefined; "sap/ui/vk/threejs/NodeProxy": undefined; "sap/ui/vk/threejs/OrthographicCamera": undefined; "sap/ui/vk/threejs/PerspectiveCamera": undefined; "sap/ui/vk/threejs/Scene": undefined; "sap/ui/vk/threejs/Texture": undefined; "sap/ui/vk/threejs/Viewport": undefined; "sap/ui/vk/threejs/ViewStateManager": undefined; "sap/ui/vk/ToggleMenuButton": undefined; "sap/ui/vk/Toolbar": undefined; "sap/ui/vk/tools/AnchorPointTool": undefined; "sap/ui/vk/tools/AnchorPointToolOperation": undefined; "sap/ui/vk/tools/AxisAngleRotationTool": undefined; "sap/ui/vk/tools/CoordinateSystem": undefined; "sap/ui/vk/tools/CreateEllipseTool": undefined; "sap/ui/vk/tools/CreatePathTool": undefined; "sap/ui/vk/tools/CreateRectangleTool": undefined; "sap/ui/vk/tools/CreateTextTool": undefined; "sap/ui/vk/tools/CrossSectionTool": undefined; "sap/ui/vk/tools/DuplicateSvgElementTool": undefined; "sap/ui/vk/tools/ExplodeAxis": undefined; "sap/ui/vk/tools/ExplodeDirection": undefined; "sap/ui/vk/tools/ExplodeItemGroup": undefined; "sap/ui/vk/tools/ExplodeTool": undefined; "sap/ui/vk/tools/ExplodeType": undefined; "sap/ui/vk/tools/Gizmo": undefined; "sap/ui/vk/tools/GizmoPlacementMode": undefined; "sap/ui/vk/tools/HitTestClickType": undefined; "sap/ui/vk/tools/HitTestIdMode": undefined; "sap/ui/vk/tools/HitTestTool": undefined; "sap/ui/vk/tools/MoveTool": undefined; "sap/ui/vk/tools/PointCloudSelectionTool": undefined; "sap/ui/vk/tools/PredefinedView": undefined; "sap/ui/vk/tools/RectSelectTool": undefined; "sap/ui/vk/tools/RedlineTool": undefined; "sap/ui/vk/tools/RotatableAxis": undefined; "sap/ui/vk/tools/RotateOrbitTool": undefined; "sap/ui/vk/tools/RotateTool": undefined; "sap/ui/vk/tools/RotateTurntableTool": undefined; "sap/ui/vk/tools/ScaleTool": undefined; "sap/ui/vk/tools/SceneOrientationTool": undefined; "sap/ui/vk/tools/Tool": undefined; "sap/ui/vk/tools/ToolNodeSet": undefined; "sap/ui/vk/tools/TooltipTool": undefined; "sap/ui/vk/tools/TransformSvgElementTool": undefined; "sap/ui/vk/TransformationMatrix": undefined; "sap/ui/vk/View": undefined; "sap/ui/vk/Viewer": undefined; "sap/ui/vk/ViewGallery": undefined; "sap/ui/vk/ViewGroup": undefined; "sap/ui/vk/ViewManager": undefined; "sap/ui/vk/Viewport": undefined; "sap/ui/vk/ViewportBase": undefined; "sap/ui/vk/ViewStateManager": undefined; "sap/ui/vk/ViewStateManagerBase": undefined; "sap/ui/vk/ZoomTo": undefined; } }