Referencia de la API
Firmas, parámetros y comportamiento de la superficie pública de Gaanim
Cada página describe un namespace de la escena (scene.geometry, scene.text, scene.viz…) o una clase central. Las explicaciones están en español; los nombres de clases, métodos, parámetros y valores literales se conservan en inglés porque forman parte de la API ejecutable.
Scene, lienzo, línea de tiempo, segmentos, cámara y salida.NúcleoDrawableEl handle de todos los objetos: estilo, posición, efectos, anclajes y relaciones reactivas.scene.geometryGeometríaPrimitivas, líneas, flechas, trayectorias, booleanas, geometría reactiva y 3D.scene.textTextoProsa, ecuaciones, partes semánticas, estilo, flujo, selecciones y documentos Typst.scene.layoutLayoutCajas como en CSS: filas, columnas, grids, capas, estilos, zonas y estructura animada.scene.vizVisualizaciónEspacios de coordenadas, cálculo, datos, valores reactivos, gráficos y campos vectoriales.scene.vizMatricesMatrices seleccionables y mutables, morph entre estados y álgebra.scene.mediaMediosImágenes, SVG, video y Lottie.scene.mediaAudioPistas sincronizadas y narración grabada en el editor.scene.slidesDiapositivasInsignias, tarjetas, rótulos, listas, tablas e identidad de la presentación.scene.mechanicsMecánicaCotas, barras, muelles, fuerzas, apoyos y engranajes reactivos.AudienciaPúblicoEncuestas, cuestionarios, clasificación, equipos, sala, personajes y zonas vivas.TiempoAnimaciones.animate, entradas, énfasis, transformaciones, composición y easing.EstiloColores y temasPaleta, pinceles, degradados, efectos y temas reutilizables.ProyectoRecursosCarpeta de assets, precarga, SVG y Lottie en detalle.Cómo leer una ficha
Cada ficha documenta un símbolo:
- Insignia:
FÁBRICA(crea un objeto en la escena),MÉTODO,PROPIEDAD,CLASEoFUNCIÓN. - Firma: tipos, valores predeterminados y retorno, tomados del stub de tipos de Gaanim salvo que la ficha los escriba.
- Parámetros: los que necesitan explicación, con su tipo y su valor predeterminado.
- Ejemplo: código que se ejecuta con el runtime real al construir esta documentación. Si muestra una vista previa, se generó con ese mismo código.
Los ejemplos con scene.render() son escenas completas que puedes guardar como main.py y abrir con gaanim:
from gaanim import BLUE, Scene
scene = Scene(frame=(16, 9), background="#0f172a")
node = scene.geometry.circle(0.75).fill(BLUE).move_to(0, 0)
scene.play([node.animate.create().duration(1.0)])
scene.render()Los demás son fragmentos: muestran solo las líneas relevantes y dan por hecho una escena como la anterior.
¿Buscas un método concreto? Pulsa Ctrl K o / y escribe su nombre o la tarea, en español o en inglés.
Por dónde empezar
Si es tu primera vez, lee Escena y Drawable: todo lo demás se construye sobre ellos. Para ver la API en escenas completas, consulta los ejemplos.