Curve3D

Describes a Bezier curve in 3D space.

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.

@GodotBaseClass
struct Curve3D {}

Members

Aliases

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

Functions

_getData
Dictionary _getData()
_setData
void _setData(Dictionary arg0)
addPoint
void addPoint(Vector3 position, Vector3 _in, Vector3 _out, long at_position)

Adds a point to a curve, at "position", with control points "in" and "out". If "at_position" is given, the point is inserted before the point number "at_position", moving that point (and every point after) after the inserted point. If "at_position" is not given, or is an illegal value (at_position <0 or at_position >= getPointCount), the point will be appended at the end of the point list.

clearPoints
void clearPoints()

Removes all points from the curve.

getBakeInterval
double getBakeInterval()
getBakedLength
double getBakedLength()

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

getBakedPoints
PoolVector3Array getBakedPoints()

Returns the cache of points as a PoolVector3Array.

getBakedTilts
PoolRealArray getBakedTilts()

Returns the cache of tilts as a RealArray.

getBakedUpVectors
PoolVector3Array getBakedUpVectors()

Returns the cache of up vectors as a PoolVector3Array. If upVectorEnabled is false, the cache will be empty.

getClosestOffset
double getClosestOffset(Vector3 to_point)

Returns the closest offset to to_point. This offset is meant to be used in one of the interpolate_baked* methods. to_point must be in this curve's local space.

getClosestPoint
Vector3 getClosestPoint(Vector3 to_point)

Returns the closest point (in curve's local space) to to_point. to_point must be in this curve's local space.

getPointCount
long getPointCount()

Returns the number of points describing the curve.

getPointIn
Vector3 getPointIn(long 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).

getPointOut
Vector3 getPointOut(long 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).

getPointPosition
Vector3 getPointPosition(long 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).

getPointTilt
double getPointTilt(long 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.

interpolate
Vector3 interpolate(long idx, double 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).

interpolateBaked
Vector3 interpolateBaked(double offset, bool cubic)

Returns a point 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 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).

interpolateBakedUpVector
Vector3 interpolateBakedUpVector(double offset, bool apply_tilt)

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 apply_tilt 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).

interpolatef
Vector3 interpolatef(double fofs)

Returns the position at the vertex "fofs". It calls interpolate using the integer part of fofs as "idx", and its fractional part as "t".

isUpVectorEnabled
bool isUpVectorEnabled()
opAssign
Curve3D opAssign(T n)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Curve3D 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.
removePoint
void removePoint(long idx)

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

setBakeInterval
void setBakeInterval(double distance)
setPointIn
void setPointIn(long 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.

setPointOut
void setPointOut(long 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.

setPointPosition
void setPointPosition(long 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.

setPointTilt
void setPointTilt(long idx, double 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 or OrientedPathFollow, this tilt is an offset over the natural tilt the PathFollow or OrientedPathFollow calculates.

setUpVectorEnabled
void setUpVectorEnabled(bool enable)
tessellate
PoolVector3Array tessellate(long max_stages, double tolerance_degrees)

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. "max_stages" 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! "tolerance_degrees" controls how many degrees the midpoint of a segment may deviate from the real curve, before the segment has to be subdivided.

Mixins

__anonymous
mixin baseCasts
Undocumented in source.

Properties

_data
Dictionary _data [@property getter]
Dictionary _data [@property setter]
bakeInterval
double bakeInterval [@property getter]
double bakeInterval [@property setter]

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.

upVectorEnabled
bool upVectorEnabled [@property getter]
bool upVectorEnabled [@property setter]

If true, the curve will bake up vectors used for orientation. See OrientedPathFollow. Changing it forces the cache to be recomputed.

Static functions

_new
Curve3D _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