@aics/agave-webclient 1.7.2 → 1.8.0-rc.0

package/es/agave.js

@@ -797,6 +797,37 @@ export var AgaveClient = /*#__PURE__*/function () {
       this.cb.addCommand("SET_INTERPOLATION", on);
     }
 
+    /**
+     * Set the clip plane equation.  The xyz vector must be normalized.
+     *
+     * @param x The x component of the normal
+     * @param y The y component of the normal
+     * @param z The z component of the normal
+     * @param d The distance to the origin
+     */
+  }, {
+    key: "setClipPlane",
+    value: function setClipPlane(x, y, z, d) {
+      // 48
+      this.cb.addCommand("SET_CLIP_PLANE", x, y, z, d);
+    }
+
+    /**
+     * Set the color ramp for a channel
+     *
+     * @param channel Which channel index, 0 based.
+     * @param name The name of the color ramp
+     * @param data An array of values.  5 floats per control point.  first is position (0-1),
+     * next four are rgba (all 0-1).  Currently alpha will be ignored.
+     * To guarantee correct behavior, the first control point should be at 0.0 and the last at 1.0.
+     */
+  }, {
+    key: "setColorRamp",
+    value: function setColorRamp(channel, name, data) {
+      // 49
+      this.cb.addCommand("SET_COLOR_RAMP", channel, name, data);
+    }
+
     // send all data in our current command buffer to the server
   }, {
     key: "flushCommandBuffer",

package/es/commandbuffer.js

@@ -89,7 +89,10 @@ export var COMMANDS = {
   LOAD_DATA: [44, "S", "I32", "I32", "I32", "I32A", "I32A"],
   SHOW_SCALE_BAR: [45, "I32"],
   SET_FLIP_AXIS: [46, "I32", "I32", "I32"],
-  SET_INTERPOLATION: [47, "I32"]
+  SET_INTERPOLATION: [47, "I32"],
+  SET_CLIP_PLANE: [48, "F32", "F32", "F32", "F32"],
+  // channel index, name, array of [stop, r, g, b, a]
+  SET_COLOR_RAMP: [49, "I32", "S", "F32A"]
 };
 
 // strategy: add elements to prebuffer, and then traverse prebuffer to convert

package/es/types/agave.d.ts

@@ -389,5 +389,24 @@ export declare class AgaveClient {
      * @param on 0 to turn off, 1 to turn on
      */
     setInterpolation(on: number): void;
+    /**
+     * Set the clip plane equation.  The xyz vector must be normalized.
+     *
+     * @param x The x component of the normal
+     * @param y The y component of the normal
+     * @param z The z component of the normal
+     * @param d The distance to the origin
+     */
+    setClipPlane(x: number, y: number, z: number, d: number): void;
+    /**
+     * Set the color ramp for a channel
+     *
+     * @param channel Which channel index, 0 based.
+     * @param name The name of the color ramp
+     * @param data An array of values.  5 floats per control point.  first is position (0-1),
+     * next four are rgba (all 0-1).  Currently alpha will be ignored.
+     * To guarantee correct behavior, the first control point should be at 0.0 and the last at 1.0.
+     */
+    setColorRamp(channel: number, name: string, data: number[]): void;
     flushCommandBuffer(): void;
 }

package/es/types/commandbuffer.d.ts

@@ -48,6 +48,8 @@ export declare const COMMANDS: {
     SHOW_SCALE_BAR: (string | number)[];
     SET_FLIP_AXIS: (string | number)[];
     SET_INTERPOLATION: (string | number)[];
+    SET_CLIP_PLANE: (string | number)[];
+    SET_COLOR_RAMP: (string | number)[];
 };
 export declare class CommandBuffer {
     private prebuffer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aics/agave-webclient",
-  "version": "1.7.2",
+  "version": "1.8.0-rc.0",
   "description": "client library for using agave as remote rendering server",
   "main": "es/index.js",
   "module": "es/index.js",
@@ -51,7 +51,7 @@
     "eslint": "^8.43.0",
     "eslint-config-prettier": "^8.8.0",
     "html-webpack-plugin": "^5.5.1",
-    "mocha": "10.2.0",
+    "mocha": "10.8.2",
     "prettier": "^2.8.8",
     "rimraf": "^5.0.1",
     "three": "^0.153.0",