Merge pull request #1557 from xeokit/fix-types-for-measurement-plugins

[FIX] Fix types for measurement plugin events]
xeokit · Jun 27, 2024 · c37afb8 · c37afb8
2 parents 42855b5 + e096545
commit c37afb8
Show file tree

Hide file tree

Showing 2 changed files with 162 additions and 1 deletion.
diff --git a/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.d.ts b/types/plugins/AngleMeasurementsPlugin/AngleMeasurementsPlugin.d.ts
@@ -17,6 +17,58 @@ export declare type AngleMeasurementsPluginConfiguration = {
   zIndex?: number;
 };
 
+/**
+ * Event fire by {@link AngleMeasurementsPlugin} when mouse enters over an {@link AngleMeasurement}.
+ */
+export declare type AngleMeasurementMouseOverEvent = {
+
+    /**
+     * The plugin.
+     */
+    plugin: AngleMeasurementsPlugin;
+
+    /**
+     * The measurement.
+     */
+    angleMeasurement: AngleMeasurement;
+
+    /**
+     * The measurement.
+     */
+    measurement: AngleMeasurement;
+
+    /**
+     * The original mouse event.
+     */
+    event: MouseEvent;
+}
+
+/**
+ * Event fire by {@link AngleMeasurementsPlugin} when mouse leaves an {@link AngleMeasurement}.
+ */
+export declare type AngleMeasurementMouseLeaveEvent = {
+
+    /**
+     * The plugin.
+     */
+    plugin: AngleMeasurementsPlugin;
+
+    /**
+     * The measurement.
+     */
+    angleMeasurement: AngleMeasurement;
+
+    /**
+     * The measurement.
+     */
+    measurement: AngleMeasurement;
+
+    /**
+     * The original mouse event.
+     */
+    event: MouseEvent;
+}
+
 /**
  * {@link Viewer} plugin for measuring angles.
  */
@@ -87,7 +139,35 @@ export declare class AngleMeasurementsPlugin extends Plugin {
    */
   clear(): void;
 
-  /**
+    /**
+     * Fires when mouse is over a measurement.
+     * @param {String} event The mouseOver event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "mouseOver", callback: (event: AngleMeasurementMouseOverEvent)=> void): string;
+
+    /**
+     * Fires when mouse leaves a measurement.
+     * @param {String} event The mouseLeave event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "mouseLeave", callback: (event: AngleMeasurementMouseLeaveEvent)=> void): string;
+
+    /**
+     * Fires when a context menu is to be opened on a measurement.
+     * @param {String} event The contextMenu event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "contextMenu", callback: (measurement: AngleMeasurement)=> void): string;
+
+    /**
+     * Fires when a measurement is completed.
+     * @param {String} event The measurementEnd event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "measurementStart", callback: (measurement: AngleMeasurement)=> void): string;
+
+    /**
    * Fires when a measurement is created.
    * @param {String} event The measurementCreated event
    * @param {Function} callback Callback fired on the event

diff --git a/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts b/types/plugins/DistanceMeasurementsPlugin/DistanceMeasurementsPlugin.d.ts
@@ -38,6 +38,59 @@ export declare type DistanceMeasurementsPluginConfiguration = {
   zIndex?: number;
 };
 
+
+/**
+ * Event fire by {@link DistanceMeasurementsPlugin} when mouse enters over a {@link DistanceMeasurement}.
+ */
+export declare type DistanceMeasurementMouseOverEvent = {
+
+    /**
+     * The plugin.
+     */
+    plugin: DistanceMeasurementsPlugin;
+
+    /**
+     * The measurement.
+     */
+    angleMeasurement: DistanceMeasurement;
+
+    /**
+     * The measurement.
+     */
+    measurement: DistanceMeasurement;
+
+    /**
+     * The original mouse event.
+     */
+    event: MouseEvent;
+}
+
+/**
+ * Event fire by {@link DistanceMeasurementsPlugin} when mouse leaves a {@link DistanceMeasurement}.
+ */
+export declare type DistanceMeasurementMouseLeaveEvent = {
+
+    /**
+     * The plugin.
+     */
+    plugin: DistanceMeasurementsPlugin;
+
+    /**
+     * The measurement.
+     */
+    angleMeasurement: DistanceMeasurement;
+
+    /**
+     * The measurement.
+     */
+    measurement: DistanceMeasurement;
+
+    /**
+     * The original mouse event.
+     */
+    event: MouseEvent;
+}
+
 /**
  * {@link Viewer} plugin for measuring point-to-point distances.
  */
@@ -134,13 +187,41 @@ export declare class DistanceMeasurementsPlugin extends Plugin {
    */
   clear(): void;
 
+    /**
+     * Fires when mouse is over a measurement.
+     * @param {String} event The mouseOver event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "mouseOver", callback: (event: DistanceMeasurementMouseOverEvent)=> void): string;
+
+    /**
+     * Fires when mouse leaves a measurement.
+     * @param {String} event The mouseLeave event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "mouseLeave", callback: (event: DistanceMeasurementMouseLeaveEvent)=> void): string;
+
+    /**
+     * Fires when a context menu is to be opened on a measurement.
+     * @param {String} event The contextMenu event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "contextMenu", callback: (measurement: DistanceMeasurement)=> void): string;
+
   /**
    * Fires when a measurement is created.
    * @param {String} event The measurementCreated event
    * @param {Function} callback Callback fired on the event
    */
   on(event: "measurementCreated", callback: (measurement: DistanceMeasurement)=> void): string;
 
+    /**
+     * Fires when a measurement is completed.
+     * @param {String} event The measurementEnd event
+     * @param {Function} callback Callback fired on the event
+     */
+    on(event: "measurementStart", callback: (measurement: DistanceMeasurement)=> void): string;
+
   /**
    * Fires when a measurement is completed.
    * @param {String} event The measurementEnd event