Zernikalos/zernikalos.loader

Package-level declarations

Types

ZKo

data class ZKo(val header: ZkoHeader, val root: ZObject, val actions: List<ZSkeletalAction>? = null)

Represents the ZKo data structure exposed externally after loading a Zko file.

ZkoComponentCollection

@Serializable

data class ZkoComponentCollection(val meshes: List<ZMesh>, val textures: List<ZTexture>)

ZkoFormat

@Serializable

data class ZkoFormat(val header: ZkoHeader, val components: ZkoComponentCollection, val objects: List<ZkoObjectProto>, val hierarchy: ZkoHierarchyNode, val actions: List<ZSkeletalAction>? = null)

Zernikalos KObject file format.

ZkoHeader

@Serializable

data class ZkoHeader(val version: String)

ZkoHierarchyNode

@Serializable

data class ZkoHierarchyNode(val refId: String, val children: List<ZkoHierarchyNode>? = emptyList())

ZkoLoader

@ObjCName(name = "ZkoLoader")

class ZkoLoader

ZkoObjectProto

@Serializable

data class ZkoObjectProto(val type: ZObjectType, val refId: String, val isReference: Boolean, val zObject: ZObject)

ZkoObjectProtoDef

@Serializable

data class ZkoObjectProtoDef(val type: ZObjectType, val refId: String, val isReference: Boolean, val scene: ZScene?, val group: ZGroup?, val model: ZModel?, val camera: ZCamera?, val skeleton: ZSkeleton?, val light: ZLight?)

ZkoObjectProtoSerializer

class ZkoObjectProtoSerializer(loaderContext: ZLoaderContext) : KSerializer<ZkoObjectProto>

ZLoaderContext

class ZLoaderContext

This class is used to store the components loaded by the engine.

Properties

ZKO_VERSION

const val ZKO_VERSION: String

Current ZKO format version

ZkoVersion

val ZkoVersion: ZSemVer

Current ZKO format version

Functions

createZerializerModule

fun createZerializerModule(): SerializersModule

loadFromAssets

suspend fun loadFromAssets(context: Context, assetPath: String): ZKo

Loads a ZKo from Context.getAssets using a path relative to the assets root (e.g. "gltf/model.zko").

loadFromInternalFile

suspend fun loadFromInternalFile(context: Context, fileName: String): ZKo

Loads a ZKo from the app's private file store (Context.openFileInput), not from assets or arbitrary paths.

loadFromProto

fun loadFromProto(byteArray: ByteArray): ZKo

Decodes a ByteArray into a ZKo object.

loadFromUrl

fun loadFromUrl(url: String): Promise<ZKo>

Loads a ZObject from the specified URL.