API reference
API reference
Select your platform
No SDKs available
No versions available

Scene Class

Modifiers: final
Scene class for representing the 3D scene. This class provides methods for querying the scene, managing scene objects, handling input interactions, and configuring the environment settings.

Signature

class Scene(val spatialInterface: SpatialInterface)

Constructors

Scene ( spatialInterface )
Signature 
constructor(spatialInterface: SpatialInterface)
Parameters
spatialInterface: SpatialInterface
Returns

Properties

handle : Long
[Get]
Signature 
val handle: Long
spatialInterface : SpatialInterface
[Get]
Signature 
val spatialInterface: SpatialInterface

Functions

addObject ( ro )
Add a SceneObject to this Scene.
Signature 
fun addObject(ro: SceneObject)
Parameters
: The SceneObject to add.
createCylinderLayer ( sceneSwapChain , radius , centralAngle , aspectRatio , pivotX , pivotY , stereoMode , sceneObject )
Create a Layer that is shaped like a cylinder.
Signature 
fun createCylinderLayer(sceneSwapChain: SceneSwapchain, radius: Float, centralAngle: Float, aspectRatio: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject): Int
Parameters
sceneSwapChain: SceneSwapchain
The swap chain to create the quad layer for.
radius: Float
The radius of the cylinder.
centralAngle: Float
The central angle of the cylinder.
aspectRatio: Float
The aspect ratio of the Layer.
pivotX: Float
The pivot point of the Layer in the x dimension.
pivotY: Float
The pivot point of the Layer in the y dimension.
stereoMode: StereoMode
The stereoMode of the Layer.
sceneObject: SceneObject
The sceneObject of the Layer.
Returns
Int
The new cylinder layer.
createEquirectLayer ( sceneSwapChain , radius , centralHorizontalAngle , upperVerticalAngle , lowerVerticalAngle , pivotX , pivotY , stereoMode , sceneObject )
Create a Layer that maps equirectangular images onto a sphere.
Signature 
fun createEquirectLayer(sceneSwapChain: SceneSwapchain, radius: Float, centralHorizontalAngle: Float, upperVerticalAngle: Float, lowerVerticalAngle: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject): Int
Parameters
sceneSwapChain: SceneSwapchain
The swap chain to create the quad layer for.
radius: Float
The radius of the sphere.
centralHorizontalAngle: Float
The central angle of the sphere.
upperVerticalAngle: Float
The upper vertical angle of the sphere.
lowerVerticalAngle: Float
The lower vertical angle of the sphere.
pivotX: Float
The pivot point of the Layer in the y dimension.
pivotY: Float
The pivot point of the Layer in the x dimension.
stereoMode: StereoMode
The stereo mode of the Layer.
sceneObject: SceneObject
The sceneObject of the Layer.
Returns
Int
the equirectangular layer.
createQuadLayer ( sceneSwapChain , dimW , dimH , pivotX , pivotY , stereoMode , sceneObject )
Create a Layer that is shaped like a quad.
Signature 
fun createQuadLayer(sceneSwapChain: SceneSwapchain, dimW: Float, dimH: Float, pivotX: Float, pivotY: Float, stereoMode: StereoMode, sceneObject: SceneObject): Int
Parameters
sceneSwapChain: SceneSwapchain
The swap chain to create the quad layer for.
dimW: Float
The width of the Layer.
dimH: Float
The height of the Layer.
pivotX: Float
The pivot point of the Layer in the x dimension.
pivotY: Float
The pivot point of the Layer in the y dimension.
stereoMode: StereoMode
The stereo mode of the Layer.
sceneObject: SceneObject
The scene object for the Layer.
Returns
Int
The new quad layer.
destroyObject ( ro )
Remove and destroy a SceneObject from this Scene.
Signature 
fun destroyObject(ro: SceneObject)
Parameters
: The SceneObject to remove.
discoverSpaces ( fetchOptions )
Find all the space.
Signature 
fun discoverSpaces(fetchOptions: Anchor.FetchOptions): CompletableFuture<Array<Anchor>>
Parameters
fetchOptions: Anchor.FetchOptions
The options to use.
Returns
CompletableFuture
A future containing an aray of anchors.
drawDebugLine ( from , to , color , displayCount )
Draw a line in the Scene, often used for debugging.
Signature 
fun drawDebugLine(from: Vector3, to: Vector3, color: Color, displayCount: Int)
Parameters
from: Vector3
The origin of the line.
to: Vector3
The destination of the line.
color: Color
The color of the line.
displayCount: Int
How many frames to draw this for.
drawDebugLine ( from , to , startColor , endColor , displayCount )
Draw a line in the Scene, often used for debugging.
Signature 
fun drawDebugLine(from: Vector3, to: Vector3, startColor: Color, endColor: Color, displayCount: Int)
Parameters
from: Vector3
The origin of the line.
to: Vector3
The destination of the line.
startColor: Color
The color at the origin of the line.
endColor: Color
The color at the end of the line.
displayCount: Int
How many frames to draw this for.
enableEnvironmentDepth ( enabled )
Experimental: Enable environment depth. May not work.
Signature 
fun enableEnvironmentDepth(enabled: Boolean)
Parameters
enabled: Boolean
Whether the environment depth is enabled or not.
enableHolePunching ( enabled )
Tells the renderer to render poseable layers before rendering out the scene. This means the app will be responsible for hole-punching the layers.
See our Layers and UI Quality docs for more information.
Signature 
fun enableHolePunching(enabled: Boolean)
Parameters
enabled: Boolean
enableMrPlaneTracker ( enabled )
Enable the MR plane tracker.
Signature 
fun enableMrPlaneTracker(enabled: Boolean)
Parameters
enabled: Boolean
Whether the plane tracker should be enabled or not.
enablePassthrough ( enabled )
Enable pass through of the real world into the scene.
Signature 
fun enablePassthrough(enabled: Boolean)
Parameters
enabled: Boolean
enableVirtualCamera ( enable )
Enable the virtual camera.
Signature 
fun enableVirtualCamera(enable: Boolean)
Parameters
enable: Boolean
Whether to enable the virtual camera.
getAnchorBoundary2D ( anchorHandle )
Get the 2D boundary of an anchor.
Signature 
fun getAnchorBoundary2D(anchorHandle: Long): Array<Vector2>
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
Array
An array of Vector2 objects representing the boundary.
getAnchorBoundingBox2D ( anchorHandle )
Get the 2D bounding box of an anchor.
Signature 
fun getAnchorBoundingBox2D(anchorHandle: Long): Bound2D?
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
The 2D bounds represented a as a Bound2D object.
getAnchorBoundingBox3D ( anchorHandle )
Get the 3D bounding box for an anchor.
Signature 
fun getAnchorBoundingBox3D(anchorHandle: Long): Bound3D?
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
The 3D bounds represeted as a Bound3D object.
getAnchorPose ( anchorHandle )
Get the pose of an anchor.
Signature 
fun getAnchorPose(anchorHandle: Long): Pose
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
The pose of the anchor.
getAnchorPose ( index )
Get the pose of an anchor.
Signature 
fun getAnchorPose(index: Int): Pose
Parameters
index: Int
Returns
getAnchorSemanticLabels ( anchorHandle )
Get the semantic lables for an anchor.
Signature 
fun getAnchorSemanticLabels(anchorHandle: Long): List<String>
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
List
A list of strings.
getAnchorSemanticLabels ( index )
Get the semantic labels for an anchor by index.
Signature 
fun getAnchorSemanticLabels(index: Int): String
Parameters
index: Int
Returns
String
The semantic labels.
getConfirmedFrameRate ()
Signature 
fun getConfirmedFrameRate(): Float
Returns
Float
getControllerPoseAtTime ( isLeftHandle , time )
Get the pose of the controller at a given time.
Signature 
fun getControllerPoseAtTime(isLeftHandle: Boolean, time: Long): ControllerPose
Parameters
isLeftHandle: Boolean
Whether this is the left controller or not.
time: Long
The nanoseconds time from boot to get the pose at. SystemClock.elapsedTimeNanos()
Returns
The pose of the controller at the given time.
getEyeOffsets ()
Get the current eye offsets for the stereo camera system.
Eye offsets describe the relative position of each eye from the center of the head. Positive X values offset to the right, Positive Y values offsets up, and positive Z offsets forward. Rotation of eyes is the same as head position.
Signature 
fun getEyeOffsets(): Pair<Vector3, Vector3><Vector3, Vector3>
Returns
Pair<Vector3, Vector3>
A pair containing two Vector3 objects: Pair(leftEyeOffset, rightEyeOffset).
getNumberOfObjects ()
Get the number of SceneObjects in the scene.
Signature 
fun getNumberOfObjects(): Int
Returns
Int
The number of SceneObjects in the scene.
getSessionStartPose ()
Returns the pose that was set at the beginning of the session. This is useful for setting the starting position of entities so that they are placed relative to the user.
Signature 
fun getSessionStartPose(): Pose
Returns
The start pose at the beginning of the session.
getSpaceContainer ( anchorHandle )
Get the space container from an anchor.
Signature 
fun getSpaceContainer(anchorHandle: Long): Array<UUID>
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
Array
An array of UUIDs.
getSpaceRoomLayout ( anchorHandle )
Get the RoomLayout from an anchor handle.
Signature 
fun getSpaceRoomLayout(anchorHandle: Long): Anchor.RoomLayout
Parameters
anchorHandle: Long
The handle to an anchor.
Returns
Anchor.RoomLayout
the roomlayout associated with the anchor handle.
getSpaceTriangleMesh ( anchorHandle )
Get the space triangle mesh associated with an anchor handle.
Signature 
fun getSpaceTriangleMesh(anchorHandle: Long): Anchor.SpaceTriangleMesh
Parameters
anchorHandle: Long
The anchor handle.
Returns
Anchor.SpaceTriangleMesh
The space triangle mesh.
getViewerPose ()
Get the viewer's pose in the Scene.
Signature 
fun getViewerPose(): Pose
Returns
Pose of the viewer.
getViewOrigin ()
Returns the last position that viewer's orgin was set to.
Signature 
fun getViewOrigin(): Vector3
Returns
A vector containing the viewer's position.
getViewSceneRotation ()
Get the last rotation of the viewer, with X+ being 0 degrees.
Signature 
fun getViewSceneRotation(): Float
Returns
Float
The last rotation of the viewer in degrees.
hasObject ( ro )
Check if a SceneObject is part of this Scene.
Signature 
fun hasObject(ro: SceneObject): Boolean
Parameters
The SceneObject to check for.
Returns
Boolean
True if the SceneObject is part of this Scene.
isSystemPassthroughEnabled ()
Is the passthrough system enabled. Returns true if the app is launched in passthrough mode and false if in immersive mode. This value is set at the app launch and will not change during the app's lifetime.
Signature 
fun isSystemPassthroughEnabled(): Boolean
Returns
Boolean
Whether or not the passthrough system is enabled or not.
lineSegmentIntersect ( from , to )
Test if a line segment intersects with anything in the scene.
Signature 
fun lineSegmentIntersect(from: Vector3, to: Vector3): HitInfo?
Parameters
from: Vector3
The origin of the line segment.
to: Vector3
The destination of the line segment.
Returns
The information related to a hit in a HitInfo object.
loadRenderModelMesh ( path )
Load a render model mesh given a path to a device. This uses the XR_FB_render_model OpenXR extension.
Signature 
fun loadRenderModelMesh(path: String): SceneMesh?
Parameters
path: String
The to a device or controller. For example: "/model_fb/controller/left".
Returns
The SceneMesh representing the device.
onClick ( hitInfo , sourceOfInput )
Handler for pointer clicks that click on a SceneObject.
Signature 
fun onClick(hitInfo: HitInfo, sourceOfInput: Entity)
Parameters
hitInfo: HitInfo
The information related to the hit against the SceneObject.
sourceOfInput: Entity
The entity that was hit.
onClickDown ( hitInfo , sourceOfInput )
Handler for pointer clicking down events that occur on a SceneObject.
Signature 
fun onClickDown(hitInfo: HitInfo, sourceOfInput: Entity)
Parameters
hitInfo: HitInfo
The information related to the hit against the SceneObject.
sourceOfInput: Entity
The entity that was hit.
onHoverStart ( sceneObjectHandle , sourceOfInput )
Handler for when a pointer start to hover over a SceneObject.
Signature 
fun onHoverStart(sceneObjectHandle: Long, sourceOfInput: Entity)
Parameters
sceneObjectHandle: Long
The handle to SceneObject being hovered.
sourceOfInput: Entity
The entity that was hit.
onHoverStop ( sceneObjectHandle , sourceOfInput )
Handler for when a pointer stops hovering over a SceneObject.
Signature 
fun onHoverStop(sceneObjectHandle: Long, sourceOfInput: Entity)
Parameters
sceneObjectHandle: Long
The handle to SceneObject being hovered.
sourceOfInput: Entity
The entity that was hit.
onInput ( hitInfo , sourceOfInput , changedIn , buttonState )
Handler for when we receive input that does intersect with SceneObjects.
Signature 
fun onInput(hitInfo: HitInfo, sourceOfInput: Entity, changedIn: Int, buttonState: Int): Boolean
Parameters
hitInfo: HitInfo
sourceOfInput: Entity
The entity which was the source of this input.
changedIn: Int
The bit mask of buttons that were changed.
buttonState: Int
The bit mask of buttons that were clicked.
Returns
Boolean
onNoIntersectionInput ( sourceOfInput , changedIn , buttonState )
Handler for when we receive input that does not intersect with any SceneObjects.
Signature 
fun onNoIntersectionInput(sourceOfInput: Entity, changedIn: Int, buttonState: Int)
Parameters
sourceOfInput: Entity
The entity which was the source of this input.
changedIn: Int
The bit mask of buttons that were changed.
buttonState: Int
The bit mask of button state.
playBackgroundSound ( soundAsset , volume , looping )
Plays a sound which attached to the user pose, there is ony one background sound. The sound equivalent to an environment box
Signature 
fun playBackgroundSound(soundAsset: SceneAudioAsset, volume: Float, looping: Boolean)
Parameters
soundAsset: SceneAudioAsset
The SceneAudioAsset to use.
volume: Float
The volume level of the sound.
looping: Boolean
Whether to loop playing this sound.
playSound ( soundAsset , position , volume )
Plays a sound within the 3d environment. The sound spatialization will update depending on head movement.
Signature 
fun playSound(soundAsset: SceneAudioAsset, position: Vector3, volume: Float = 1.0f)
Parameters
soundAsset: SceneAudioAsset
The SceneAudioAsset to use.
position: Vector3
The position that the sound should come from.
volume: Float
The volume level of the sound.
playSound ( soundfile , entity , volume )
Plays a sound within the 3d environment. The sound spatialization will update depending on head movement
Signature 
fun playSound(soundfile: SceneAudioAsset, entity: Entity, volume: Float = 1.0f)
Parameters
soundfile: SceneAudioAsset
The SceneAudioAsset to use.
entity: Entity
The entity from which the sound should come from.
volume: Float
The volume level of the sound.
playSound ( soundAsset , volume )
Plays a sound which is attached to the user pose
Signature 
fun playSound(soundAsset: SceneAudioAsset, volume: Float = 1.0f)
Parameters
soundAsset: SceneAudioAsset
The SceneAudioAsset to use.
volume: Float
The volume level of the sound.
processQueries ( dataModel )
Process queries on a data model.
Signature 
fun processQueries(dataModel: DataModel): Boolean
Parameters
dataModel: DataModel
Returns
Boolean
Whether or not queries were successfully processed.
rayArcIntersect ( from , forward , gravity , steps , color )
Draws and intersects a ray arc in the scene.
Signature 
fun rayArcIntersect(from: Vector3, forward: Vector3, gravity: Vector3, steps: Int, color: Color = Color.valueOf(Color.TRANSPARENT)): HitInfo?
Parameters
from: Vector3
The origin of the arc.
forward: Vector3
The forward diretion of the arc.
gravity: Vector3
The gravity that will bend the arc.
steps: Int
The number of segments used to represent this arc.
color: Color
The color used to draw this arc.
Returns
reloadShaders ( baseDir , vertexShaders , fragmentShaders )
Hot-reloads the given shaders at runtime. This functionality may be disabled.
Signature 
fun reloadShaders(baseDir: String, vertexShaders: List<String>, fragmentShaders: List<String>)
Parameters
baseDir: String
The base directory to load the shaders from. This is usually the external storage.
vertexShaders: List
The list of vertex shaders to load (relative to both the baseDir and the assets directory).
fragmentShaders: List
The list of fragment shaders to load (relative to both the baseDir and the assets directory).
removeLayer ( id )
Remove a Layer form the Scene.
Signature 
fun removeLayer(id: Int)
Parameters
id: Int
The id of the Layer.
requestSceneCapture ()
Request scene capture.
Signature 
fun requestSceneCapture(): CompletableFuture<Unit>
Returns
CompletableFuture
resetSessionStartPose ()
This function resets the session start pose to the current pose. This can be used to reset the session start pose when the user moves around.
Signature 
fun resetSessionStartPose()
setDepthParams ( minDepth , maxDepth )
Set the depth parameters on the Scene.
Signature 
fun setDepthParams(minDepth: Float, maxDepth: Float)
Parameters
minDepth: Float
The minimum depth of the Scene.
maxDepth: Float
The maximum depth of the Scene.
setGlobalTransformScale ( scale )
Sets the global scale factor applied to all transforms in the transform system. This scale is applied globally to all entities during transform calculations.
Signature 
fun setGlobalTransformScale(scale: Vector3)
Parameters
scale: Vector3
The global scale factor to apply (x, y, z components)
setGlobalTransformScale ( scaleX , scaleY , scaleZ )
Sets the global scale factor applied to all transforms in the transform system. This scale is applied globally to all entities during transform calculations.
Signature 
fun setGlobalTransformScale(scaleX: Float, scaleY: Float, scaleZ: Float)
Parameters
scaleX: Float
The global scale factor for the X axis
scaleY: Float
The global scale factor for the Y axis
scaleZ: Float
The global scale factor for the Z axis
setLayerAlphaBlend ( id , srcFactorColor , dstFactorColor , srcFactorAlpha , dstFactorAlpha )
Set the alpha blend factors on a Layer. The integers correspond to the different layer alpha blend factors.
Signature 
fun setLayerAlphaBlend(id: Int, srcFactorColor: Int, dstFactorColor: Int, srcFactorAlpha: Int, dstFactorAlpha: Int)
Parameters
id: Int
srcFactorColor: Int
The blend factor on the source color.
dstFactorColor: Int
The blend factor on the destination color.
srcFactorAlpha: Int
The blend factor on the source alpha.
dstFactorAlpha: Int
The blend factor on the destination alpha.
setLayerClip ( id , minLeftU , minLeftV , maxLeftU , maxLeftV , minRightU , minRightV , maxRightU , maxRightV )
Set clip bounds on a Layer in UV space.
Signature 
fun setLayerClip(id: Int, minLeftU: Float, minLeftV: Float, maxLeftU: Float, maxLeftV: Float, minRightU: Float = minLeftU, minRightV: Float = minLeftV, maxRightU: Float = maxLeftU, maxRightV: Float = maxLeftV)
Parameters
id: Int
The Layer's id.
minLeftU: Float
The minimum left U value of the bounds.
minLeftV: Float
The minimum left V value of the bounds.
maxLeftU: Float
The maximum left U value of the bounds.
maxLeftV: Float
The maximum left V value of the bounds.
minRightU: Float
minRightV: Float
maxRightU: Float
maxRightV: Float
setLayerColorScaleBias ( id , scaleR , scaleG , scaleB , scaleA , biasR , biasG , biasB , biasA )
Set the scale and bias on the color of a Layer.
Signature 
fun setLayerColorScaleBias(id: Int, scaleR: Float, scaleG: Float, scaleB: Float, scaleA: Float, biasR: Float, biasG: Float, biasB: Float, biasA: Float)
Parameters
id: Int
The id of the Layer.
scaleR: Float
The scaling in the red dimension.
scaleG: Float
The scaling in the green dimension.
scaleB: Float
The scaling in the blue dimension.
scaleA: Float
The scaling in the alpha dimension.
biasR: Float
The bias in the red dimension.
biasG: Float
The bias in the green dimension.
biasB: Float
The bias in the blue dimension.
biasA: Float
The bias in the alpha dimension.
setLayerFilters ( id , filters )
Applies the specified layer filters
Signature 
fun setLayerFilters(id: Int, filters: Int)
Parameters
id: Int
The id of the Layer.
filters: Int
the composited filters to apply to the Layer
setLayerScale ( id , x , y , z )
Set the scale of a Layer in the Scene.
Signature 
fun setLayerScale(id: Int, x: Float, y: Float, z: Float)
Parameters
id: Int
The id of the Layer.
x: Float
The scaling in the x dimension.
y: Float
The scaling in the y dimension.
z: Float
The scaling in the z dimension.
setLayerSecure ( id , secureLayer )
When set to true ensures the layer can not be copied or captured by other apps.
Signature 
fun setLayerSecure(id: Int, secureLayer: Boolean)
Parameters
id: Int
The id of the Layer.
secureLayer: Boolean
Whether to enable secure layers.
setLayerZIndex ( id , zIndex )
Set a Layer's Z index in depth ordering (default 0). If layers have the same z index, we will try to sort by distance to viewer.
Signature 
fun setLayerZIndex(id: Int, zIndex: Int)
Parameters
id: Int
The Layer's id.
zIndex: Int
The z index in depth ordering.
setLightingEnvironment ( ambientColor , sunColor , sunDirection , environmentIntensity )
Set the lighting environment for this Scene.
Signature 
fun setLightingEnvironment(ambientColor: Vector3, sunColor: Vector3, sunDirection: Vector3, environmentIntensity: Float = 1.0f)
Parameters
ambientColor: Vector3
The ambient color of the environment.
sunColor: Vector3
The color of the sun.
sunDirection: Vector3
The direction of the sun.
environmentIntensity: Float
The intensity of the environment.
setPassthroughLUT ( lut )
Sets a custom lookup table for color grading passthrough rendering. Passing null will remove any existing LUT, resetting passthrough to default colors.
Signature 
fun setPassthroughLUT(lut: Lut?)
Parameters
lut: Lut?
setPreferredDisplayRate ( rate )
Set the preferred display rate.
Signature 
fun setPreferredDisplayRate(rate: Float): Boolean
Parameters
rate: Float
The display rate.
Returns
Boolean
True if the display rate was set successfully. False otherwise.
setReferenceSpace ( space )
Sets the current OpenXR reference space. This may be wanted if you are working on a Mixed Reality vs purely Virtual Reality app.
For more details, see the OpenXR documentation⁠.
Signature 
fun setReferenceSpace(space: ReferenceSpace)
Parameters
The reference space to use.
setSecureLayers ( secureLayers )
When set to true ensures the layers can not be copied or captured by other apps.
Signature 
fun setSecureLayers(secureLayers: Boolean)
Parameters
secureLayers: Boolean
Whether to enable secure layers.
setSkipRender ( skipRender )
UNSTABLE API. When set to true skips the rendering of the scene
Signature 
fun setSkipRender(skipRender: Boolean)
Parameters
skipRender: Boolean
setSpaceComponentStatus ( anchorHandle , type , enable , timeoutNs )
Set the component status of a space.
Signature 
fun setSpaceComponentStatus(anchorHandle: Long, type: Anchor.SpaceComponentType, enable: Boolean, timeoutNs: Long = 0): CompletableFuture<Void>
Parameters
anchorHandle: Long
The anchor handle
type: Anchor.SpaceComponentType
The type of the space.
enable: Boolean
Whether this is enabled.
timeoutNs: Long
When to timeout this space.
Returns
CompletableFuture
A completable future of void.
setViewOrigin ( x , y , z )
Moves the viewer to the specified location.
Signature 
fun setViewOrigin(x: Float, y: Float, z: Float)
Parameters
x: Float
The x component of the viewer's position.
y: Float
The y component of the viewer's position.
z: Float
The z component of the viewer's position.
setViewOrigin ( x , y , z , degRotation )
Moves the viewer to the specified location, facing the specified direction.
Signature 
fun setViewOrigin(x: Float, y: Float, z: Float, degRotation: Float)
Parameters
x: Float
The x component of the viewer's position.
y: Float
The y component of the viewer's position.
z: Float
The z component of the viewer's position.
degRotation: Float
The angular component of the viewer's orientation.
setVirtualCameraPose ( pose )
Set the virtual camera pose.
Signature 
fun setVirtualCameraPose(pose: Pose)
Parameters
pose: Pose
The pose of the virtual camera.
stopBackgroundSound ()
Stop playing the background sound.
Signature 
fun stopBackgroundSound()
tickMRScene ()
Process one tick of the Scene.
Signature 
fun tickMRScene()
updateCylinderLayer ( id , radius , centralAngle , aspectRatio , pivotX , pivotY , stereoMode )
Update a cylinder layer with new parameters.
Signature 
fun updateCylinderLayer(id: Int, radius: Float, centralAngle: Float, aspectRatio: Float, pivotX: Float, pivotY: Float, stereoMode: Int)
Parameters
id: Int
The id of the Layer.
radius: Float
The radius of the cylinder.
centralAngle: Float
The central angle of the cylinder.
aspectRatio: Float
The aspect ratio of the Layer.
pivotX: Float
The pivot point of the Layer in the x dimension.
pivotY: Float
The pivot point of the Layer in the y dimension.
stereoMode: Int
The stereoMode of the Layer.
updateEquirectLayer ( id , radius , centralHorizontalAngle , upperVerticalAngle , lowerVerticalAngle , pivotX , pivotY , stereoMode )
Update an equirectangular layer with new parameters.
Signature 
fun updateEquirectLayer(id: Int, radius: Float, centralHorizontalAngle: Float, upperVerticalAngle: Float, lowerVerticalAngle: Float, pivotX: Float, pivotY: Float, stereoMode: Int)
Parameters
id: Int
radius: Float
The radius of the sphere.
centralHorizontalAngle: Float
The central angle of the sphere.
upperVerticalAngle: Float
The upper vertical angle of the sphere.
lowerVerticalAngle: Float
The lower vertical angle of the sphere.
pivotX: Float
The pivot point of the Layer in the y dimension.
pivotY: Float
The pivot point of the Layer in the x dimension.
stereoMode: Int
The stereo mode of the Layer.
updateIBLEnvironment ( envFilename )
Update IBL environment with an image filename.
Signature 
fun updateIBLEnvironment(envFilename: String)
Parameters
envFilename: String
The file path to use relative to your app's asset directory (.env extension)
updateQuadLayer ( id , dimW , dimH , pivotX , pivotY , stereoMode )
Update a quad layer with new parameters.
Signature 
fun updateQuadLayer(id: Int, dimW: Float, dimH: Float, pivotX: Float, pivotY: Float, stereoMode: Int)
Parameters
id: Int
The id of the Layer.
dimW: Float
The width of the Layer.
dimH: Float
The height of the Layer.
pivotX: Float
The pivot point of the Layer in the x dimension.
pivotY: Float
The pivot point of the Layer in the y dimension.
stereoMode: Int
The stereo mode of the Layer.
updateViewOrigin ( deltaMove , deltaRotation )
Offset the viewer by a certain amount.
Signature 
fun updateViewOrigin(deltaMove: Float, deltaRotation: Float)
Parameters
deltaMove: Float
Distance to move after the rotation
deltaRotation: Float
Amount to rotate around the Y axis in degrees.
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta