IModelNode.tryOn ​

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.

Property of IModelNode · inherited by ConfiguratorNode · labs, @experimental · since 2.0.0

tryOn?: {
  kind: TryOnKind;
  approved?: {
    format: number;
  };
};

The node's try-on rig record, which Holostep's rig pipeline writes and the runtime only reads: kind is the body part the rig fits, and approved is set once a rig passed review, with format, the rig file's format version the tracker checks. canTryOn() and tryOn() use the first enabled ModelNode on screen (following each GroupNode's selected child) that has one, and only its approved rig, at tryOnUrl; a candidate is never used.

Default: undefined (no rig: canTryOn() answers reason: 'no-rig')

Fields ​

kind ​

kind: TryOnKind;

The body part the rig fits.

approved ​

approved?: { … }

Set once a rig passed review.

Default: undefined (no approved rig: no try-on)

approved.format ​

format: number;

The rig file's format version, which the tracker checks.

Example ​

Imports: values (has, validate, the Holo*Error classes, the pure helpers) from @holostep-configurators/runtime-client, types from @holostep-configurators/runtime-client/contract, /math and /testing names from those entries; boot from the runtime module the root's loadRuntimeAtFloor resolves to. A type your page defines is your app's: declare it there, never import it from the package.

Compiled under the contract's strict settings (examples/declaration/21-IModelNode.tryOn.ts):

import { has } from '@holostep-configurators/runtime-client';
import type { IModelNode, Session } from '@holostep-configurators/runtime-client/contract';
declare const session: Session;
declare const signal: AbortSignal;
declare const glasses: IModelNode;           // a placed product, enabled
declare const rigUrl: string;                // the approved rig's GLB, an absolute URL
// A model with an approved face rig: canTryOn() reads it once the model commits.
await session.setSceneModel({
  root: [{ ...glasses, tryOn: { kind: 'face', approved: { format: 1 } }, tryOnUrl: rigUrl }],
});
export const tryOnShown = (): boolean =>
  has(session, 'canTryOn') && session.canTryOn().available;

Generic-API test (spec 3.1) ​