Describes a Bezier curve in 3D space.
public class Curve3D : Resource

This class describes a Bezier curve in 3D space. It is mainly used to give a shape to a Path, but can be manually sampled for other purposes.

It keeps a cache of precalculated points along the curve, to speed further calculations up.

Constructors

public Curve3D()

Properties

public Collections.Dictionary _Data { get; set; }

public float BakeInterval { get; set; }

The distance in meters between two adjacent cached points. Changing it forces the cache to be recomputed the next time the GetBakedPoints() or GetBakedLength() function is called. The smaller the distance, the more points in the cache and the more memory it will consume, so use with care.

public bool UpVectorEnabled { get; set; }

If true, the curve will bake up vectors used for orientation. This is used when a PathFollow.RotationMode is set to ROTATION_ORIENTED, see PathFollow for details. Changing it forces the cache to be recomputed.

Methods

public void AddPoint(Vector3 position, Vector3? @in = default(Vector3?), Vector3? @out = default(Vector3?), int atPosition = -1)

Adds a point to a curve, at position, with control points in and out.

If atPosition is given, the point is inserted before the point number atPosition, moving that point (and every point after) after the inserted point. If atPosition is not given, or is an illegal value (at_position <0 or at_position >= [GetPointCount()](../Godot.Curve3D/#GetPointCount())), the point will be appended at the end of the point list.

public void ClearPoints()

Removes all points from the curve.

public float GetBakedLength()

Returns the total length of the curve, based on the cached points. Given enough density (see BakeInterval), it should be approximate enough.

public Vector3[] GetBakedPoints()

Returns the cache of points as a PoolVector3Array.

public float[] GetBakedTilts()

Returns the cache of tilts as a PoolRealArray.

public Vector3[] GetBakedUpVectors()

Returns the cache of up vectors as a PoolVector3Array.

If UpVectorEnabled is false, the cache will be empty.

public float GetBakeInterval()

Getter for BakeInterval

public float GetClosestOffset(Vector3 toPoint)

Returns the closest offset to toPoint. This offset is meant to be used in InterpolateBaked(float, bool) or InterpolateBakedUpVector(float, bool).

toPoint must be in this curve’s local space.

public Vector3 GetClosestPoint(Vector3 toPoint)

Returns the closest point (in curve’s local space) to toPoint.

toPoint must be in this curve’s local space.

public int GetPointCount()

Returns the number of points describing the curve.

public Vector3 GetPointIn(int idx)

Returns the position of the control point leading to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).

public Vector3 GetPointOut(int idx)

Returns the position of the control point leading out of the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).

public Vector3 GetPointPosition(int idx)

Returns the position of the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).

public float GetPointTilt(int idx)

Returns the tilt angle in radians for the point idx. If the index is out of bounds, the function sends an error to the console, and returns 0.

public Vector3 Interpolate(int idx, float t)

Returns the position between the vertex idx and the vertex idx + 1, where t controls if the point is the first vertex (t = 0.0), the last vertex (t = 1.0), or in between. Values of t outside the range (0.0 >= t <=1) give strange, but predictable results.

If idx is out of bounds it is truncated to the first or last vertex, and t is ignored. If the curve has no points, the function sends an error to the console, and returns (0, 0, 0).

public Vector3 InterpolateBaked(float offset, bool cubic = false)

Returns a point within the curve at position offset, where offset is measured as a pixel distance along the curve.

To do that, it finds the two cached points where the offset lies between, then interpolates the values. This interpolation is cubic if cubic is set to true, or linear if set to false.

Cubic interpolation tends to follow the curves better, but linear is faster (and often, precise enough).

public Vector3 InterpolateBakedUpVector(float offset, bool applyTilt = false)

Returns an up vector within the curve at position offset, where offset is measured as a distance in 3D units along the curve.

To do that, it finds the two cached up vectors where the offset lies between, then interpolates the values. If applyTilt is true, an interpolated tilt is applied to the interpolated up vector.

If the curve has no up vectors, the function sends an error to the console, and returns (0, 1, 0).

public Vector3 Interpolatef(float fofs)

Returns the position at the vertex fofs. It calls Interpolate(int, float) using the integer part of fofs as idx, and its fractional part as t.

public bool IsUpVectorEnabled()

Getter for UpVectorEnabled

public void RemovePoint(int idx)

Deletes the point idx from the curve. Sends an error to the console if idx is out of bounds.

public void SetBakeInterval(float distance)

Setter for BakeInterval

public void SetPointIn(int idx, Vector3 position)

Sets the position of the control point leading to the vertex idx. If the index is out of bounds, the function sends an error to the console.

public void SetPointOut(int idx, Vector3 position)

Sets the position of the control point leading out of the vertex idx. If the index is out of bounds, the function sends an error to the console.

public void SetPointPosition(int idx, Vector3 position)

Sets the position for the vertex idx. If the index is out of bounds, the function sends an error to the console.

public void SetPointTilt(int idx, float tilt)

Sets the tilt angle in radians for the point idx. If the index is out of bounds, the function sends an error to the console.

The tilt controls the rotation along the look-at axis an object traveling the path would have. In the case of a curve controlling a PathFollow, this tilt is an offset over the natural tilt the PathFollow calculates.

public void SetUpVectorEnabled(bool enable)

Setter for UpVectorEnabled

public Vector3[] Tessellate(int maxStages = 5, float toleranceDegrees = 4f)

Returns a list of points along the curve, with a curvature controlled point density. That is, the curvier parts will have more points than the straighter parts.

This approximation makes straight segments between each point, then subdivides those segments until the resulting shape is similar enough.

maxStages controls how many subdivisions a curve segment may face before it is considered approximate enough. Each subdivision splits the segment in half, so the default 5 stages may mean up to 32 subdivisions per curve segment. Increase with care!

toleranceDegrees controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.

Tags: