Class SceneTreesObject3DSync

constructor

• new SceneTreesObject3DSync(
      trees: SceneTreesTarget,
      root: Object3D<Object3DEventMap> | readonly Object3D<Object3DEventMap>[],
      options?: SceneTreesObject3DSyncOptions,
  ): SceneTreesObject3DSync

  Adds every mesh and instance under root to trees (one sync).

  Parameters

  • trees: SceneTreesTarget
  • root: Object3D<Object3DEventMap> | readonly Object3D<Object3DEventMap>[]
  • options: SceneTreesObject3DSyncOptions = {}

  Returns SceneTreesObject3DSync

poseCounts

Readonlyroot

Readonlytrees

instanceCount

• get instanceCount(): number

  Returns number

meshCount

• get meshCount(): number

  Meshes the sync can still share (a mesh merged away is no longer counted).

  Returns number

meshHandles

• get meshHandles(): number[]

  The SceneTrees mesh handles the sync holds now, one per mesh it added (a shared geometry range, or a posed object's own), for SceneTrees.meshStatus and stats. A new array each time; a sync can add and remove handles.

  Returns number[]

ready

• get ready(): Promise<void>

  Settles once every pose-pass compile started so far has (a failed one warns, and its pass compiles at its first update). Until then update skips the objects whose pass is compiling; await it after the constructor (or a sync that added posed objects) to have every object posed from the next update. Never rejects.

  Returns Promise<void>

dispose

• dispose(): void

  Removes every instance and mesh the sync added from the SceneTrees, except merged static instances (SceneTrees can't remove them) and their meshes.

  Returns void

isDeforming

• isDeforming(mesh: Mesh): boolean

  Whether mesh is posed on the GPU (see SceneTreesObject3DSyncOptions.deforming).

  Parameters

  • mesh: Mesh

  Returns boolean

meshSourceOf

• meshSourceOf(instanceIndex: number): BvhThreeMeshSource | null

  The geometry and range (or folded groups) of a hit instance's mesh (for threeFaceIndex, threeGroupOf, threeMaterialOf), or null.

  Parameters

  • instanceIndex: number

  Returns BvhThreeMeshSource | null

pose

• pose(): Object3DPoseCounts

  Runs the pose pass of every visible posed object (skinned and morphed meshes) and hands its vertices to SceneTrees.setPose, moving its top-level box when the pose leaves it. update calls it last. An object whose pass's pipeline is still compiling is skipped (see ready).

  Returns Object3DPoseCounts

posePassOf

• posePassOf(object: Mesh): BvhPosePassLike | null

  The pose pass of a posed object (its buffer holds the last pose), or null.

  Parameters

  • object: Mesh

  Returns BvhPosePassLike | null

sourceOf

• sourceOf(instanceIndex: number): BvhThreeSource | null

  The three object behind a hit's instance (the SceneTrees instanceIndex), or null.

  Parameters

  • instanceIndex: number

  Returns BvhThreeSource | null

sync

• sync(): Object3DSyncCounts

  Walks the scene again: adds new meshes and instances, removes gone ones, then pushes changes as update does (and material indices). The walk and the plan come first, so a throwing material callback changes nothing; each SceneTrees call then updates the sync's records with it.

  Returns Object3DSyncCounts

update

• update(): Object3DSyncCounts

  Pushes the moved, shown, hidden and re-layered instances the sync knows (not static ones), skipping objects that didn't change (see the file comment). Call once per frame, after updateMatrixWorld() and before SceneTrees.update.

  Returns Object3DSyncCounts