diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-04-09 09:44:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-09 09:44:24 +0200 |
| commit | c5f71ecc6a60e5a92a1f711a1368e051d4824b25 (patch) | |
| tree | 9b77798e59f05f968c26649ef9bafd6f0c5def2f /doc/classes/XROrigin3D.xml | |
| parent | 23d786d6fbcd374f464155c5f17f1951a664ece9 (diff) | |
| parent | afc8c6391ccc2d3d69dcad0d93b2639bfe77dc55 (diff) | |
Merge pull request #37694 from BastiaanOlij/arvr_to_xr
The great ARVR to XR rename!
Diffstat (limited to 'doc/classes/XROrigin3D.xml')
| -rw-r--r-- | doc/classes/XROrigin3D.xml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/classes/XROrigin3D.xml b/doc/classes/XROrigin3D.xml new file mode 100644 index 0000000000..57cf673d30 --- /dev/null +++ b/doc/classes/XROrigin3D.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="XROrigin3D" inherits="Node3D" version="4.0"> + <brief_description> + The origin point in AR/VR. + </brief_description> + <description> + This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world. + There should be only one of these nodes in your scene and you must have one. All the XRCamera3D, XRController3D and XRAnchor3D nodes should be direct children of this node for spatial tracking to work correctly. + It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point. + For example, if your character is driving a car, the XROrigin3D node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. + </description> + <tutorials> + <link>https://docs.godotengine.org/en/latest/tutorials/vr/index.html</link> + </tutorials> + <methods> + </methods> + <members> + <member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale" default="1.0"> + Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. + [b]Note:[/b] This method is a passthrough to the [XRServer] itself. + </member> + </members> + <constants> + </constants> +</class> |