mirror of
https://github.com/godotengine/godot.git
synced 2024-09-20 14:32:42 +00:00
24 lines
1.8 KiB
XML
24 lines
1.8 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="XROrigin3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<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.
|
|
Multiple origin points can be added to the scene tree, but only one can used at a time. 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 title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link>
|
|
</tutorials>
|
|
<members>
|
|
<member name="current" type="bool" setter="set_current" getter="is_current" default="false">
|
|
If [code]true[/code], this origin node is currently being used by the [XRServer]. Only one origin point can be used at a time.
|
|
</member>
|
|
<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale" default="1.0">
|
|
The scale of the game world compared to the real world. This is the same as [member XRServer.world_scale]. By default, most AR/VR platforms assume that 1 game unit corresponds to 1 real world meter.
|
|
</member>
|
|
</members>
|
|
</class>
|