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 descendants of this node. Then, when setting an offset in this node, the descendant nodes will move accordingly.

@GodotBaseClass

struct PathFollow {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(PathFollow other);

PathFollow opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static PathFollow _new();

enum RotationMode;

enum Constants;

void setOffset(double offset);

double getOffset();

void setHOffset(double h_offset);

double getHOffset();

void setVOffset(double v_offset);

double getVOffset();

void setUnitOffset(double unit_offset);

double getUnitOffset();

void setRotationMode(long rotation_mode);

PathFollow.RotationMode getRotationMode();

void setCubicInterpolation(bool enable);

bool getCubicInterpolation();

void setLoop(bool loop);

bool hasLoop();

double offset [@property getter];

double offset [@property setter];

double unitOffset [@property getter];

double unitOffset [@property setter];

double hOffset [@property getter];

double hOffset [@property setter];

double vOffset [@property getter];

double vOffset [@property setter];

PathFollow.RotationMode rotationMode [@property getter];

long rotationMode [@property setter];

bool cubicInterp [@property getter];

bool cubicInterp [@property setter];

bool loop [@property getter];

bool loop [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
RotationMode enum RotationMode

Functions

getCubicInterpolation bool getCubicInterpolation()
getHOffset double getHOffset()
getOffset double getOffset()
getRotationMode PathFollow.RotationMode getRotationMode()
getUnitOffset double getUnitOffset()
getVOffset double getVOffset()
hasLoop bool hasLoop()
opAssign PathFollow opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(PathFollow other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
setCubicInterpolation void setCubicInterpolation(bool enable)
setHOffset void setHOffset(double h_offset)
setLoop void setLoop(bool loop)
setOffset void setOffset(double offset)
setRotationMode void setRotationMode(long rotation_mode)
setUnitOffset void setUnitOffset(double unit_offset)
setVOffset void setVOffset(double v_offset)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

cubicInterp bool cubicInterp [@property setter]: 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.
cubicInterp bool cubicInterp [@property getter]: 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.
hOffset double hOffset [@property getter]
double hOffset [@property setter]: The node's offset along the curve.
loop bool loop [@property getter]
bool loop [@property setter]: If true, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
offset double offset [@property getter]
double offset [@property setter]: 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.
rotationMode PathFollow.RotationMode rotationMode [@property getter]
long rotationMode [@property setter]: Allows or forbids rotation on one or more axes, depending on the constants being used.
unitOffset double unitOffset [@property getter]
double unitOffset [@property setter]: 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.
vOffset double vOffset [@property getter]
double vOffset [@property setter]: The node's offset perpendicular to the curve.

Static functions

_new PathFollow _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot pathfollow structs

PathFollow