Documentation
¶
Overview ¶
This node takes its parent Path3D, 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 the Progress in this node.
Index ¶
- func CorrectPosture(transform Transform3D.BasisOrigin, rotation_mode RotationMode) Transform3D.BasisOrigin
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) AsPathFollow3D() Instance
- func (self Instance) CubicInterp() bool
- func (self Instance) HOffset() Float.X
- func (self Instance) ID() ID
- func (self Instance) Loop() bool
- func (self Instance) Progress() Float.X
- func (self Instance) ProgressRatio() Float.X
- func (self Instance) RotationMode() RotationMode
- func (self Instance) SetCubicInterp(value bool)
- func (self Instance) SetHOffset(value Float.X)
- func (self Instance) SetLoop(value bool)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetProgress(value Float.X)
- func (self Instance) SetProgressRatio(value Float.X)
- func (self Instance) SetRotationMode(value RotationMode)
- func (self Instance) SetTiltEnabled(value bool)
- func (self Instance) SetUseModelFront(value bool)
- func (self Instance) SetVOffset(value Float.X)
- func (self Instance) TiltEnabled() bool
- func (self Instance) UseModelFront() bool
- func (self Instance) VOffset() Float.X
- func (self Instance) Virtual(name string) reflect.Value
- type RotationMode
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CorrectPosture ¶
func CorrectPosture(transform Transform3D.BasisOrigin, rotation_mode RotationMode) Transform3D.BasisOrigin
Correct the 'transform'. 'rotation_mode' implicitly specifies how posture (forward, up and sideway direction) is calculated.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsPathFollow3D ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.PathFollow3D
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsPathFollow3D ¶
func (Instance) CubicInterp ¶
If true, the position between two cached points is interpolated cubically, and linearly otherwise.
The points along the Curve3D of the Path3D 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.
func (Instance) Loop ¶
If true, any offset outside the path's length will wrap around, instead of stopping at the ends. Use it for cyclic paths.
func (Instance) Progress ¶
The distance from the first vertex, measured in 3D units along the path. Changing this value sets this node's position to a point within the path.
func (Instance) ProgressRatio ¶
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 progress within the path, as the progress supplied is multiplied internally by the path's length.
It can be set or get only if the PathFollow3D is the child of a Path3D which is part of the scene tree, and that this Path3D has a Curve3D with a non-zero length. Otherwise, trying to set this field will print an error, and getting this field will return 0.0.
func (Instance) RotationMode ¶
func (self Instance) RotationMode() RotationMode
Allows or forbids rotation on one or more axes, depending on the RotationMode constants being used.
func (Instance) SetCubicInterp ¶
SetCubicInterp sets the property returned by [GetCubicInterpolation].
func (Instance) SetHOffset ¶
SetHOffset sets the property returned by [GetHOffset].
func (Instance) SetProgress ¶
SetProgress sets the property returned by [GetProgress].
func (Instance) SetProgressRatio ¶
SetProgressRatio sets the property returned by [GetProgressRatio].
func (Instance) SetRotationMode ¶
func (self Instance) SetRotationMode(value RotationMode)
SetRotationMode sets the property returned by [GetRotationMode].
func (Instance) SetTiltEnabled ¶
SetTiltEnabled sets the property returned by [IsTiltEnabled].
func (Instance) SetUseModelFront ¶
SetUseModelFront sets the property returned by [IsUsingModelFront].
func (Instance) SetVOffset ¶
SetVOffset sets the property returned by [GetVOffset].
func (Instance) TiltEnabled ¶
If true, the tilt property of Curve3D takes effect.
func (Instance) UseModelFront ¶
If true, the node moves on the travel path with orienting the +Z axis as forward. See also [Vector3.Forward] and [Vector3.ModelFront].
type RotationMode ¶
type RotationMode int //gd:PathFollow3D.RotationMode
const ( // Forbids the PathFollow3D to rotate. RotationNone RotationMode = 0 // Allows the PathFollow3D to rotate in the Y axis only. RotationY RotationMode = 1 // Allows the PathFollow3D to rotate in both the X, and Y axes. RotationXy RotationMode = 2 // Allows the PathFollow3D to rotate in any axis. RotationXyz RotationMode = 3 // Uses the up vector information in a [Curve3D] to enforce orientation. This rotation mode requires the [Path3D]'s [Curve3D.UpVectorEnabled] property to be set to true. // // [Curve3D]: https://pkg.go.dev/graphics.gd/classdb/Curve3D // [Curve3D.UpVectorEnabled]: https://pkg.go.dev/graphics.gd/classdb/Curve3D#Instance.UpVectorEnabled // [Path3D]: https://pkg.go.dev/graphics.gd/classdb/Path3D RotationOriented RotationMode = 4 )
Source Files