@things-factory/figure-ui 10.1.46 → 10.1.47

package/client/modeller/v3-controls.ts

@@ -0,0 +1,54 @@
+import type { V3Asset } from '@hatiolab/figure-model'
+
+/*
+ * The figure's controls -- its state inputs, what V2 called parameters: the values a board or a connector sets to pose
+ * the figure (a lift height, a joint angle, a gripper opening). Kept apart from the element so the reading is tested
+ * without a browser.
+ */
+export interface Control {
+  id: string
+  /** The name a person reads, or the id when none is given. */
+  label: string
+  named: boolean
+  unit: string
+  min: number
+  max: number
+  /** Where it stands in the editor now -- the pose being looked at, not yet the default. */
+  value: number
+  /** Where it starts when the figure is placed: the default pose. */
+  start: number
+  /** Seconds to travel the whole range, 0 when it moves at once. */
+  sweep: number
+  /** A slider step: one degree for an angle, else a hundredth of the range. */
+  step: number
+}
+
+export function controlsOf(asset: V3Asset, values: Record<string, number> = {}): Control[] {
+  return asset.document.model.inputs
+    .filter(input => input.role === 'state')
+    .map(input => {
+      const policy = asset.stateInputs?.[input.id]
+      const start = asset.stateDefaults[input.id] ?? input.min
+      return {
+        id: input.id,
+        label: policy?.label ?? input.id,
+        named: !!policy?.label,
+        unit: input.unit,
+        min: input.min,
+        max: input.max,
+        value: values[input.id] ?? start,
+        start,
+        sweep: policy?.sweep ?? 0,
+        step: input.unit === 'deg' ? 1 : (input.max - input.min) / 100
+      }
+    })
+}
+
+/** Whether the pose being looked at differs from the default pose -- only then is there a pose to keep. */
+export const poseDiffers = (controls: readonly Control[]) => controls.some(c => c.value !== c.start)
+
+/** The current pose as the defaults: one `set-state-defaults` edit. */
+export const poseAsDefault = (controls: readonly Control[]) => ({
+  kind: 'set-state-defaults' as const,
+  values: Object.fromEntries(controls.map(c => [c.id, c.value]))
+})