PathFollow3D

package
v0.0.0-...-535787f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

This node takes its parent graphics.gd/classdb/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 Instance.Progress in this node.

Index

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 Any

type Any interface {
	gd.IsClass
	AsPathFollow3D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

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]) AsNode

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsNode3D

func (self *Extension[T]) AsNode3D() Node3D.Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsPathFollow3D

func (self *Extension[T]) AsPathFollow3D() Instance

type ID

type ID Object.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.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

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 New

func New() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsPathFollow3D

func (self Instance) AsPathFollow3D() Instance

func (Instance) CubicInterp

func (self Instance) CubicInterp() bool

func (Instance) HOffset

func (self Instance) HOffset() Float.X

func (Instance) ID

func (self Instance) ID() ID

func (Instance) Loop

func (self Instance) Loop() bool

func (Instance) Progress

func (self Instance) Progress() Float.X

func (Instance) ProgressRatio

func (self Instance) ProgressRatio() Float.X

func (Instance) RotationMode

func (self Instance) RotationMode() RotationMode

func (Instance) SetCubicInterp

func (self Instance) SetCubicInterp(value bool)

func (Instance) SetHOffset

func (self Instance) SetHOffset(value Float.X)

func (Instance) SetLoop

func (self Instance) SetLoop(value bool)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetProgress

func (self Instance) SetProgress(value Float.X)

func (Instance) SetProgressRatio

func (self Instance) SetProgressRatio(value Float.X)

func (Instance) SetRotationMode

func (self Instance) SetRotationMode(value RotationMode)

func (Instance) SetTiltEnabled

func (self Instance) SetTiltEnabled(value bool)

func (Instance) SetUseModelFront

func (self Instance) SetUseModelFront(value bool)

func (Instance) SetVOffset

func (self Instance) SetVOffset(value Float.X)

func (Instance) TiltEnabled

func (self Instance) TiltEnabled() bool

func (Instance) UseModelFront

func (self Instance) UseModelFront() bool

func (Instance) VOffset

func (self Instance) VOffset() Float.X

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

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 [graphics.gd/classdb/Curve3D] to enforce orientation. This rotation mode requires the [graphics.gd/classdb/Path3D]'s [graphics.gd/classdb/Curve3D.Instance.UpVectorEnabled] property to be set to true.
	RotationOriented RotationMode = 4
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL