godot/doc/classes/XROrigin3D.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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 16:08:05 +08:00			`<class name="XROrigin3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`<brief_description>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-22 07:04:47 +08:00			`The origin point in AR/VR.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</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.`
Tweak XROrigin3D documentation 2024-01-21 22:50:27 +08:00			`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.`
Docs: Language fixes in ARVR reference 2019-01-16 16:44:35 +08:00			`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.`
Tweak XROrigin3D documentation 2024-01-21 22:50:27 +08:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Fix tutorial links in XR classes docs 2022-07-22 20:05:31 +08:00			`<link title="XR documentation index">$DOCS_URL/tutorials/xr/index.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
Add current setting to XROrigin3D and fix double positioning HMD 2022-07-29 12:18:05 +08:00			`<member name="current" type="bool" setter="set_current" getter="is_current" default="false">`
Tweak XROrigin3D documentation 2024-01-21 22:50:27 +08:00			`If [code]true[/code], this origin node is currently being used by the [XRServer]. Only one origin point can be used at a time.`
Add current setting to XROrigin3D and fix double positioning HMD 2022-07-29 12:18:05 +08:00			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 18:38:01 +08:00			`<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale" default="1.0">`
Tweak XROrigin3D documentation 2024-01-21 22:50:27 +08:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-13 04:42:36 +08:00			`</member>`
			`</members>`
			`</class>`