PhetioObject¶

Overview¶

Base type that provides PhET-iO features. An instrumented PhetioObject is referred to on the wrapper side/design side as a "PhET-iO Element". Note that sims may have hundreds or thousands of PhetioObjects, so performance and memory considerations are important. For this reason, initializePhetioObject is only called in PhET-iO brand, which means many of the getters such as phetioState and phetioDocumentation will not work in other brands. We have opted to have these getters throw assertion errors in other brands to help identify problems if these are called unexpectedly.

@author Sam Reid (PhET Interactive Simulations) @author Michael Kauzmann (PhET Interactive Simulations)

Type PhetioObjectMetadataInput¶

A type that is used for the structural typing when gathering metadata. We just need a "PhetioObject-like" entity to pull the API metadata from. Thus, this is the "input" to logic that would pull the metadata keys into an object for the PhetioAPI.

import type { PhetioObjectMetadataInput } from 'scenerystack/tandem';

Pick<PhetioObject, PhetioObjectMetadataKeys>

Type PhetioObjectOptions¶

import type { PhetioObjectOptions } from 'scenerystack/tandem';

• tandem?: Tandem
  Unique identifier for this instance, used by PhET-iO to access this instance from the wrapper frame. This is the only place in the project where tandem can be specified directly in a Type.
• descriptionTandem?: Tandem
  @experimental - do not use without consulting https://github.com/phetsims/joist/issues/941
• phetioType?: AnyIOType
  Defines API methods, events and serialization. The type of the PhET-iO Element, see IOType
• phetioEventType?: EventType
  The category of event that this element emits to the PhET-iO Data Stream. This is a default, it can be overridden in phetioStartEvent options. Cannot be supplied through TandemConstants because that would create an import loop
• phetioEventMetadata?: EventMetadata | null
  delivered with each event, if specified. phetioPlayback is appended here, if true. Note: unlike other options, this option can be mutated downstream, and hence should be created newly for each instance.
• tandemNameSuffix?: string | string[] | null
  The element's tandem name must have a specified suffix. This is to enforce naming conventions for PhET-iO. If string[] is provided, the tandem name must have a suffix that matches one of the strings in the array. null means that there is no constraint on tandem name. The first character is not case-sensitive, to support uses like 'thermometerNode' versus 'upperThermometerNode'.
• & StrictOmit<Partial<PhetioElementMetadata>, "phetioTypeName" | "phetioArchetypePhetioID" | "phetioIsArchetype" | "phetioEventType"> & DisposableOptions

Source Code¶

See the source for PhetioObject.ts in the tandem repository.