PathFollow

Category: Core

Point sampler for a .

enum RotationMode:

ROTATION_Y = 1 — Allows the PathFollow to rotate in the Y axis only.
ROTATION_XY = 2 — Allows the PathFollow to rotate in both the X, and Y axes.
ROTATION_XYZ = 3 — Allows the PathFollow to rotate in any axis.
ROTATION_ORIENTED = 4 — Uses the up vector information in a Curve3D to enforce orientation. This rotation mode requires the ’s Curve3D.up_vector_enabled property to be set to .

This node takes its parent , and returns the coordinates of a point within it, given a distance from the first vertex.

bool cubic_interp

Setter	set_cubic_interpolation(value)
Getter	get_cubic_interpolation()

If , the position between two cached points is interpolated cubically, and linearly otherwise.

The points along the 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.

loop

Setter	set_loop(value)
Getter	has_loop()

float offset

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.

rotation_mode

Setter	set_rotation_mode(value)
Getter	get_rotation_mode()

Allows or forbids rotation on one or more axes, depending on the RotationMode constants being used.

unit_offset

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.

float v_offset

Setter	set_v_offset(value)
Getter	get_v_offset()

The node’s offset perpendicular to the curve.