FakeXrExtensions.FakeNode
class FakeXrExtensions.FakeNode : Parcelable
A fake implementation of the XR extensions Node.
Summary
Public functions |
|
|---|---|
Int |
|
Float |
getAlpha() |
IBinder? |
|
Float |
|
EnvironmentToken? |
This function is deprecated. This method is no longer supported. |
Executor? |
|
GltfModelToken? |
This function is deprecated. This method is no longer supported. |
Consumer<InputEvent!>? |
|
String? |
getName() |
FakeXrExtensions.FakeNode? |
|
Consumer<Int!>? |
|
ReformOptions? |
|
SurfaceControlViewHost.SurfacePackage? |
|
Executor? |
|
Consumer<NodeTransform!>? |
|
Float |
|
Float |
|
Float |
|
Float |
|
Float |
|
Float |
|
Float |
|
Boolean |
|
Unit |
listenForInput(listener: Consumer<InputEvent!>, executor: Executor)Begins listening for 6DOF input events on this Node, and any descendant Nodes that do not have their own event listener set. |
Unit |
requestPointerCapture(stateCallback: Consumer<Int!>, executor: Executor)Requests pointer capture. |
Unit |
sendInputEvent(event: InputEvent)Fires the InputEvent callback with the given event. |
Unit |
sendTransformEvent(nodeTransform: FakeXrExtensions.FakeNodeTransform)Fires the nodeTransform callback with the given transform. |
Unit |
setNonPointerFocusTarget(focusTarget: AttachedSurfaceControl)Sets the focus target for non-pointer input (eg, keyboard events) when this Node is clicked. |
Unit |
Removes the listener for 6DOF input events from this Node. |
Unit |
Disables previously-requested pointer capture on this node. |
Closeable |
subscribeToTransform(Subscribes to the transform of this node, relative to the OpenXR reference space used as world space for the shared scene. |
Unit |
writeToParcel(in: Parcel, flags: Int) |
Public functions
getEnvironment
fungetEnvironment(): EnvironmentToken?
getPointerCaptureStateCallback
fun getPointerCaptureStateCallback(): Consumer<Int!>?
getSurfacePackage
fun getSurfacePackage(): SurfaceControlViewHost.SurfacePackage?
listenForInput
fun listenForInput(listener: Consumer<InputEvent!>, executor: Executor): Unit
Begins listening for 6DOF input events on this Node, and any descendant Nodes that do not have their own event listener set. The event listener is called on the provided Executor. Calling this method replaces any existing event listener for this node.
requestPointerCapture
fun requestPointerCapture(stateCallback: Consumer<Int!>, executor: Executor): Unit
Requests pointer capture. All XR input events that hit this node or any of its children are delivered as normal; any other input events that would otherwise be dispatched elsewhere will instead be delivered to the input queue of this node (without hit info).
The stateCallback is called immediately with the current state of this pointer capture. Whenever this node is visible and a descendant of a task that is not bounded (is in FSM or overlay space), pointer capture will be active; otherwise it will be paused.
If pointer capture is explicitly stopped by a new call to requestPointerCapture() on the same node, or by a call to stopPointerCapture(), POINTER_CAPTURE_STATE_STOPPED is passed (and the stateCallback will not be called subsequently; also, the app can be sure that no more captured pointer events will be delivered based on that request). This also occurs if the node is destroyed without explicitly stopping pointer capture, or if a new call to requestPointerCapture() is made on the same node without stopping the previous request.
If there are multiple pointer capture requests (eg from other apps) that could be active at the same time, the most recently requested one is activated; all other requests stay paused.
There can only be a single request per Node. If a new requestPointerCapture() call is made on the same node without stopping the previous pointer capture request, the previous request is automatically stopped.
sendInputEvent
fun sendInputEvent(event: InputEvent): Unit
Fires the InputEvent callback with the given event. It is invoked on the executor provided in listenForInput.
sendTransformEvent
fun sendTransformEvent(nodeTransform: FakeXrExtensions.FakeNodeTransform): Unit
Fires the nodeTransform callback with the given transform. It is invoked on the executor provided in listenForInput.
setNonPointerFocusTarget
fun setNonPointerFocusTarget(focusTarget: AttachedSurfaceControl): Unit
Sets the focus target for non-pointer input (eg, keyboard events) when this Node is clicked. The new target is the focusTarget's underlying View Root.
stopListeningForInput
fun stopListeningForInput(): Unit
Removes the listener for 6DOF input events from this Node.
stopPointerCapture
fun stopPointerCapture(): Unit
Disables previously-requested pointer capture on this node. The stateCallback callback will be called with POINTER_CAPTURE_STOPPED.
subscribeToTransform
fun subscribeToTransform(
transformCallback: Consumer<NodeTransform!>,
executor: Executor
): Closeable
Subscribes to the transform of this node, relative to the OpenXR reference space used as world space for the shared scene. See XrExtensions.getOpenXrWorldSpaceType(). The provided matrix transforms a point in this node's local coordinate system into a point in world space coordinates. For example, NodeTransform.getTransform() * (0, 0, 0, 1) is the position of this node in world space. The first non-null transform will be returned immediately after the subscription set-up is complete. Note that the returned closeable must be closed by calling close() to prevent wasting system resources associated with the subscription.
| Parameters | |
|---|---|
transformCallback: Consumer<NodeTransform!> |
a callback that will be called when this node's transform changes. |
executor: Executor |
the executor the callback will be called on. |
| Returns | |
|---|---|
Closeable |
a Closeable that must be used to cancel the subscription by calling |