SpatialEnvironment.SpatialEnvironmentPreference

public final 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(
    ExrImage skybox,
    GltfModel geometry,
    Material geometryMaterial,
    String geometryMeshName,
    String geometryAnimationName
)

Public methods
boolean
equals(Object other)
final GltfModel

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

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

Public constructors

SpatialEnvironmentPreference

Added in 1.0.0-alpha04
public SpatialEnvironmentPreference(
    ExrImage skybox,
    GltfModel geometry,
    Material geometryMaterial,
    String geometryMeshName,
    String geometryAnimationName
)
Parameters
ExrImage skybox

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

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

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

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

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 methods

equals

public boolean equals(Object other)

getGeometry

Added in 1.0.0-alpha04
public final GltfModel getGeometry()

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

getSkybox

Added in 1.0.0-alpha04
public final ExrImage getSkybox()

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

hashCode

public int hashCode()