SpatialEnvironment.SpatialEnvironmentPreference

class SpatialEnvironment.SpatialEnvironmentPreference

Represents the preferred spatial environment for the application.

Throws
kotlin.IllegalStateException

if the material is not properly set up and if the geometry glTF model does not contain the mesh or the animation name.

Summary

Public constructors
SpatialEnvironmentPreference(
    skybox: ExrImage?,
    geometry: GltfModel?,
    geometryMaterial: Material?,
    geometryMeshName: String?,
    geometryAnimationName: String?
)

Public functions
open operator Boolean
equals(other: Any?)
open Int

Public properties
GltfModel?

The preferred geometry for the environment based on a pre-loaded GltfModel.
ExrImage?

The preferred skybox for the environment based on a pre-loaded EXR Image.

Public constructors

SpatialEnvironmentPreference

Added in 1.0.0-alpha04
SpatialEnvironmentPreference(
    skybox: ExrImage?,
    geometry: GltfModel?,
    geometryMaterial: Material? = null,
    geometryMeshName: String? = null,
    geometryAnimationName: String? = null
)
Parameters
skybox: ExrImage?

The preferred skybox for the environment based on a pre-loaded EXR Image. If null, it will be all black.
geometry: GltfModel?

The preferred geometry for the environment based on a pre-loaded GltfModel. If null, there will be no geometry.
geometryMaterial: Material? = null

The material to override a given mesh in the geometry. If null, the material will not override any mesh.
geometryMeshName: String? = null

The name of the mesh to override with the material. If null, the material will not override any mesh.
geometryAnimationName: String? = null

The name of the animation to play on the geometry. If null, the geometry will not play any animation. Note that the animation will be played in loop.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

geometry

Added in 1.0.0-alpha04
val geometry: GltfModel?

The preferred geometry for the environment based on a pre-loaded GltfModel. If null, there will be no geometry.

skybox

Added in 1.0.0-alpha04
val skybox: ExrImage?

The preferred skybox for the environment based on a pre-loaded EXR Image. If null, it will be all black.