Curve3D¶
Inherits: Resource < Reference < Object
Category: Core
Brief Description¶
Describes a Bezier curve in 3D space.
Member Functions¶
| void | add_point ( Vector3 pos, Vector3 in=Vector3(0, 0, 0), Vector3 out=Vector3(0, 0, 0), int atpos=-1 ) |
| void | clear_points ( ) |
| float | get_bake_interval ( ) const |
| float | get_baked_length ( ) const |
| Vector3Array | get_baked_points ( ) const |
| RealArray | get_baked_tilts ( ) const |
| int | get_point_count ( ) const |
| Vector3 | get_point_in ( int idx ) const |
| Vector3 | get_point_out ( int idx ) const |
| Vector3 | get_point_pos ( int idx ) const |
| float | get_point_tilt ( int idx ) const |
| Vector3 | interpolate ( int idx, float t ) const |
| Vector3 | interpolate_baked ( float offset, bool cubic=false ) const |
| Vector3 | interpolatef ( float fofs ) const |
| void | remove_point ( int idx ) |
| void | set_bake_interval ( float distance ) |
| void | set_point_in ( int idx, Vector3 pos ) |
| void | set_point_out ( int idx, Vector3 pos ) |
| void | set_point_pos ( int idx, Vector3 pos ) |
| void | set_point_tilt ( int idx, float tilt ) |
| Vector3Array | tesselate ( int max_stages=5, float tolerance_degrees=4 ) const |
Description¶
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.
Member Function Description¶
- void add_point ( Vector3 pos, Vector3 in=Vector3( 0, 0, 0 ), Vector3 out=Vector3( 0, 0, 0 ), int atpos=null )
Adds a point to a curve, at position “pos”, with control points “in” and “out”.
If “atpos” is given, the point is inserted before the point number “atpos”, moving that point (and every point after) after the inserted point. If “atpos” is not given, or is an illegal value (atpos <0 or atpos >= get_point_count), the point will be appended at the end of the point list.
- void clear_points ( )
- float get_bake_interval ( ) const
Returns the distance between two adjacent cached points.
- float get_baked_length ( ) const
Returns the total length of the curve, based on the cached points. Given enough density (see set_bake_interval), it should be approximate enough.
- PoolVector3Array get_baked_points ( ) const
Returns the cache of points as a PoolVector3Array.
- PoolRealArray get_baked_tilts ( ) const
Returns the cache of tilts as a RealArray.
- int get_point_count ( ) const
Returns the number of points describing the curve.
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).
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).
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).
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.
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).
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).
Returns the position at the vertex “fofs”. It calls interpolate using the integer part of fofs as “idx”, and its fractional part as “t”.
- void remove_point ( int idx )
Deletes the point “idx” from the curve. Sends an error to the console if “idx” is out of bounds.
- void set_bake_interval ( float distance )
Sets the distance in 3D units between two adjacent cached points. Changing it forces the cache to be recomputed the next time a xxx_baked_xxx function is called. The less distance, the more points the cache will have, and the more memory it will consume, so use with care.
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.
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.
Sets the position for the vertex “idx”. If the index is out of bounds, the function sends an error to the console.
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.
- PoolVector3Array tessellate ( int max_stages=4, float tolerance_degrees=5 ) const
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.