From e74a3add9cfb0fd1138c08b4f278da90933fb355 Mon Sep 17 00:00:00 2001 From: "Danilo Villa (Davi)" Date: Fri, 11 Jan 2019 17:03:12 -0200 Subject: Rename OrientedPathFollow to PathFollowOriented --- doc/classes/Curve3D.xml | 4 ++-- doc/classes/OrientedPathFollow.xml | 40 -------------------------------------- doc/classes/PathFollow.xml | 3 +++ 3 files changed, 5 insertions(+), 42 deletions(-) delete mode 100644 doc/classes/OrientedPathFollow.xml (limited to 'doc/classes') diff --git a/doc/classes/Curve3D.xml b/doc/classes/Curve3D.xml index b2e64f96a6..e9ee1c6974 100644 --- a/doc/classes/Curve3D.xml +++ b/doc/classes/Curve3D.xml @@ -225,7 +225,7 @@ Sets the tilt angle in radians for the point [code]idx[/code]. If the index is out of bounds, the function sends an error to the console. - The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow] or [OrientedPathFollow], this tilt is an offset over the natural tilt the [PathFollow] or [OrientedPathFollow] calculates. + The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a [PathFollow], this tilt is an offset over the natural tilt the [PathFollow] calculates. @@ -248,7 +248,7 @@ The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the [method get_baked_points] or [method get_baked_length] function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care. - If [code]true[/code], the curve will bake up vectors used for orientation. See [OrientedPathFollow]. Changing it forces the cache to be recomputed. + If [code]true[/code], the curve will bake up vectors used for orientation. This is used when a [member PathFollow.rotation_mode] is set to [code]ROTATION_ORIENTED[/code], see [PathFollow] for details. Changing it forces the cache to be recomputed. diff --git a/doc/classes/OrientedPathFollow.xml b/doc/classes/OrientedPathFollow.xml deleted file mode 100644 index 665e3af6b2..0000000000 --- a/doc/classes/OrientedPathFollow.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - Oriented point sampler for a [Path]. - - - This node behaves like [PathFollow], except it uses its parent [Path] up vector information to enforce orientation. - Make sure to check if the curve of this node's parent [Path] has up vectors enabled. See [PathFollow] and [Curve3D] for further information. - - - - - - - - - - If [code]true[/code], the position between two cached points is interpolated cubically, and linearly otherwise. - The points along the [Curve3D] of the [Path] 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. - - - The node's offset along the curve. - - - 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. - - - The distance from the first vertex, measured in 3D units along the path. This sets this node's position to a point within the path. - - - 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 offset within the path, as the offset supplied is multiplied internally by the path's length. - - - The node's offset perpendicular to the curve. - - - - - diff --git a/doc/classes/PathFollow.xml b/doc/classes/PathFollow.xml index ed4a805a00..da4782a7c3 100644 --- a/doc/classes/PathFollow.xml +++ b/doc/classes/PathFollow.xml @@ -51,5 +51,8 @@ Allows the PathFollow to rotate in any axis. + + Uses the up vector information in a [Curve3D] to enforce orientation. This rotation mode requires the [Path]'s [member Curve3D.up_vector_enabled] property to be set to [code]true[/code]. + -- cgit v1.2.3