akasha.xr

Class XRInputSourceArray

java.lang.Object

akasha.core.JsObject

akasha.xr.XRInputSourceArray

All Implemented Interfaces:

JsIterable<XRInputSourceArray.Entry>

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XRInputSourceArray")
public class XRInputSourceArray
extends JsObject
implements JsIterable<XRInputSourceArray.Entry>

The interface XRInputSourceArray represents a live list of WebXR input sources, and is used as the return value of the XRSession property inputSources. Each entry is an XRInputSource representing one input device connected to the WebXR system.

See Also:

XRInputSourceArray - MDN, # xrinputsourcearray-interface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XRInputSourceArray.Entry
static interface	XRInputSourceArray.ForEachCallback
static interface	XRInputSourceArray.ForEachCallback2
static interface	XRInputSourceArray.ForEachCallback3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XRInputSourceArray()

Method Summary

Modifier and Type	Method and Description
@JsNonNull JsIterator<XRInputSourceArray.Entry>	entries() The XRInputSourceArray interface's entries() method returns a JavaScript iterator which can then be used to iterate over the key/value pairs in the input source array.
void	forEach(@JsNonNull XRInputSourceArray.ForEachCallback callback) The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.
void	forEach(@JsNonNull XRInputSourceArray.ForEachCallback2 callback) The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.
void	forEach(@JsNonNull XRInputSourceArray.ForEachCallback3 callback) The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.
@JsNonNull XRInputSource	getAt(int index)
@JsNonNull JsIterator<java.lang.Double>	keys() The keys() method in the XRInputSourceArray interface returns a JavaScript iterator which can then be used to iterate over the keys used to reference each item in the array of input sources.
int	length() The read-only length property returns an integer value indicating the number of items in the input source list represented by the XRInputSourceArray object.
@JsNonNull JsIterator<XRInputSource>	values() The XRInputSourceArray method values() returns a JavaScript iterator that can walk over the list of XRInputSource objects contained in the array, from first to last.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface akasha.lang.JsIterable

iterator

Constructor Detail

XRInputSourceArray

protected XRInputSourceArray()

Method Detail

length

@JsProperty(name="length")
public int length()

The read-only length property returns an integer value indicating the number of items in the input source list represented by the XRInputSourceArray object.

See Also:

XRInputSourceArray.length - MDN

getAt

@JsOverlay
public final @JsNonNull XRInputSource getAt(int index)

keys

public @JsNonNull JsIterator<java.lang.Double> keys()

The keys() method in the XRInputSourceArray interface returns a JavaScript iterator which can then be used to iterate over the keys used to reference each item in the array of input sources.

See Also:

XRInputSourceArray.keys - MDN, XRInputSourceArray - WebXR Device API

values

public @JsNonNull JsIterator<XRInputSource> values()

The XRInputSourceArray method values() returns a JavaScript iterator that can walk over the list of XRInputSource objects contained in the array, from first to last.

See Also:

XRInputSourceArray.values - MDN, XRInputSourceArray - WebXR Device API

entries

public @JsNonNull JsIterator<XRInputSourceArray.Entry> entries()

The XRInputSourceArray interface's entries() method returns a JavaScript iterator which can then be used to iterate over the key/value pairs in the input source array.

See Also:

XRInputSourceArray.entries - MDN, XRInputSourceArray - WebXR Device API

forEach

public void forEach(@JsNonNull XRInputSourceArray.ForEachCallback callback)

The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.

See Also:

XRInputSourceArray.forEach - MDN, XRInputSourceArray - WebXR Device API

forEach

public void forEach(@JsNonNull XRInputSourceArray.ForEachCallback2 callback)

The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.

See Also:

XRInputSourceArray.forEach - MDN, XRInputSourceArray - WebXR Device API

forEach

public void forEach(@JsNonNull XRInputSourceArray.ForEachCallback3 callback)

The XRInputSourceArray method forEach() executes the specified callback once for each input source in the array, starting at index 0 and progressing until the end of the list.

See Also:

XRInputSourceArray.forEach - MDN, XRInputSourceArray - WebXR Device API