{ "site": "https://fframes-kit.pages.dev", "import": "use fframes_kit::prelude::*;", "components": [ { "name": "ActionPotential", "summary": "An action potential traced on axes of time (ms) against membrane potential (mV), `x_length` by `y_length` (units of `ui.space`) around `center`. From `delay` the trace draws from 0 to 6 ms in `duration` seconds, a dot at its head; the dashed threshold and resting lines are there from the start. Each phase is named as the trace reaches it: resting potential, stimulus, depolarization, the peak, repolarization and hyperpolarization.", "feature": "biology", "page": "https://fframes-kit.pages.dev/docs/biology/action-potential/", "markdown": "https://fframes-kit.pages.dev/docs/biology/action-potential.md", "scenes": [ "ActionPotential" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ActionPotential-a92f27f6.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/kits/biology/neuron.rs#L439", "themed": true, "fields": [ { "name": "delay", "type": "f32", "default": "0.0", "docs": "Seconds after the container's start before the trace begins to draw." }, { "name": "duration", "type": "f32", "default": "5.0", "docs": "Seconds the trace takes to draw from 0 to 6 ms." }, { "name": "center", "type": "(f64, f64)", "default": "(0.0, -0.3)", "docs": "The middle of the axes, in units of `ui.space`." }, { "name": "x_length", "type": "f64", "default": "9.0", "docs": "Width of the axes, in units of `ui.space`." }, { "name": "y_length", "type": "f64", "default": "5.2", "docs": "Height of the axes, in units of `ui.space`." }, { "name": "trace_color", "type": "Color", "default": "Color::hex(\"#ffd43b\")", "docs": "Colour of the trace and the dot at its head." }, { "name": "threshold_color", "type": "Color", "default": "Color::hex(\"#ff8787\")", "docs": "Colour of the dashed threshold line (-55 mV)." }, { "name": "axis_color", "type": "Color", "default": "theme.colors.muted", "docs": "Colour of the axes and the dashed resting line (-70 mV)." }, { "name": "label_style", "type": "TextStyle", "default": "label_style", "docs": "The font of the axis labels and numbers: family, size in pixels and weight." }, { "name": "phase_style", "type": "TextStyle", "default": "theme.typography.caption", "docs": "The font of the phase names along the trace: family, size in pixels and weight." }, { "name": "text_color", "type": "Color", "default": "theme.colors.text", "docs": "Colour of the phase names." }, { "name": "enter", "type": "Option", "default": "None", "docs": "Fade in at the start; `None` for none." }, { "name": "exit", "type": "Option", "default": "None", "docs": "Fade out before the end; `None` for none." } ], "methods": [] }, { "name": "Angle", "summary": "The mark of the angle between two lines (Manim `Angle`): an arc of `radius` about where they cross, counterclockwise on screen from the first line to the second.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "Angle" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Angle-92296eb8.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/angles.rs#L256", "themed": true, "fields": [ { "name": "line1", "type": "Segment", "default": "((0.0, 0.0), (200.0, 0.0))", "docs": "The first line as two points `((x1, y1), (x2, y2))` in pixels of the canvas; the mark starts from it." }, { "name": "line2", "type": "Segment", "default": "((0.0, 0.0), (0.0, -200.0))", "docs": "The second line, in the same form; the mark turns to it." }, { "name": "radius", "type": "f32", "default": "ANGLE_RADIUS", "docs": "Radius of the mark in pixels, about where the lines cross." }, { "name": "quadrant", "type": "(f32, f32)", "default": "(1.0, 1.0)", "docs": "Which half of each line the mark sits on: `1` along its direction, `-1` against." }, { "name": "other_angle", "type": "bool", "default": "false", "docs": "Marks the other angle, clockwise from the first line to the second." }, { "name": "elbow", "type": "bool", "default": null, "docs": "A square corner instead of an arc." }, { "name": "dot", "type": "bool", "default": "false", "docs": "A dot inside the mark, `dot_distance` of the way out from the corner." }, { "name": "dot_radius", "type": "f32", "default": "5.0", "docs": "Radius of the dot in pixels." }, { "name": "dot_distance", "type": "f32", "default": "0.55", "docs": "How far out the dot sits, as a fraction of the mark's radius (0 at the corner, 1 on the mark)." }, { "name": "dot_color", "type": "Color", "default": "theme.colors.title", "docs": "Colour of the dot." }, { "name": "label", "type": "ShapeLabel", "default": "ShapeLabel::None", "docs": "A label beside the mark, `label_buff` beyond its radius." }, { "name": "label_buff", "type": "f32", "default": "3.0 * SMALL_BUFF", "docs": "Pixels between the mark's radius and the label." }, { "name": "label_style", "type": "TextStyle", "default": "theme.typography.body", "docs": "The label's font: family, size in pixels and weight." }, { "name": "label_color", "type": "Color", "default": "theme.colors.title", "docs": "Colour of the label text." }, { "name": "stroke", "type": "Option", "default": "Some(theme.colors.accent)", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "theme.stroke.regular", "docs": "Outline width in pixels." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn value(&self) -> f32", "summary": "The angle the mark spans in radians, always positive (Manim `get_value`)." }, { "signature": "fn path(&self) -> BezPath", "summary": "The mark alone: an arc, or a square corner." } ] }, { "name": "AnimatedBoundary", "summary": "An outline that keeps drawing itself in one colour after another, the previous colour fading out under it (Manim's `AnimatedBoundary`). It never ends; put it in a `Sequence` to stop it.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "AnimatedBoundary" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AnimatedBoundary-a15432a3.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/indicate_ii.rs#L310", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape whose outline is traced; the shape itself is not drawn." }, { "name": "colors", "type": "Vec", "default": null, "docs": "The colours it draws in, one after another; empty draws nothing." }, { "name": "max_stroke_width", "type": "f32", "default": null, "docs": "Outline width in pixels of the colour being drawn; the previous colour thins from this to 0." }, { "name": "cycle_rate", "type": "f32", "default": null, "docs": "Colours per second." }, { "name": "back_and_forth", "type": "bool", "default": null, "docs": "Every other colour draws from the end back." }, { "name": "draw_rate_func", "type": "RateFunc", "default": null, "docs": "Easing of each colour's drawing along the outline." }, { "name": "fade_rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the previous colour fading out." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." } ], "methods": [ { "signature": "fn new(shape: Shape, colors: Vec) -> Self", "summary": "Around `shape` in `colors`, Manim's defaults otherwise." } ] }, { "name": "AnimatedEmoji", "summary": "A Noto animated emoji (Remotion's ``), played from `start` seconds of its container from the file `file_name` gives in the media folder. `(x, y)` is the top left of a `size` pixel square. It fades in over `fade` seconds and plays at `speed`, again and again with `looping`, otherwise its last frame stays. A missing file draws nothing, and `inspect` warns with the address to download it from. The tone applies to the emoji that have skin tones.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/media-and-overlays/cursors-emoji-sound-effects-and-gi-fs/", "markdown": "https://fframes-kit.pages.dev/docs/media-and-overlays/cursors-emoji-sound-effects-and-gi-fs.md", "scenes": [ "AnimatedEmoji" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AnimatedEmoji-03f3e801.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/assets/emoji.rs#L210", "themed": true, "fields": [ { "name": "name", "type": "&str", "default": "\"grinning\"", "docs": "Name of the emoji from `NAMES`, which also names its `.json` file in the media folder." }, { "name": "skin_tone", "type": "Option", "default": "None", "docs": "Skin tone of a hand emoji; `None` for the default, and ignored for emoji without skin tones." }, { "name": "x", "type": "f32", "default": "880.0", "docs": "Left edge in pixels of the canvas." }, { "name": "y", "type": "f32", "default": "460.0", "docs": "Top edge in pixels of the canvas." }, { "name": "size", "type": "f32", "default": "160.0", "docs": "Side of the square the emoji fills, in pixels." }, { "name": "start", "type": "f32", "default": "0.0", "docs": "Second it starts playing, local to the parent container." }, { "name": "speed", "type": "f32", "default": "1.0", "docs": "Playback speed; 1 is normal, 2 twice as fast." }, { "name": "looping", "type": "bool", "default": "true", "docs": "Plays again and again; `false` keeps the last frame." }, { "name": "fade", "type": "f32", "default": "theme.motion.duration.fast", "docs": "Seconds it takes to fade in from `start`." } ], "methods": [ { "signature": "fn file(&self) -> String", "summary": "The file this emoji plays." } ] }, { "name": "AnimationGroup", "summary": "Every child at once (Manim's `AnimationGroup` with no lag).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "AnimationGroup" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AnimationGroup-4d111427.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/group.rs#L83", "themed": false, "fields": [ { "name": "children", "type": "Vec", "default": null, "docs": "The children, all started together; each is a closure taking the `Ui`." } ], "methods": [] }, { "name": "Annotation", "summary": "An annotation: a dot on the `target`, an elbow line to `label` (first across, then up or down) and the text at its end. The line draws on over `run_time` seconds from `delay`; the text fades in over the last 40 %. (The shape called `Callout` is the Remotion speech bubble, so this one has another name.)", "feature": null, "page": "https://fframes-kit.pages.dev/docs/media-and-overlays/overlays/", "markdown": "https://fframes-kit.pages.dev/docs/media-and-overlays/overlays.md", "scenes": [ "Annotation" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Annotation-279b2abc.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/overlay/annotation.rs#L18", "themed": true, "fields": [ { "name": "target", "type": "(f32, f32)", "default": "(0.0, 0.0)", "docs": "The point the dot marks, in pixels of the canvas." }, { "name": "label", "type": "(f32, f32)", "default": "(0.0, 0.0)", "docs": "Where the line ends and the text sits, in pixels of the canvas; the text goes right of it when it is right of `target`, else left." }, { "name": "text", "type": "Cow", "default": "Cow::Borrowed(\"\")", "docs": "The words at the end of the line." }, { "name": "color", "type": "Color", "default": "theme.colors.accent", "docs": "Colour of the dot, line and text." }, { "name": "style", "type": "TextStyle", "default": "theme.typography.caption", "docs": "The font: family, size in pixels and weight." }, { "name": "letter_spacing", "type": "f32", "default": "2.0", "docs": "Extra space between letters of the text, in pixels." }, { "name": "stroke_width", "type": "f32", "default": "theme.stroke.thin", "docs": "Width of the line and the ring around the dot, in pixels." }, { "name": "delay", "type": "f32", "default": "0.0", "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": "theme.motion.duration.slow", "docs": "Seconds the line takes to draw on; the text fades in over the last 40 %." }, { "name": "rate_func", "type": "RateFunc", "default": "theme.motion.easing.standard", "docs": "Easing of the drawing over its run time." } ], "methods": [ { "signature": "fn draw(self, progress: f32) -> Svgr", "summary": "The annotation `progress` (0 to 1) of the way drawn." } ] }, { "name": "AnnotationDot", "summary": "A dot that marks a point for an annotation (Manim `AnnotationDot`): a third larger than a `Dot`, filled in the accent colour with a light outline.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "AnnotationDot" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AnnotationDot-37e10b82.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/labeled.rs#L170", "themed": true, "fields": [ { "name": "cx", "type": "f32", "default": "0.0", "docs": "Center x in pixels of the canvas." }, { "name": "cy", "type": "f32", "default": "0.0", "docs": "Center y in pixels of the canvas (y down)." }, { "name": "radius", "type": "f32", "default": "10.4", "docs": "Radius in pixels." }, { "name": "fill", "type": "Option", "default": null, "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": null, "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": null, "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "AnnularSector", "summary": "The part of a ring from `start_angle` by `angle` (Manim `AnnularSector`).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "AnnularSector" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AnnularSector-bf90805d.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/arcs.rs#L185", "themed": true, "fields": [ { "name": "cx", "type": "f32", "default": "0.0", "docs": "Center x in pixels of the canvas." }, { "name": "cy", "type": "f32", "default": "0.0", "docs": "Center y in pixels of the canvas (y down)." }, { "name": "inner_radius", "type": "f32", "default": "50.0", "docs": "Radius in pixels of the inner edge." }, { "name": "outer_radius", "type": "f32", "default": "100.0", "docs": "Radius in pixels of the outer edge." }, { "name": "start_angle", "type": "f32", "default": "0.0", "docs": "Where it starts, in radians counterclockwise on screen from the right (0 is right)." }, { "name": "angle", "type": "f32", "default": "std::f32::consts::FRAC_PI_2", "docs": "Turn in radians, counterclockwise on screen for a positive value." }, { "name": "fill", "type": "Option", "default": "Paint::solid(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::solid(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::solid(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "Annulus", "summary": "A ring between two circles (Manim `Annulus`).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "Annulus" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Annulus-ccf82553.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/basic.rs#L166", "themed": true, "fields": [ { "name": "cx", "type": "f32", "default": "0.0", "docs": "Center x in pixels of the canvas." }, { "name": "cy", "type": "f32", "default": "0.0", "docs": "Center y in pixels of the canvas (y down)." }, { "name": "inner_radius", "type": "f32", "default": "50.0", "docs": "Radius in pixels of the hole." }, { "name": "outer_radius", "type": "f32", "default": "100.0", "docs": "Radius in pixels of the outer edge." }, { "name": "fill", "type": "Option", "default": "Paint::solid(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::solid(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::solid(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "Appear", "summary": "Shows its children from `from` seconds on: they rise `rise` units into place, grow from `scale_from` about `center` and fade in over `enter` seconds. They leave the same way up over `exit` seconds, ending at `until` seconds, or at the end of the container (`ui.duration`) when `until` is `None`. Inside, time starts at `from`, as in a `Sequence`.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/media-and-overlays/overlays/", "markdown": "https://fframes-kit.pages.dev/docs/media-and-overlays/overlays.md", "scenes": [ "Appear" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Appear-6a73b190.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/overlay/appear.rs#L15", "themed": true, "fields": [ { "name": "from", "type": "f32", "default": null, "docs": "Seconds after the container's start when the children appear; inside, their time starts at `from`." }, { "name": "until", "type": "Option", "default": null, "docs": "Seconds when the children are gone, after leaving over `exit`; `None` ends with the container." }, { "name": "center", "type": "(f32, f32)", "default": null, "docs": "The point the content scales about, in canvas units." }, { "name": "rise", "type": "f32", "default": null, "docs": "Pixels the children rise into place as they enter, and sink as they leave." }, { "name": "scale_from", "type": "f32", "default": null, "docs": "Scale the children grow from as they enter, 1 for no growth." }, { "name": "enter", "type": "f32", "default": null, "docs": "Seconds the children take to fade, rise and grow in." }, { "name": "exit", "type": "f32", "default": null, "docs": "Seconds the children take to leave before `until` or the end of the container; 0 cuts them off." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the entrance over `enter` seconds." }, { "name": "children", "type": "Children", "default": null, "docs": "What it shows (a closure taking the `Ui`)." } ], "methods": [ { "signature": "fn new(ui: &Ui, from: f32, center: (f32, f32), children: Children) -> Self", "summary": "Times and motion from the theme: `motion.duration.enter` and `exit`, a 60 unit rise, scaling from 0.92." }, { "signature": "fn state(&self, t: f32, end: Option) -> (f32, f32)", "summary": "`(entered, left)`, both from 0 to 1, at `t` seconds of a container that ends at `end`." } ] }, { "name": "ApplyComplexFunction", "summary": "Moves every point of the shape to `function(re, im)` of the complex number at it (Manim's `ApplyComplexFunction`, 1 second), in the units of `ui.space`. As in Manim the points travel on arcs as wide as the angle of `function(1)`, so a rotation turns.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyComplexFunction" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyComplexFunction-5fc7b864.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/apply.rs#L131", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is transformed; drawn unchanged until `delay` has passed." }, { "name": "function", "type": "fn((f64, f64)) -> (f64, f64)", "default": null, "docs": "Maps the complex number `(re, im)` at a point, in units of `ui.space`, to where the point ends up." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the animation takes." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape, function: fn((f64, f64)) -> (f64, f64)) -> Self", "summary": "Manim's 1 second, smooth." }, { "signature": "fn path_arc(&self) -> f64", "summary": "The angle of `function(1)`: how far the points turn on their way." } ] }, { "name": "ApplyFunction", "summary": "Morphs the shape into `function(shape)` (Manim's `ApplyFunction`, a `Transform` in 1 second).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyFunction" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyFunction-9186d23e.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/apply.rs#L179", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is transformed; drawn unchanged until `delay` has passed." }, { "name": "function", "type": "fn(Shape) -> Shape", "default": null, "docs": "Builds the shape it morphs into from a copy of `shape`." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the animation takes." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape, function: fn(Shape) -> Shape) -> Self", "summary": "Manim's 1 second, smooth." } ] }, { "name": "ApplyMatrix", "summary": "Moves every point of the shape by the 2×2 `matrix` about `about_point` (Manim's `ApplyMatrix`, about the origin of `ui.space` in 3 seconds). The matrix and the point are in the units of `ui.space`, `y` up: `[[0, -1], [1, 0]]` turns a quarter counterclockwise.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyMatrix" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyMatrix-818901e4.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/apply.rs#L31", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is transformed; drawn unchanged until `delay` has passed." }, { "name": "matrix", "type": "[[f64; 2]; 2]", "default": null, "docs": "The 2x2 matrix, row by row, applied to each point's offset from `about_point`, in units of `ui.space` with y up." }, { "name": "about_point", "type": "Option<(f64, f64)>", "default": null, "docs": "In units; `None` is the origin of the space." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the animation takes." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape, matrix: [[f64; 2]; 2]) -> Self", "summary": "About the origin in Manim's 3 seconds, smooth." }, { "signature": "fn map(&self, space: Space, p: Point) -> Point", "summary": "Where the pixel `p` ends up." } ] }, { "name": "ApplyPointwiseFunction", "summary": "Moves every point of the shape to `function(x, y)` (Manim's `ApplyPointwiseFunction`, 3 seconds), in the units of `ui.space`, `y` up. The path is cut into small pieces first like a `super::Homotopy`, so straight lines bend.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyPointwiseFunction" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyPointwiseFunction-c7a4e51a.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/apply.rs#L89", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is transformed; drawn unchanged until `delay` has passed." }, { "name": "function", "type": "fn(f64, f64) -> (f64, f64)", "default": null, "docs": "Maps a point `(x, y)` in units of `ui.space` (y up) to where it ends up." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the animation takes." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape, function: fn(f64, f64) -> (f64, f64)) -> Self", "summary": "Manim's 3 seconds, smooth." } ] }, { "name": "ApplyPointwiseFunctionToCenter", "summary": "Moves the whole shape so its center goes to `function(center)` (Manim's `ApplyPointwiseFunctionToCenter`, 3 seconds), in the units of `ui.space`. The shape keeps its form.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyPointwiseFunctionToCenter" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyPointwiseFunctionToCenter-203b85d4.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/apply.rs#L222", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is transformed; drawn unchanged until `delay` has passed." }, { "name": "function", "type": "fn(f64, f64) -> (f64, f64)", "default": null, "docs": "Maps the shape's center `(x, y)` in units of `ui.space` (y up) to where the center ends up." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the animation takes." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape, function: fn(f64, f64) -> (f64, f64)) -> Self", "summary": "Manim's 3 seconds, smooth." } ] }, { "name": "ApplyWave", "summary": "A wave runs across the shape from left to right and bends it by `amplitude` pixels in `direction` (Manim's `ApplyWave`). The shape is drawn as built before and after.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/geometry-animations.md", "scenes": [ "ApplyWave" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ApplyWave-f53ee065.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/animate/indicate_ii.rs#L405", "themed": false, "fields": [ { "name": "shape", "type": "Shape", "default": null, "docs": "The shape that is bent by the wave; drawn as built before and after." }, { "name": "direction", "type": "(f32, f32)", "default": null, "docs": "Canvas units, `y` down: `(0.0, -1.0)` is Manim's `UP`." }, { "name": "amplitude", "type": "f32", "default": null, "docs": "How far points are nudged at the crest, in pixels of the canvas." }, { "name": "wave_func", "type": "RateFunc", "default": null, "docs": "Easing that shapes each ripple of the wave." }, { "name": "time_width", "type": "f32", "default": null, "docs": "The wave's length as a fraction of the shape's width." }, { "name": "ripples", "type": "usize", "default": null, "docs": "Number of crests that pass across the shape (at least 1)." }, { "name": "delay", "type": "f32", "default": null, "docs": "Seconds after the container's start before it begins." }, { "name": "run_time", "type": "f32", "default": null, "docs": "Seconds the wave takes to cross the shape." }, { "name": "rate_func", "type": "RateFunc", "default": null, "docs": "Easing of the animation over its run time." } ], "methods": [ { "signature": "fn new(shape: Shape) -> Self", "summary": "Up by 27 pixels (Manim's 0.2 units), one ripple in 2 seconds." }, { "signature": "fn path_at(&self, p: f32) -> BezPath", "summary": "The path at progress `p`." } ] }, { "name": "Arc", "summary": "Part of a circle's outline from `start_angle` by `angle` (Manim `Arc`).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "Arc" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Arc-8503fbc1.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/basic.rs#L140", "themed": true, "fields": [ { "name": "cx", "type": "f32", "default": "0.0", "docs": "Center x in pixels of the canvas." }, { "name": "cy", "type": "f32", "default": "0.0", "docs": "Center y in pixels of the canvas (y down)." }, { "name": "radius", "type": "f32", "default": "100.0", "docs": "Radius in pixels." }, { "name": "start_angle", "type": "f32", "default": "0.0", "docs": "Where the arc starts, in radians counterclockwise on screen from the right (0 is right)." }, { "name": "angle", "type": "f32", "default": "std::f32::consts::FRAC_PI_2", "docs": "How far the arc turns, in radians; counterclockwise on screen for a positive value." }, { "name": "fill", "type": "Option", "default": "Paint::outline(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::outline(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::outline(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "ArcBetweenPoints", "summary": "The arc from `(x1, y1)` to `(x2, y2)` that turns by `angle`, counterclockwise on screen for a positive angle (Manim `ArcBetweenPoints`). A `radius` replaces the angle with the shorter arc of that radius (negative for the other side).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "ArcBetweenPoints" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ArcBetweenPoints-8dc8a0d5.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/arcs.rs#L44", "themed": true, "fields": [ { "name": "x1", "type": "f32", "default": "0.0", "docs": "Start x in pixels of the canvas." }, { "name": "y1", "type": "f32", "default": "0.0", "docs": "Start y in pixels of the canvas (y down)." }, { "name": "x2", "type": "f32", "default": "200.0", "docs": "End x in pixels of the canvas." }, { "name": "y2", "type": "f32", "default": "0.0", "docs": "End y in pixels of the canvas (y down)." }, { "name": "angle", "type": "f32", "default": "std::f32::consts::FRAC_PI_2", "docs": "Turn in radians, counterclockwise on screen for a positive value." }, { "name": "radius", "type": "Option", "default": "None", "docs": "`Some` replaces `angle` with the shorter arc of this radius in pixels (negative for the other side); `None` uses `angle`." }, { "name": "fill", "type": "Option", "default": "Paint::outline(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::outline(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::outline(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." }, { "signature": "fn turn(&self) -> f64", "summary": "The turn of the arc: `angle`, or the one `radius` gives." } ] }, { "name": "ArcBrace", "summary": "A brace bent along an arc (Manim `ArcBrace`): round the circle of `radius` about `(cx, cy)` from `start_angle` turning `angle` (radians, counterclockwise on screen), its tip `depth` pixels outward, or toward the center when `inside`. `ArcBrace::tip` is where a label goes.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "ArcBrace" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ArcBrace-bb6d7b5c.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/brace.rs#L74", "themed": true, "fields": [ { "name": "cx", "type": "f32", "default": "0.0", "docs": "Center x in pixels of the canvas." }, { "name": "cy", "type": "f32", "default": "0.0", "docs": "Center y in pixels of the canvas (y down)." }, { "name": "radius", "type": "f32", "default": "135.0", "docs": "Radius in pixels of the circle the brace follows." }, { "name": "start_angle", "type": "f32", "default": "-1.0", "docs": "Where the brace starts, in radians counterclockwise on screen from the right." }, { "name": "angle", "type": "f32", "default": "2.0", "docs": "How far the brace turns, in radians; counterclockwise on screen for a positive value, clockwise for a negative one." }, { "name": "depth", "type": "f32", "default": "24.0", "docs": "How far in pixels the tip sticks out of the arc; negative turns the brace over." }, { "name": "inside", "type": "bool", "default": "false", "docs": "Puts the tip toward the center instead of outward." }, { "name": "fill", "type": "Option", "default": "Paint::outline(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::outline(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::outline(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." }, { "signature": "fn tip(&self) -> (f32, f32)", "summary": "The point of the tip." } ] }, { "name": "ArcPolygon", "summary": "A closed shape of arcs between consecutive `points`, each turning by `angle` (Manim `ArcPolygon`); a `radius` replaces the angle as on `ArcBetweenPoints`.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "ArcPolygon" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ArcPolygon-692f219b.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/arcs.rs#L220", "themed": true, "fields": [ { "name": "points", "type": "Vec<(f32, f32)>", "default": "vec![(0.0, -100.0), (100.0, 100.0), (-100.0, 100.0)]", "docs": "Corner points `(x, y)` in pixels of the canvas; arcs join them in order and back to the first." }, { "name": "angle", "type": "f32", "default": "std::f32::consts::FRAC_PI_4", "docs": "Turn in radians of each arc between consecutive points." }, { "name": "radius", "type": "Option", "default": "None", "docs": "`Some` replaces `angle` with the shorter arc of this radius in pixels on each side; `None` uses `angle`." }, { "name": "fill", "type": "Option", "default": "Paint::outline(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::outline(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::outline(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "ArcPolygonFromArcs", "summary": "A closed shape of the given arcs (Manim `ArcPolygonFromArcs`): each one after the other, joined by straight lines where one does not end where the next starts.", "feature": null, "page": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes/", "markdown": "https://fframes-kit.pages.dev/docs/layout-and-shapes/shapes.md", "scenes": [ "ArcPolygonFromArcs" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/ArcPolygonFromArcs-8414a160.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/shapes/arcs.rs#L270", "themed": true, "fields": [ { "name": "arcs", "type": "Vec", "default": "Vec::new()", "docs": "The arcs, drawn in order; a straight line joins one that ends away from where the next starts." }, { "name": "fill", "type": "Option", "default": "Paint::outline(theme).fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "Paint::outline(theme).stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "Paint::outline(theme).stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "Area", "summary": "The region between `f` and `bounded` (the x-axis when `None`) from `x_range.0` to `x_range.1` (Manim `get_area(graph, x_range, bounded_graph)`).", "feature": null, "page": "https://fframes-kit.pages.dev/docs/math/riemann-sum-and-area-under/", "markdown": "https://fframes-kit.pages.dev/docs/math/riemann-sum-and-area-under.md", "scenes": [ "Area" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/Area-7c7c71b7.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/explain/graph.rs#L330", "themed": true, "fields": [ { "name": "f", "type": "Func", "default": "|x| x", "docs": "The upper function of the region, in data units; a plain `fn`." }, { "name": "bounded", "type": "Option", "default": "None", "docs": "The function that bounds the region below; `None` bounds it with the x-axis." }, { "name": "x_range", "type": "(f64, f64)", "default": "(0.0, 1.0)", "docs": "The first and last `x` the region covers, in data units." }, { "name": "axes", "type": "AxesMap", "default": "AxesMap::default()", "docs": "The mapping of the axes the region sits on (`axes.map(ui)`)." }, { "name": "samples", "type": "usize", "default": "128", "docs": "Number of straight pieces the region's edges are sampled with." }, { "name": "fill", "type": "Option", "default": "paint.fill", "docs": "`None` leaves the inside empty." }, { "name": "stroke", "type": "Option", "default": "paint.stroke", "docs": "`None` draws no outline." }, { "name": "stroke_width", "type": "f32", "default": "paint.stroke_width", "docs": "Outline width in pixels." }, { "name": "dash", "type": "Option<(f32, f32)>", "default": "None", "docs": "Dash and gap lengths of the outline." }, { "name": "opacity", "type": "f32", "default": "1.0", "docs": "0 transparent to 1 opaque." }, { "name": "enter", "type": "Option", "default": "None", "docs": "How it appears; `None` shows it from the start." }, { "name": "exit", "type": "Option", "default": "None", "docs": "How it leaves at the end of its container; `None` stays." }, { "name": "emphasis", "type": "Option", "default": "None", "docs": "An emphasis animation (`Indicate`, `Wiggle`, ..) played while it is shown." } ], "methods": [ { "signature": "fn shape(&self) -> Shape", "summary": "The path and paint as a `Shape`." } ] }, { "name": "AreaUnder", "summary": "The area under a graph revealed from left to right over `run_time` seconds after `delay` (Manim's `get_area` with a growing `x_range`), with the integral of the part shown so far written after the text of `value`. Build `area` with `Axes::area`; `key` tells the clip paths of two areas in one frame apart.", "feature": "math", "page": "https://fframes-kit.pages.dev/docs/math/riemann-sum-and-area-under/", "markdown": "https://fframes-kit.pages.dev/docs/math/riemann-sum-and-area-under.md", "scenes": [ "AreaUnder" ], "clips": [ "https://fframes-kit.pages.dev/media/scenes/AreaUnder-941ff31b.mp4" ], "source": "https://github.com/khanhthanhdev/fframes-kit/blob/main/fframes-kit/src/kits/math/calculus.rs#L367", "themed": true, "fields": [ { "name": "area", "type": "Area", "default": "Area::themed(theme)", "docs": "The region to reveal, built with `Axes::area`: the graph, its axes and the `x_range` it covers." }, { "name": "delay", "type": "f32", "default": "0.0", "docs": "Seconds after the container's start before the area starts to grow." }, { "name": "run_time", "type": "f32", "default": "1.5", "docs": "Seconds the area takes to grow across its `x_range`." }, { "name": "rate_func", "type": "RateFunc", "default": "RateFunc::default()", "docs": "Easing of the growth over its run time." }, { "name": "value", "type": "Option