sceneview/io.github.sceneview.model

Package-level declarations

Types

Model

typealias Model = FilamentAsset

ModelInstance

typealias ModelInstance = FilamentInstance

Properties

cameras

val ModelInstance.cameras: List<Camera>

camerasEntities

val ModelInstance.camerasEntities: List<Entity>

collisionShape

val Model.collisionShape: Box

emptyNodeEntities

val ModelInstance.emptyNodeEntities: List<Entity>

engine

val ModelInstance.engine: Engine

isShadowCaster

var ModelInstance.isShadowCaster: Boolean

Changes whether or not the renderable casts shadows.

isShadowReceiver

var ModelInstance.isShadowReceiver: Boolean

Changes whether or not the renderable can receive shadows.

lightEntities

val ModelInstance.lightEntities: List<Entity>

lightEntityInstances

val ModelInstance.lightEntityInstances: List<EntityInstance>

lightManager

val ModelInstance.lightManager: LightManager

materialInstances

var ModelInstance.materialInstances: Map<EntityInstance, List<MaterialInstance>>

Changes the material instances binding for the given primitives.

model

val ModelInstance.model: FilamentAsset

renderableEntities

val ModelInstance.renderableEntities: List<Entity>

renderableInstances

val ModelInstance.renderableInstances: List<EntityInstance>

renderableManager

val ModelInstance.renderableManager: RenderableManager

renderableNames

val Model.renderableNames: List<String>

renderablesPrimitiveCounts

val ModelInstance.renderablesPrimitiveCounts: Map<EntityInstance, Int>

Gets the immutable number of primitives in the renderables.

Functions

asDeferred

fun <T : Renderable, B : Renderable.Builder<T, B>> Renderable.Builder<T, B>.asDeferred(engine: Engine): Deferred<T>

Deferred renderable loading is a non-blocking cancellable future.

attachSkin

fun ModelInstance.attachSkin(target: Node, @IntRange(from = 0) skinIndex: Int = 0)

Attaches the given skin to the given node, which must have an associated mesh with BONE_INDICES and BONE_WEIGHTS attributes.

await

suspend fun <T : Renderable, B : Renderable.Builder<T, B>> Renderable.Builder<T, B>.await(engine: Engine): T

Awaits for loading a Renderable with the parameters of the builder without blocking a thread.

build

suspend fun <T : Renderable, B : Renderable.Builder<T, B>> Renderable.Builder<T, B>.build(engine: Engine, coroutineScope: LifecycleCoroutineScope)

Load a Renderable in a coroutine scope without blocking a thread.

detachSkin

fun ModelInstance.detachSkin(target: Node, @IntRange(from = 0) skinIndex: Int = 0)

Attaches the given skin to the given node, which must have an associated mesh with BONE_INDICES and BONE_WEIGHTS attributes.

getAnimationIndex

fun Animator.getAnimationIndex(animationName: String): Int?

getRenderableByName

fun Model.getRenderableByName(name: String): Entity?

setBlendOrder

fun ModelInstance.setBlendOrder(@IntRange(from = 0, to = 65535) blendOrder: Int)

Changes the drawing order for blended primitives.

setCulling

fun ModelInstance.setCulling(enabled: Boolean)

Changes whether or not frustum culling is on.

setGlobalBlendOrderEnabled

fun ModelInstance.setGlobalBlendOrderEnabled(enabled: Boolean)

Changes whether the blend order is global or local to this Renderable (by default).

setLayerMask

fun ModelInstance.setLayerMask(@IntRange(from = 0, to = 255) select: Int, @IntRange(from = 0, to = 255) value: Int)

Changes the visibility bits.

setMorphWeights

fun ModelInstance.setMorphWeights(weights: FloatArray, @IntRange(from = 0) offset: Int = weights.size)

Updates the vertex morphing weights on a renderable, all zeroes by default.

setPriority

fun ModelInstance.setPriority(@IntRange(from = 0, to = 7) priority: Int)

Changes the coarse-level draw ordering.

setScreenSpaceContactShadows

fun ModelInstance.setScreenSpaceContactShadows(enabled: Boolean)

Changes whether or not the renderable can use screen-space contact shadows.