PathFollow

    Point sampler for a Path.

    This node takes its parent Path, 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 an offset in this node.

    enum RotationMode:

    • 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 to enforce orientation. This rotation mode requires the Path‘s property to be set to true.

    Default

    true

    Setter

    set_cubic_interpolation(value)

    Getter

    get_cubic_interpolation()

    If true, 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.

    • h_offset

    The node’s offset along the curve.

    Default

    true

    Setter

    set_loop(value)

    Getter

    has_loop()

    If true, any offset outside the path’s length will wrap around, instead of stopping at the ends. Use it for cyclic paths.

    • 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.

    Default

    3

    Setter

    set_rotation_mode(value)

    Getter

    get_rotation_mode()

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

    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.

    Default

    0.0

    Setter

    set_v_offset(value)

    Getter

    get_v_offset()