kool-editor-model

0.18.0

kool-editor-model/de.fabmax.kool.editor.api

Package-level declarations

Types

object AppAssets : AppAssetsLoader

AppAssetsLoader

interface AppAssetsLoader

enum AppMode : Enum<AppMode>

object AppState

sealed interface AssetReference

expect object BehaviorLoader

actual object BehaviorLoader

actual object BehaviorLoader

CachedEntityComponents

class CachedEntityComponents<T : Any>(val gameEntity: GameEntity, val componentClass: KClass<T>)

CachedProjectComponents

class CachedProjectComponents<T : Any>(val project: EditorProject, val componentClass: KClass<T>)

CachedSceneComponents

class CachedSceneComponents<T : Any>(val scene: EditorScene, val componentClass: KClass<T>)

open class DefaultLoader(val pathPrefix: String) : AppAssetsLoader

interface EditorAwareApp

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class EditorHidden

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class EditorInfo(val label: String = "", val order: Int = 0, val precision: Int = 0)

class EditorProject(val projectData: ProjectData) : BaseReleasable

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

annotation class EditorRange(val minX: Double = Double.NEGATIVE_INFINITY, val minY: Double = Double.NEGATIVE_INFINITY, val minZ: Double = Double.NEGATIVE_INFINITY, val minW: Double = Double.NEGATIVE_INFINITY, val maxX: Double = Double.POSITIVE_INFINITY, val maxY: Double = Double.POSITIVE_INFINITY, val maxZ: Double = Double.POSITIVE_INFINITY, val maxW: Double = Double.POSITIVE_INFINITY)

class EditorScene(val sceneData: SceneData, val project: EditorProject) : BaseReleasable

EntityLifecycle

enum EntityLifecycle : Enum<EntityLifecycle>

class GameEntity(val entityData: GameEntityData, val scene: EditorScene)

GameEntityDataHierarchy

class GameEntityDataHierarchy(val entityData: GameEntityData, val children: List<GameEntityDataHierarchy>)

abstract class KoolBehavior

data class MeshLayoutInfo(val vertexLayout: List<Attribute>, val instanceLayout: List<Attribute>, val primitiveType: PrimitiveType, val numJoints: Int)

class ProjectReader(srcDir: FileSystemDirectory)

class ProjectWriter

class SceneHitTest(val scene: EditorScene)

class SceneNodes(val scene: EditorScene) : EditorScene.SceneShaderDataListener, MaterialComponent.ListenerComponent

SceneShaderCache

class SceneShaderCache : EditorScene.SceneShaderDataListener

SceneShaderData

class SceneShaderData(val scene: EditorScene, isNotifying: Boolean = true)

Properties

val EditorScene.isCreated: Boolean

val GameEntity.isCreated: Boolean

val GameEntityComponent.isCreated: Boolean

val EditorScene.isDestroyed: Boolean

val GameEntity.isDestroyed: Boolean

val GameEntityComponent.isDestroyed: Boolean

val EditorScene.isPrepared: Boolean

val GameEntity.isPrepared: Boolean

val GameEntityComponent.isPrepared: Boolean

isPreparedOrRunning

val EditorScene.isPreparedOrRunning: Boolean

val GameEntity.isPreparedOrRunning: Boolean

val GameEntityComponent.isPreparedOrRunning: Boolean

val EditorScene.isRunning: Boolean

val GameEntity.isRunning: Boolean

val GameEntityComponent.isRunning: Boolean

val GameEntity.project: EditorProject

val EditorScene.scene: Scene

val EditorScene.sceneComponent: SceneComponent

val GameEntity.sceneComponent: SceneComponent

val GameEntity.sceneEntity: GameEntity

val EditorScene.upAxis: SceneUpAxis

Functions

fun ProjectData.allEntities(): List<GameEntityData>

suspend fun AppAssetsLoader.cacheAsset(ref: AssetReference): Boolean

cachedEntityComponents

inline fun <T : Any> GameEntity.cachedEntityComponents(): CachedEntityComponents<T>

inline fun <T : Any> GameEntityComponent.cachedEntityComponents(): CachedEntityComponents<T>

cachedProjectComponents

inline fun <T : Any> GameEntity.cachedProjectComponents(): CachedProjectComponents<T>

inline fun <T : Any> GameEntityComponent.cachedProjectComponents(): CachedProjectComponents<T>

cachedSceneComponents

inline fun <T : Any> GameEntity.cachedSceneComponents(): CachedSceneComponents<T>

inline fun <T : Any> GameEntityComponent.cachedSceneComponents(): CachedSceneComponents<T>

checkConsistency

fun ProjectData.checkConsistency()

suspend fun AppAssetsLoader.loadBlob(path: String): Result<Uint8Buffer>

suspend fun AppAssetsLoader.loadBlobOrNull(ref: AssetReference.Blob): Uint8Buffer?

suspend fun AppAssetsLoader.loadBlobOrNull(path: String): Uint8Buffer?

suspend fun AppAssetsLoader.loadHdri(path: String): Result<EnvironmentMap>

loadHdriEnvironmentOrNull

suspend fun AppAssetsLoader.loadHdriEnvironmentOrNull(ref: AssetReference.Hdri): EnvironmentMap?

suspend fun AppAssetsLoader.loadHdriOrNull(path: String): EnvironmentMap?

suspend fun AppAssetsLoader.loadHeightmap(path: String): Result<Heightmap>

loadHeightmapOrNull

suspend fun AppAssetsLoader.loadHeightmapOrNull(ref: AssetReference.Heightmap): Heightmap?

suspend fun AppAssetsLoader.loadHeightmapOrNull(path: String): Heightmap?

suspend fun AppAssetsLoader.loadModel(path: String): Result<GltfFile>

loadModelOrNull

suspend fun AppAssetsLoader.loadModelOrNull(ref: AssetReference.Model): GltfFile?

suspend fun AppAssetsLoader.loadModelOrNull(path: String): GltfFile?

suspend fun AppAssetsLoader.loadTexture2d(path: String): Result<Texture2d>

loadTexture2dOrNull

suspend fun AppAssetsLoader.loadTexture2dOrNull(ref: AssetReference.Texture): Texture2d?

suspend fun AppAssetsLoader.loadTexture2dOrNull(path: String): Texture2d?

fun MeshLayoutInfo(mesh: Mesh): MeshLayoutInfo

suspend fun AppAssetsLoader.requireBlob(ref: AssetReference.Blob): Uint8Buffer

requireHdriEnvironment

suspend fun AppAssetsLoader.requireHdriEnvironment(ref: AssetReference.Hdri): EnvironmentMap

requireHeightmap

suspend fun AppAssetsLoader.requireHeightmap(ref: AssetReference.Heightmap): Heightmap

suspend fun AppAssetsLoader.requireModel(ref: AssetReference.Model): GltfFile

requireTexture2d

suspend fun AppAssetsLoader.requireTexture2d(ref: AssetReference.Texture): Texture2d

@JvmName(name = "entitiesToHierarchy")

fun List<GameEntity>.toHierarchy(): List<GameEntityDataHierarchy>

@JvmName(name = "dataToHierarchy")

fun List<GameEntityData>.toHierarchy(): List<GameEntityDataHierarchy>