Skip to content

Docs: Improve WebXRManager page. #21880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 24, 2021
Merged

Docs: Improve WebXRManager page. #21880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions docs/api/en/renderers/webxr/WebXRManager.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,26 @@ <h3>[property:Boolean isPresenting]</h3>

<h2>Methods</h2>

<h3>[method:ArrayCamera getCamera]( [param:PerspectiveCamera camera] )</h3>
<p>
Returns an instance of [page:ArrayCamera] which represents the XR camera of the active XR session.
For each view it holds a separate camera object in its [page:ArrayCamera.cameras cameras] property.
The method requires the non-XR camera of the scene as a parameter.
</p>

<h3>[method:Group getController]( [param:Integer index] )</h3>
<p>
[page:Integer index] — The index of the controller. <br /><br />

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

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

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

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

<h3>[method:Group getHand]( [param:Integer index] )</h3>
<p>
[page:Integer index] — The index of the controller. <br /><br />

Returns a [page:Group] representing the so called *hand* or *joint* space of the XR controller.
Use this space for visualizing the user's hands when no physical controllers are used.
</p>

<h3>[method:String getReferenceSpace]()</h3>
<p>
Returns the reference space.
</p>

<h3>[method:XRSession getSession]()</h3>
<p>
Returns the *XRSession* object which allows a more fine-grained management of active WebXR sessions on application level.
</p>

<h3>[method:void setFramebufferScaleFactor]( [param:Float framebufferScaleFactor] )</h3>
<p>
[page:Float framebufferScaleFactor] — The framebuffer scale factor to set.<br /><br />
Expand Down
29 changes: 27 additions & 2 deletions docs/api/zh/renderers/webxr/WebXRManager.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,26 @@ <h3>[property:Boolean isPresenting]</h3>

<h2>Methods</h2>

<h3>[method:ArrayCamera getCamera]( [param:PerspectiveCamera camera] )</h3>
<p>
Returns an instance of [page:ArrayCamera] which represents the XR camera of the active XR session.
For each view it holds a separate camera object in its [page:ArrayCamera.cameras cameras] property.
The method requires the non-XR camera of the scene as a parameter.
</p>

<h3>[method:Group getController]( [param:Integer index] )</h3>
<p>
[page:Integer index] — The index of the controller. <br /><br />

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

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

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

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

<h3>[method:Group getHand]( [param:Integer index] )</h3>
<p>
[page:Integer index] — The index of the controller. <br /><br />

Returns a [page:Group] representing the so called *hand* or *joint* space of the XR controller.
Use this space for visualizing the user's hands when no physical controllers are used.
</p>

<h3>[method:String getReferenceSpace]()</h3>
<p>
Returns the reference space.
</p>

<h3>[method:XRSession getSession]()</h3>
<p>
Returns the *XRSession* object which allows a more fine-grained management of active WebXR sessions on application level.
</p>

<h3>[method:void setFramebufferScaleFactor]( [param:Float framebufferScaleFactor] )</h3>
<p>
[page:Float framebufferScaleFactor] — The framebuffer scale factor to set.<br /><br />
Expand Down