Curve3D
Hereda: Resource < RefCounted < Object
Describe una curva de Bézier en el espacio 3D.
Descripción
This class describes a Bézier curve in 3D space. It is mainly used to give a shape to a Path3D, but can be manually sampled for other purposes.
It keeps a cache of precalculated points along the curve, to speed up further calculations.
Propiedades
|
||
|
||
|
||
|
Métodos
void |
add_point(position: Vector3, in: Vector3 = Vector3(0, 0, 0), out: Vector3 = Vector3(0, 0, 0), index: int = -1) |
void |
|
get_baked_length() const |
|
get_baked_points() const |
|
get_baked_tilts() const |
|
get_baked_up_vectors() const |
|
get_closest_offset(to_point: Vector3) const |
|
get_closest_point(to_point: Vector3) const |
|
get_point_in(idx: int) const |
|
get_point_out(idx: int) const |
|
get_point_position(idx: int) const |
|
get_point_tilt(idx: int) const |
|
void |
remove_point(idx: int) |
sample_baked(offset: float = 0.0, cubic: bool = false) const |
|
sample_baked_up_vector(offset: float, apply_tilt: bool = false) const |
|
sample_baked_with_rotation(offset: float = 0.0, cubic: bool = false, apply_tilt: bool = false) const |
|
void |
set_point_in(idx: int, position: Vector3) |
void |
set_point_out(idx: int, position: Vector3) |
void |
set_point_position(idx: int, position: Vector3) |
void |
set_point_tilt(idx: int, tilt: float) |
tessellate(max_stages: int = 5, tolerance_degrees: float = 4) const |
|
tessellate_even_length(max_stages: int = 5, tolerance_length: float = 0.2) const |
Descripciones de Propiedades
La distancia en metros entre dos puntos cacheados adyacentes. Cambiarlo obliga a recomponer la caché la próxima vez que se llame a la función get_baked_points() o get_baked_length(). Cuanto más pequeña sea la distancia, más puntos en la caché y más memoria consumirá, así que úsala con cuidado.
Si es true y la curva tiene más de 2 puntos de control, el último punto y el primero se conectarán en un bucle.
El número de puntos que describen la curva.
bool up_vector_enabled = true 🔗
Si es true, la curva calculará los vectores utilizados para la orientación. Esto se utiliza cuando PathFollow3D.rotation_mode se establece en PathFollow3D.ROTATION_ORIENTED. Cambiar esto fuerza a que la caché se vuelva a calcular.
Descripciones de Métodos
void add_point(position: Vector3, in: Vector3 = Vector3(0, 0, 0), out: Vector3 = Vector3(0, 0, 0), index: int = -1) 🔗
Adds a point with the specified position relative to the curve's own position, with control points in and out. Appends the new point at the end of the point list.
If index is given, the new point is inserted before the existing point identified by index index. Every existing point starting from index is shifted further down the list of points. The index must be greater than or equal to 0 and must not exceed the number of existing points in the line. See point_count.
void clear_points() 🔗
Elimina todos los puntos de la curva.
float get_baked_length() const 🔗
Devuelve la longitud total de la curva, basada en los puntos cacheados. Si se le da suficiente densidad (véase bake_interval), debe ser bastante aproximada.
PackedVector3Array get_baked_points() const 🔗
Returns the cache of points as a PackedVector3Array.
PackedFloat32Array get_baked_tilts() const 🔗
Returns the cache of tilts as a PackedFloat32Array.
PackedVector3Array get_baked_up_vectors() const 🔗
Returns the cache of up vectors as a PackedVector3Array.
If up_vector_enabled is false, the cache will be empty.
float get_closest_offset(to_point: Vector3) const 🔗
Returns the closest offset to to_point. This offset is meant to be used in sample_baked() or sample_baked_up_vector().
to_point must be in this curve's local space.
Vector3 get_closest_point(to_point: Vector3) const 🔗
Returns the closest point on baked segments (in curve's local space) to to_point.
to_point must be in this curve's local space.
Vector3 get_point_in(idx: int) const 🔗
Returns the position of the control point leading to the vertex idx. The returned position is relative to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
Vector3 get_point_out(idx: int) const 🔗
Returns the position of the control point leading out of the vertex idx. The returned position is relative to the vertex idx. If the index is out of bounds, the function sends an error to the console, and returns (0, 0, 0).
Vector3 get_point_position(idx: int) const 🔗
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).
float get_point_tilt(idx: int) const 🔗
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.
Deletes the point idx from the curve. Sends an error to the console if idx is out of bounds.
Vector3 sample(idx: int, t: float) const 🔗
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).
Vector3 sample_baked(offset: float = 0.0, cubic: bool = false) const 🔗
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).
Vector3 sample_baked_up_vector(offset: float, apply_tilt: bool = false) const 🔗
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).
Transform3D sample_baked_with_rotation(offset: float = 0.0, cubic: bool = false, apply_tilt: bool = false) const 🔗
Devuelve un Transform3D con origin como posición del punto, basis.x como vector lateral, basis.y como vector superior, basis.z como vector frontal. Cuando la longitud de la curva es 0, no hay una forma razonable de calcular la rotación, todos los vectores se alinean con los ejes del espacio global. Véase también sample_baked().
Vector3 samplef(fofs: float) const 🔗
Returns the position at the vertex fofs. It calls sample() using the integer part of fofs as idx, and its fractional part as t.
void set_point_in(idx: int, position: Vector3) 🔗
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. The position is relative to the vertex.
void set_point_out(idx: int, position: Vector3) 🔗
Establece la posición del punto de control que sale del vértice idx. Si el índice está fuera de los límites, la función envía un error a la consola. La posición es relativa al vértice.
void set_point_position(idx: int, position: Vector3) 🔗
Establece la posición para el vértice idx. Si el índice está fuera de los límites, la función envía un error a la consola.
void set_point_tilt(idx: int, tilt: float) 🔗
Establece el ángulo de inclinación en radianes para el punto idx. Si el índice está fuera de los límites, la función envía un error a la consola.
La inclinación controla la rotación a lo largo del eje de visión que tendría un objeto que viaja por el trayecto. En el caso de una curva que controla un PathFollow3D, esta inclinación es un desplazamiento sobre la inclinación natural que calcula el PathFollow3D.
PackedVector3Array tessellate(max_stages: int = 5, tolerance_degrees: float = 4) 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.
PackedVector3Array tessellate_even_length(max_stages: int = 5, tolerance_length: float = 0.2) const 🔗
Returns a list of points along the curve, with almost uniform density. 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_length controls the maximal distance between two neighboring points, before the segment has to be subdivided.