deprecated ModelComponentData

Author: fabmax

kool-editor-model/src/commonMain/kotlin/de/fabmax/kool/editor/api/EditorProject.kt

@@ -190,7 +190,7 @@ fun ProjectData.allEntities(): List<GameEntityData> {
 
 fun ProjectData.checkConsistency() {
     if (meta.modelVersion != ProjectData.MODEL_VERSION) {
-        logW { "Project data model version mismatch: ${meta.modelVersion} (supported version is ${ProjectData.MODEL_VERSION})" }
+        logW { "Project data model version mismatch: ${meta.modelVersion} (current version is ${ProjectData.MODEL_VERSION})" }
     }
 
     scenes.forEach { scene ->

kool-editor-model/src/commonMain/kotlin/de/fabmax/kool/editor/api/GameEntity.kt

@@ -6,7 +6,7 @@ import de.fabmax.kool.modules.ui2.mutableStateListOf
 import de.fabmax.kool.modules.ui2.mutableStateOf
 import de.fabmax.kool.pipeline.RenderPass
 import de.fabmax.kool.scene.Node
-import de.fabmax.kool.util.logW
+import de.fabmax.kool.util.logE
 import kotlin.math.max
 
 val GameEntity.project: EditorProject get() = scene.project
@@ -208,7 +208,7 @@ class GameEntity(val entityData: GameEntityData, val scene: EditorScene) {
     }
 
     fun createDataComponent(info: ComponentInfo<*>): GameEntityDataComponent<*> {
-        @Suppress("UNCHECKED_CAST")
+        @Suppress("UNCHECKED_CAST", "DEPRECATION")
         return when (info.data) {
             is BehaviorComponentData -> BehaviorComponent(this, info as ComponentInfo<BehaviorComponentData>)
             is TransformComponentData -> TransformComponent(this, info as ComponentInfo<TransformComponentData>)
@@ -228,7 +228,7 @@ class GameEntity(val entityData: GameEntityData, val scene: EditorScene) {
             is SsaoComponentData -> SsaoComponent(requireScene, info as ComponentInfo<SsaoComponentData>)
 
             is ModelComponentData -> {
-                logW { "converting ModelComponentData to MeshComponentData" }
+                logE { "ModelComponentData is deprecated" }
                 val modelData = info.data as ModelComponentData
                 val meshData = MeshComponentData(ShapeData.Model(modelData.modelPath, modelData.sceneIndex, modelData.animationIndex))
                 MeshComponent(requireSceneChild, ComponentInfo(meshData))

kool-editor-model/src/commonMain/kotlin/de/fabmax/kool/editor/api/ProjectDataIo.kt

@@ -79,7 +79,7 @@ class ProjectWriter private constructor(
     private val projFiles = mutableSetOf<WritableFileSystemItem>()
 
     private suspend fun saveTree() {
-        targetDir.createProjFile("project.json", codec.encodeToString(projData.meta.copy(modelVersion = ProjectData.MODEL_VERSION)))
+        targetDir.createProjFile("project.json", codec.encodeToString(projData.meta))
 
         val materialDir = targetDir.createProjDir("materials")
         projData.materials.toHierarchy().forEach { it.saveEntities(materialDir) }

kool-editor-model/src/commonMain/kotlin/de/fabmax/kool/editor/data/ComponentData.kt

@@ -5,6 +5,7 @@ import kotlinx.serialization.Serializable
 @Serializable
 sealed interface ComponentData
 
+@Deprecated("Replaced by MeshComponentData with ShapeData.Model")
 @Serializable
 data class ModelComponentData(
     val modelPath: String,

kool-editor-model/src/commonMain/kotlin/de/fabmax/kool/editor/data/ProjectData.kt

@@ -9,7 +9,7 @@ class ProjectData(
     val materials: MutableList<GameEntityData> = mutableListOf()
 ) {
     companion object {
-        const val MODEL_VERSION = "1.0.0"
+        const val MODEL_VERSION = "1.1.0"
     }
 }
 

kool-editor/src/commonMain/kotlin/de/fabmax/kool/editor/KoolEditor.kt

@@ -6,6 +6,7 @@ import de.fabmax.kool.editor.actions.EditorActions
 import de.fabmax.kool.editor.actions.SetVisibilityAction
 import de.fabmax.kool.editor.api.*
 import de.fabmax.kool.editor.components.CameraAwareComponent
+import de.fabmax.kool.editor.data.ProjectData
 import de.fabmax.kool.editor.overlays.GridOverlay
 import de.fabmax.kool.editor.overlays.SceneObjectsOverlay
 import de.fabmax.kool.editor.overlays.SelectionOverlay
@@ -35,21 +36,29 @@ suspend fun KoolEditor(projectFiles: ProjectFiles, ctx: KoolContext): KoolEditor
     val projDataDir = projectFiles.projectModelDir
     val reader = ProjectReader(projDataDir)
     val data = reader.loadTree() ?: EditorProject.emptyProjectData()
-    if (reader.parserErrors > 0) {
+    if (reader.parserErrors > 0 || data.meta.modelVersion != ProjectData.MODEL_VERSION) {
         fun Int.toString(len: Int): String {
             var str = "$this"
             while (str.length < len) str = "0$str"
             return str
         }
         val dateTime = Clock.System.now().toLocalDateTime(TimeZone.currentSystemDefault())
-        val backupName = "project_backup_" +
+        val backupPath = "kool_project_backup_" +
                 "${dateTime.year}${dateTime.monthNumber.toString(2)}${dateTime.dayOfMonth.toString(2)}_" +
                 "${dateTime.hour.toString(2)}${dateTime.minute.toString(2)}${dateTime.second.toString(2)}"
-        logE("KoolEditor") { "ProjectReader reported errors, backing up original project data as $backupName" }
-        val backupDir = projectFiles.fileSystem.createDirectory("src/commonMain/resources/$backupName")
+
+        if (reader.parserErrors > 0) {
+            logE("KoolEditor") { "ProjectReader reported errors, backing up original project data as $backupPath" }
+        } else {
+            logW("KoolEditor") { "Project model version mismatch, backing up original project data as $backupPath" }
+        }
+        val backupDir = projectFiles.fileSystem.createDirectory(backupPath)
         projDataDir.copyRecursively(backupDir)
     }
-    data.updateData()
+    if (data.meta.modelVersion != ProjectData.MODEL_VERSION) {
+        logW("KoolEditor") { "Updating project data: ${data.meta.modelVersion} -> ${ProjectData.MODEL_VERSION}" }
+        data.updateData()
+    }
     return KoolEditor(projectFiles, EditorProject(data), ctx)
 }
 

kool-editor/src/commonMain/kotlin/de/fabmax/kool/editor/UpdateProjectData.kt

@@ -1,10 +1,13 @@
+@file:Suppress("DEPRECATION")
+
 package de.fabmax.kool.editor
 
 import de.fabmax.kool.editor.data.*
 import de.fabmax.kool.util.logW
 
 fun ProjectData.updateData() {
     replaceModelComponentsByMeshComponents()
+    meta = meta.copy(modelVersion = ProjectData.MODEL_VERSION)
 }
 
 private fun ProjectData.replaceModelComponentsByMeshComponents() {