Point sampler for a Path.
``````    public class PathFollow : Spatial
``````

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.

### Constructors

``````    public PathFollow()
``````

### Properties

``````    public bool CubicInterp { get; set; }
``````

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

``````    public float HOffset { get; set; }
``````

The node’s offset along the curve.

``````    public bool Loop { get; set; }
``````

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

``````    public float Offset { get; set; }
``````

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.

``````    public RotationModeEnum RotationMode { get; set; }
``````

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

``````    public float UnitOffset { get; set; }
``````

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.

``````    public float VOffset { get; set; }
``````

The node’s offset perpendicular to the curve.

### Methods

``````    [Obsolete("GetCubicInterpolation is deprecated. Use the CubicInterp property instead.")]
public bool GetCubicInterpolation()
``````

Getter for CubicInterp

``````    [Obsolete("GetHOffset is deprecated. Use the HOffset property instead.")]
public float GetHOffset()
``````

Getter for HOffset

``````    [Obsolete("GetOffset is deprecated. Use the Offset property instead.")]
public float GetOffset()
``````

Getter for Offset

``````    [Obsolete("GetRotationMode is deprecated. Use the RotationMode property instead.")]
public RotationModeEnum GetRotationMode()
``````

Getter for RotationMode

``````    [Obsolete("GetUnitOffset is deprecated. Use the UnitOffset property instead.")]
public float GetUnitOffset()
``````

Getter for UnitOffset

``````    [Obsolete("GetVOffset is deprecated. Use the VOffset property instead.")]
public float GetVOffset()
``````

Getter for VOffset

``````    [Obsolete("HasLoop is deprecated. Use the Loop property instead.")]
public bool HasLoop()
``````

Getter for Loop

``````    [Obsolete("SetCubicInterpolation is deprecated. Use the CubicInterp property instead.")]
public void SetCubicInterpolation(bool enable)
``````

Setter for CubicInterp

``````    [Obsolete("SetHOffset is deprecated. Use the HOffset property instead.")]
public void SetHOffset(float hOffset)
``````

Setter for HOffset

``````    [Obsolete("SetLoop is deprecated. Use the Loop property instead.")]
public void SetLoop(bool loop)
``````

Setter for Loop

``````    [Obsolete("SetOffset is deprecated. Use the Offset property instead.")]
public void SetOffset(float offset)
``````

Setter for Offset

``````    [Obsolete("SetRotationMode is deprecated. Use the RotationMode property instead.")]
public void SetRotationMode(RotationModeEnum rotationMode)
``````

Setter for RotationMode

``````    [Obsolete("SetUnitOffset is deprecated. Use the UnitOffset property instead.")]
public void SetUnitOffset(float unitOffset)
``````

Setter for UnitOffset

``````    [Obsolete("SetVOffset is deprecated. Use the VOffset property instead.")]
public void SetVOffset(float vOffset)
``````

Setter for VOffset

### Inner Types

#### RotationModeEnum

Name Value Description
None 0 Forbids the PathFollow to rotate.
Y 1 Allows the PathFollow to rotate in the Y axis only.
Xy 2 Allows the PathFollow to rotate in both the X, and Y axes.
Xyz 3 Allows the PathFollow to rotate in any axis.
Oriented 4 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].
Tags: