Skip to content

Commit 5fbc052

Browse files
committed
Docs: Improve WebXRManager page.
1 parent cff4781 commit 5fbc052

File tree

2 files changed

+54
-4
lines changed

2 files changed

+54
-4
lines changed

docs/api/en/renderers/webxr/WebXRManager.html

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,26 @@ <h3>[property:Boolean isPresenting]</h3>
3232

3333
<h2>Methods</h2>
3434

35+
<h3>[method:ArrayCamera getCamera]( [param:PerspectiveCamera camera] )</h3>
36+
<p>
37+
Returns an instance of [page:ArrayCamera] which represents the XR camera of the active XR session.
38+
For each view it holds a separate camera object in its [page:ArrayCamera.cameras cameras] property.
39+
The method requires the non-XR camera of the scene as a parameter.
40+
</p>
41+
3542
<h3>[method:Group getController]( [param:Integer index] )</h3>
3643
<p>
3744
[page:Integer index] — The index of the controller. <br /><br />
3845

39-
Returns a [page:Group] representing the so called *target ray* space of the controller.
46+
Returns a [page:Group] representing the so called *target ray* space of the XR controller.
4047
Use this space for visualizing 3D objects that support the user in pointing tasks like UI interaction.
4148
</p>
4249

4350
<h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
4451
<p>
4552
[page:Integer index] — The index of the controller. <br /><br />
4653

47-
Returns a [page:Group] representing the so called *grip* space of the controller.
54+
Returns a [page:Group] representing the so called *grip* space of the XR controller.
4855
Use this space if the user is going to hold other 3D objects like a lightsaber.
4956
</p>
5057

@@ -54,6 +61,24 @@ <h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
5461
in two different coordinate spaces for the same WebXR controller.
5562
</p>
5663

64+
<h3>[method:Group getHand]( [param:Integer index] )</h3>
65+
<p>
66+
[page:Integer index] — The index of the controller. <br /><br />
67+
68+
Returns a [page:Group] representing the so called *hand* or *joint* space of the XR controller.
69+
Use this space for visualizing the user's hands when no physical controllers are used.
70+
</p>
71+
72+
<h3>[method:String getReferenceSpace]()</h3>
73+
<p>
74+
Returns the reference space.
75+
</p>
76+
77+
<h3>[method:XRSession getSession]()</h3>
78+
<p>
79+
Returns the *XRSession* object which allows a more fine-grained management of active WebXR sessions on application level.
80+
</p>
81+
5782
<h3>[method:void setFramebufferScaleFactor]( [param:Float framebufferScaleFactor] )</h3>
5883
<p>
5984
[page:Float framebufferScaleFactor] — The framebuffer scale factor to set.<br /><br />

docs/api/zh/renderers/webxr/WebXRManager.html

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,19 +32,26 @@ <h3>[property:Boolean isPresenting]</h3>
3232

3333
<h2>Methods</h2>
3434

35+
<h3>[method:ArrayCamera getCamera]( [param:PerspectiveCamera camera] )</h3>
36+
<p>
37+
Returns an instance of [page:ArrayCamera] which represents the XR camera of the active XR session.
38+
For each view it holds a separate camera object in its [page:ArrayCamera.cameras cameras] property.
39+
The method requires the non-XR camera of the scene as a parameter.
40+
</p>
41+
3542
<h3>[method:Group getController]( [param:Integer index] )</h3>
3643
<p>
3744
[page:Integer index] — The index of the controller. <br /><br />
3845

39-
Returns a [page:Group] representing the so called *target ray* space of the controller.
46+
Returns a [page:Group] representing the so called *target ray* space of the XR controller.
4047
Use this space for visualizing 3D objects that support the user in pointing tasks like UI interaction.
4148
</p>
4249

4350
<h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
4451
<p>
4552
[page:Integer index] — The index of the controller. <br /><br />
4653

47-
Returns a [page:Group] representing the so called *grip* space of the controller.
54+
Returns a [page:Group] representing the so called *grip* space of the XR controller.
4855
Use this space if the user is going to hold other 3D objects like a lightsaber.
4956
</p>
5057

@@ -54,6 +61,24 @@ <h3>[method:Group getControllerGrip]( [param:Integer index] )</h3>
5461
in two different coordinate spaces for the same WebXR controller.
5562
</p>
5663

64+
<h3>[method:Group getHand]( [param:Integer index] )</h3>
65+
<p>
66+
[page:Integer index] — The index of the controller. <br /><br />
67+
68+
Returns a [page:Group] representing the so called *hand* or *joint* space of the XR controller.
69+
Use this space for visualizing the user's hands when no physical controllers are used.
70+
</p>
71+
72+
<h3>[method:String getReferenceSpace]()</h3>
73+
<p>
74+
Returns the reference space.
75+
</p>
76+
77+
<h3>[method:XRSession getSession]()</h3>
78+
<p>
79+
Returns the *XRSession* object which allows a more fine-grained management of active WebXR sessions on application level.
80+
</p>
81+
5782
<h3>[method:void setFramebufferScaleFactor]( [param:Float framebufferScaleFactor] )</h3>
5883
<p>
5984
[page:Float framebufferScaleFactor] — The framebuffer scale factor to set.<br /><br />

0 commit comments

Comments
 (0)