IMagneticPlaneConfig ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Interface · import type { IMagneticPlaneConfig } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 21. Stored data (vendored; replaces @holo/interfaces)

A stored connector-plane config, matched to a connector plane by meshName. It lies over the GLB's extras.holostep.connector (spec section 6.12): connector is the side (Connector.meta.connector), allowedTypes is Connector.accepts. Other keys (align, frontDir, multi, your own) pass through to Connector.meta.

Members ​

Member Kind Summary
meshName property The plane node's cleaned name (spec section 6.9, ID1), as 1.x read it off the plane mesh; never the glTF meshes[].name.
label? property A name for editors.
connector? property The side, e.g. 'left' (not the plane id).
enabled? property
priority? property
allowedTypes? property An array, or a comma list as older documents store it; read through Connector.accepts (always an array).
allowRotatedSnap? property Measure the alignment along the target's frontDir after a rotation (1.4's rotated-mate path).

Declaration ​

ts
export interface IMagneticPlaneConfig {
  meshName: string;
  label?: string;
  connector?: string;
  enabled?: boolean;
  priority?: number;
  allowedTypes?: string[] | string;
  allowRotatedSnap?: boolean;
  [key: string]: string | number | boolean | string[] | undefined;
}

Generic-API test (spec 3.1) ​

Rule Result
1. Neutral name pass: IMagneticPlaneConfig names no product
2. A precedent not recorded: no ledger row (coverage.json) names this member or its owner
3. Two apps, or labs not recorded: no ledger row names this member or its owner
4. The cheaper fix first not recorded per member (Appendix B decides it per need)