virtualx-engine/doc/classes/ARVROrigin.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ARVROrigin" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Our 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 ARVRCamera, ARVRController and ARVRAnchor 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 you're 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.
		So say that your character is driving a car, the ARVROrigin node should be a child node of this car. If you implement a teleport system to move your character, you change the position of this node. Etc.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_world_scale" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Get the world scale applied to our positioning.
			</description>
		</method>
		<method name="set_world_scale">
			<return type="void">
			</return>
			<argument index="0" name="world_scale" type="float">
			</argument>
			<description>
				Changes the world scaling factor.
				Most AR/VR platforms will assume a unit size of 1 unit in your game world = 1 meter in the real world. This scale allows you to adjust this to the unit system you use in your game. 
				Note that this method is a passthrough to the ARVRServer itself.
			</description>
		</method>
	</methods>
	<members>
		<member name="world_scale" type="float" setter="set_world_scale" getter="get_world_scale">
		</member>
	</members>
	<constants>
	</constants>
</class>