virtualx-engine/doc/classes/PathFollow3D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PathFollow3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Point sampler for a [Path3D].
	</brief_description>
	<description>
		This node takes its parent [Path3D], and returns the coordinates of a point within it, given a distance from the first vertex.
		It is useful for making other nodes follow a path, without coding the movement pattern. For that, the nodes must be children of this node. The descendant nodes will then move accordingly when setting the [member progress] in this node.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="correct_posture" qualifiers="static">
			<return type="Transform3D" />
			<param index="0" name="transform" type="Transform3D" />
			<param index="1" name="rotation_mode" type="int" enum="PathFollow3D.RotationMode" />
			<description>
				Correct the [param transform]. [param rotation_mode] implicitly specifies how posture (forward, up and sideway direction) is calculated.
			</description>
		</method>
	</methods>
	<members>
		<member name="cubic_interp" type="bool" setter="set_cubic_interpolation" getter="get_cubic_interpolation" default="true">
			If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise.
			The points along the [Curve3D] of the [Path3D] are precomputed before use, for faster calculations. The point at the requested offset is then calculated interpolating between two adjacent cached points. This may present a problem if the curve makes sharp turns, as the cached points may not follow the curve closely enough.
			There are two answers to this problem: either increase the number of cached points and increase memory consumption, or make a cubic interpolation between two points at the cost of (slightly) slower calculations.
		</member>
		<member name="h_offset" type="float" setter="set_h_offset" getter="get_h_offset" default="0.0">
			The node's offset along the curve.
		</member>
		<member name="loop" type="bool" setter="set_loop" getter="has_loop" default="true">
			If [code]true[/code], any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
		</member>
		<member name="progress" type="float" setter="set_progress" getter="get_progress" default="0.0">
			The distance from the first vertex, measured in 3D units along the path. Changing this value sets this node's position to a point within the path.
		</member>
		<member name="progress_ratio" type="float" setter="set_progress_ratio" getter="get_progress_ratio" default="0.0">
			The distance from the first vertex, considering 0.0 as the first vertex and 1.0 as the last. This is just another way of expressing the progress within the path, as the progress supplied is multiplied internally by the path's length.
		</member>
		<member name="rotation_mode" type="int" setter="set_rotation_mode" getter="get_rotation_mode" enum="PathFollow3D.RotationMode" default="3">
			Allows or forbids rotation on one or more axes, depending on the [enum RotationMode] constants being used.
		</member>
		<member name="tilt_enabled" type="bool" setter="set_tilt_enabled" getter="is_tilt_enabled" default="true">
			If [code]true[/code], the tilt property of [Curve3D] takes effect.
		</member>
		<member name="use_model_front" type="bool" setter="set_use_model_front" getter="is_using_model_front" default="false">
			If [code]true[/code], the node moves on the travel path with orienting the +Z axis as forward. See also [constant Vector3.FORWARD] and [constant Vector3.MODEL_FRONT].
		</member>
		<member name="v_offset" type="float" setter="set_v_offset" getter="get_v_offset" default="0.0">
			The node's offset perpendicular to the curve.
		</member>
	</members>
	<constants>
		<constant name="ROTATION_NONE" value="0" enum="RotationMode">
			Forbids the PathFollow3D to rotate.
		</constant>
		<constant name="ROTATION_Y" value="1" enum="RotationMode">
			Allows the PathFollow3D to rotate in the Y axis only.
		</constant>
		<constant name="ROTATION_XY" value="2" enum="RotationMode">
			Allows the PathFollow3D to rotate in both the X, and Y axes.
		</constant>
		<constant name="ROTATION_XYZ" value="3" enum="RotationMode">
			Allows the PathFollow3D to rotate in any axis.
		</constant>
		<constant name="ROTATION_ORIENTED" value="4" enum="RotationMode">
			Uses the up vector information in a [Curve3D] to enforce orientation. This rotation mode requires the [Path3D]'s [member Curve3D.up_vector_enabled] property to be set to [code]true[/code].
		</constant>
	</constants>
</class>