Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
Curve3D
Hereda: Resource < RefCounted < Object
Describe una curva de Bézier en el espacio 3D.
Descripción
Esta clase describe una curva Bézier en el espacio 3D. Se utiliza principalmente para dar una forma a un Path3D, pero puede ser muestreada manualmente para otros propósitos.
Mantiene una caché de puntos precalculados a lo largo de la curva, para acelerar los cálculos posteriores.
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.
Vector3 point_{index}/in = Vector3(0, 0, 0) 🔗
La posición del punto de control que conduce al vértice en index.
Nota: index es un valor en el rango 0 .. point_count - 1.
Vector3 point_{index}/out = Vector3(0, 0, 0) 🔗
La posición del punto de control que sale del vértice en el índice.
Nota: El índice es un valor en el rango de 0 .. contar_puntos - 1.
Vector3 point_{index}/position = Vector3(0, 0, 0) 🔗
The position of for the vertex at index.
Note: index is a value in the 0 .. point_count - 1 range.
float point_{index}/tilt = 0.0 🔗
El ángulo de inclinación en radianes para el punto en index.
Nota: index es un valor en el rango 0 .. point_count - 1.
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) 🔗
Añade un punto con la position especificada relativa a la posición de la propia curva, con los puntos de control in y out. Añade el nuevo punto al final de la lista de puntos.
Si se proporciona un index, el nuevo punto se inserta antes del punto existente identificado por el índice index. Cada punto existente a partir de index se desplaza hacia abajo en la lista de puntos. El índice debe ser mayor o igual a 0 y no debe exceder el número de puntos existentes en la línea. Consulte 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 🔗
Devuelve la caché de puntos como un PackedVector3Array.
PackedFloat32Array get_baked_tilts() const 🔗
Devuelve la caché de inclinaciones como un PackedFloat32Array.
PackedVector3Array get_baked_up_vectors() const 🔗
Devuelve la caché de los vectores como un PackedVector3Array.
Si up_vector_enabled es false, la caché estará vacía.
float get_closest_offset(to_point: Vector3) const 🔗
Devuelve el desplazamiento (offset) más cercano a to_point. Este desplazamiento está destinado a ser utilizado en sample_baked() o sample_baked_up_vector().
to_point debe estar en el espacio local de esta curva.
Vector3 get_closest_point(to_point: Vector3) const 🔗
Devuelve el punto más cercano en los segmentos horneados (baked), en el espacio local de la curva, a to_point.
to_point debe estar en el espacio local de esta curva.
Vector3 get_point_in(idx: int) const 🔗
Devuelve la posición del punto de control que precede al vértice idx. La posición devuelta es relativa al vértice idx. Si el índice está fuera de los límites, la función envía un error a la consola y devuelve (0, 0, 0).
Vector3 get_point_out(idx: int) const 🔗
Devuelve la posición del punto de control que sale del vértice idx. La posición devuelta es relativa al vértice idx. Si el índice está fuera de los límites, la función envía un error a la consola y devuelve (0, 0, 0).
Vector3 get_point_position(idx: int) const 🔗
Devuelve la posición del vértice idx. Si el índice está fuera de los límites, la función envía un error a la consola y devuelve (0, 0, 0).
float get_point_tilt(idx: int) const 🔗
Devuelve el ángulo de inclinación (tilt) 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 y devuelve 0.
Elimina el punto idx de la curva. Envía un error a la consola si idx está fuera de los límites.
Vector3 sample(idx: int, t: float) const 🔗
Devuelve la posición entre el vértice idx y el vértice idx + 1, donde t controla si el punto es el primer vértice (t = 0.0), el último vértice (t = 1.0) o un punto intermedio. Los valores de t fuera del rango (0.0 <= t <= 1.0) dan resultados extraños pero predecibles.
Si idx está fuera de los límites, se trunca al primer o último vértice y se ignora t. Si la curva no tiene puntos, la función envía un error a la consola y devuelve (0, 0, 0).
Vector3 sample_baked(offset: float = 0.0, cubic: bool = false) const 🔗
Devuelve un punto dentro de la curva en la posición offset, donde offset se mide como una distancia en unidades 3D a lo largo de la curva. Para ello, busca los dos puntos almacenados en caché entre los que se encuentra el offset y luego interpola los valores. Esta interpolación es cúbica si cubic se establece en true, o lineal si se establece en false.
La interpolación cúbica tiende a seguir mejor las curvas, pero la lineal es más rápida (y a menudo, lo suficientemente precisa).
Vector3 sample_baked_up_vector(offset: float, apply_tilt: bool = false) const 🔗
Devuelve un vector "hacia arriba" (up vector) dentro de la curva en la posición offset, donde offset se mide como una distancia en unidades 3D a lo largo de la curva. Para ello, busca los dos vectores "hacia arriba" almacenados en caché entre los que se encuentra el offset y luego interpola los valores. Si apply_tilt es true, se aplica una inclinación (tilt) interpolada al vector "hacia arriba" interpolado.
Si la curva no tiene vectores "hacia arriba", la función envía un error a la consola y devuelve (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 🔗
Devuelve la posición en el vértice fofs. Llama a sample() utilizando la parte entera de fofs como idx y su parte fraccionaria como t.
void set_point_in(idx: int, position: Vector3) 🔗
Establece la posición del punto de control que precede al 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_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 🔗
Devuelve una lista de puntos a lo largo de la curva, con una densidad de puntos controlada por la curvatura. Es decir, las partes más curvas tendrán más puntos que las partes más rectas.
Esta aproximación crea segmentos rectos entre cada punto y luego subdivide esos segmentos hasta que la forma resultante sea lo suficientemente similar.
max_stages controla cuántas subdivisiones puede tener un segmento de curva antes de que se considere lo suficientemente aproximado. Cada subdivisión divide el segmento por la mitad, por lo que las 5 etapas por defecto pueden significar hasta 32 subdivisiones por segmento de curva. ¡Aumenta este valor con cuidado!
tolerance_degrees controla cuántos grados puede desviarse el punto medio de un segmento respecto a la curva real antes de que el segmento deba subdividirse.
PackedVector3Array tessellate_even_length(max_stages: int = 5, tolerance_length: float = 0.2) const 🔗
Devuelve una lista de puntos a lo largo de la curva con una densidad casi uniforme. max_stages controla cuántas subdivisiones puede tener un segmento de curva antes de que se considere lo suficientemente aproximado. Cada subdivisión divide el segmento por la mitad, por lo que las 5 etapas por defecto pueden significar hasta 32 subdivisiones por segmento de curva. ¡Aumenta este valor con cuidado!
tolerance_length controla la distancia máxima permitida entre dos puntos vecinos antes de que el segmento deba subdividirse.