begin supporting multiple scenes and tracking dependencies. scene loads via reactor

Author: HexaField

packages/engine/src/ecs/classes/Scene.ts

@@ -25,35 +25,42 @@ Ethereal Engine. All Rights Reserved.
 
 import { Color, Texture } from 'three'
 
-import { SceneData } from '@etherealengine/common/src/interfaces/SceneInterface'
-import { defineState, getMutableState } from '@etherealengine/hyperflux'
+import { defineState, getMutableState, getState } from '@etherealengine/hyperflux'
 
-import { scenePath } from '../../schemas/projects/scene.schema'
+import { UUIDComponent } from '../../scene/components/UUIDComponent'
+import { SceneDataType, SceneID, scenePath } from '../../schemas/projects/scene.schema'
 import { Engine } from './Engine'
-import { UndefinedEntity } from './Entity'
+
+export interface StagedScene {
+  data: SceneDataType
+}
 
 export const SceneState = defineState({
   name: 'SceneState',
   initial: () => ({
-    sceneData: null as SceneData | null,
-    sceneEntity: UndefinedEntity,
-    /** @todo support multiple scenes */
-    // sceneEntities: {} as Record<string /* SceneID */, EntityUUID>,
+    scenes: {} as Record<SceneID, StagedScene>,
+    /** @todo replace activeScene with proper multi-scene support */
+    activeScene: null as null | SceneID,
     background: null as null | Color | Texture
-  })
+  }),
+
+  loadScene: (sceneID: SceneID, data: SceneDataType) => {
+    getMutableState(SceneState).scenes[sceneID].set({ data })
+    getMutableState(SceneState).activeScene.set(sceneID)
+  },
+
+  getRootEntity: (sceneID: SceneID) => {
+    const scene = getState(SceneState).scenes[sceneID]
+    return UUIDComponent.entitiesByUUID[scene.data.scene.root]
+  }
 })
 
 export const SceneServices = {
   setCurrentScene: async (projectName: string, sceneName: string) => {
     const sceneData = await Engine.instance.api
       .service(scenePath)
       .get(null, { query: { project: projectName, name: sceneName } })
-    getMutableState(SceneState).sceneData.set(sceneData)
+    /**@todo replace projectName/sceneName with sceneID once #9119 */
+    SceneState.loadScene(`${projectName}/${sceneName}` as SceneID, sceneData)
   }
 }
-// export const
-
-// export const getActiveSceneEntity = () => {
-//   const state = getState(SceneState)
-//   return UUIDComponent.entitiesByUUID[state.sceneEntities[state.sceneEntity]]
-// }

packages/engine/src/ecs/functions/EntityTree.test.ts

@@ -45,7 +45,6 @@ import {
   destroyEntityTree,
   findIndexOfEntityNode,
   getEntityNodeArrayFromEntities,
-  initializeSceneEntity,
   iterateEntityNode,
   removeFromEntityTree,
   reparentEntityNode,

packages/engine/src/ecs/functions/EntityTree.ts

@@ -32,10 +32,7 @@ import { dispatchAction, getMutableState, getState, hookstate, NO_PROXY, none }
 import { matchesEntityUUID } from '../../common/functions/MatchesUtils'
 import { WorldNetworkAction } from '../../networking/functions/WorldNetworkAction'
 import { NetworkState } from '../../networking/NetworkState'
-import { NameComponent } from '../../scene/components/NameComponent'
-import { SceneTagComponent } from '../../scene/components/SceneTagComponent'
 import { UUIDComponent } from '../../scene/components/UUIDComponent'
-import { VisibleComponent } from '../../scene/components/VisibleComponent'
 import { serializeEntity } from '../../scene/functions/serializeWorld'
 import { LocalTransformComponent, TransformComponent } from '../../transform/components/TransformComponent'
 import { Engine } from '../classes/Engine'
@@ -51,7 +48,7 @@ import {
   removeComponent,
   setComponent
 } from '../functions/ComponentFunctions'
-import { createEntity, entityExists, removeEntity } from '../functions/EntityFunctions'
+import { entityExists, removeEntity } from '../functions/EntityFunctions'
 
 type EntityTreeSetType = {
   parentEntity: Entity | null
@@ -153,24 +150,6 @@ export const EntityTreeComponent = defineComponent({
 
 export type EntityOrObjectUUID = Entity | string
 
-/**
- * Initialize the world with enity tree
- * @param scene World
- */
-export function initializeSceneEntity(): void {
-  const oldSceneEntity = getState(SceneState).sceneEntity
-  if (oldSceneEntity && entityExists(oldSceneEntity)) removeEntity(oldSceneEntity)
-
-  const sceneEntity = createEntity()
-  getMutableState(SceneState).sceneEntity.set(sceneEntity)
-  setComponent(sceneEntity, NameComponent, 'scene')
-  setComponent(sceneEntity, VisibleComponent, true)
-  setComponent(sceneEntity, UUIDComponent, MathUtils.generateUUID() as EntityUUID)
-  setComponent(sceneEntity, SceneTagComponent, true)
-  setComponent(sceneEntity, TransformComponent)
-  setComponent(sceneEntity, EntityTreeComponent, { parentEntity: null })
-}
-
 /**
  * Recursively destroys all the children entities of the passed entity
  */

packages/engine/src/initializeEngine.ts

@@ -32,7 +32,7 @@ import { Engine } from './ecs/classes/Engine'
 import { getComponent, setComponent } from './ecs/functions/ComponentFunctions'
 import { executeSystems, startCoreSystems } from './ecs/functions/EngineFunctions'
 import { createEntity } from './ecs/functions/EntityFunctions'
-import { EntityTreeComponent, initializeSceneEntity } from './ecs/functions/EntityTree'
+import { EntityTreeComponent } from './ecs/functions/EntityTree'
 import { EngineRenderer } from './renderer/WebGLRendererSystem'
 import { addObjectToGroup } from './scene/components/GroupComponent'
 import { NameComponent } from './scene/components/NameComponent'
@@ -81,8 +81,6 @@ export const createEngine = () => {
   camera.matrixAutoUpdate = false
   camera.matrixWorldAutoUpdate = false
 
-  initializeSceneEntity()
-
   EngineRenderer.instance = new EngineRenderer()
   startCoreSystems()
   Engine.instance.engineTimer = Timer(executeSystems)

packages/engine/src/scene/components/ChildrenComponent.ts

@@ -23,8 +23,12 @@ All portions of the code written by the Ethereal Engine team are Copyright © 20
 Ethereal Engine. All Rights Reserved.
 */
 
+import { EntityUUID } from '@etherealengine/common/src/interfaces/EntityUUID'
+import { createState } from '@etherealengine/hyperflux'
 import { defineComponent } from '../../ecs/functions/ComponentFunctions'
 
+const entityUUIDLoaded = {} as Record<EntityUUID, boolean>
+
 export const SceneDynamicLoadTagComponent = defineComponent({
   name: 'SceneDynamicLoadTagComponent',
   jsonID: 'dynamic-load',
@@ -45,5 +49,8 @@ export const SceneDynamicLoadTagComponent = defineComponent({
     return {
       distance: component.distance.value
     }
-  }
+  },
+
+  entityUUIDLoadedState: createState(entityUUIDLoaded),
+  entityUUIDLoaded: entityUUIDLoaded as Readonly<typeof entityUUIDLoaded>
 })