Package index • manimR

Scene & Rendering

Create scenes and render animations to video

Scene: Scene R6 Class
scene_3d(): Create a 3D scene
render(): Render a scene to video
preview(): Preview a scene
create_renderer(): Create a renderer for the specified backend
Renderer: Legacy Renderer alias (backward compatibility)

Geometry — Arcs & Circles

Circular shapes and arc segments

Arc: Arc R6 Class
ArcBetweenPoints: ArcBetweenPoints R6 Class
Circle: Circle R6 Class
Dot: Dot R6 Class
Ellipse: Ellipse R6 Class
Annulus: Annulus R6 Class
Sector: Sector R6 Class

Geometry — Lines & Arrows

Lines, arrows, and tangent constructions

Line: Line R6 Class
DashedLine: DashedLine R6 Class
ArrowTip: ArrowTip R6 Class
Arrow: Arrow R6 Class
DoubleArrow: DoubleArrow R6 Class
Vector: Vector R6 Class
CurvedArrow: CurvedArrow R6 Class
TangentLine: TangentLine R6 Class

Geometry — Polygons & Shapes

Closed polygon shapes

Polygon: Polygon R6 Class
RegularPolygon: RegularPolygon R6 Class
Triangle: Triangle R6 Class
Rectangle: Rectangle R6 Class
Square: Square R6 Class
RoundedRectangle: RoundedRectangle R6 Class
Star: Star R6 Class

Geometry — Bezier, Angle & Boolean

Bezier curves, angles, and boolean operations

CubicBezier: CubicBezier R6 Class
Angle: Angle R6 Class
RightAngle: RightAngle R6 Class
Union: Union R6 Class
Intersection: Intersection R6 Class
Difference: Difference R6 Class

Core Objects

Base object classes and grouping

MObject: MObject R6 Class
VMobject: VMobject R6 Class
Group: Group R6 Class
VGroup: VGroup R6 Class
ImageMobject: ImageMobject R6 Class
Brace: Brace

Text & LaTeX

Text rendering, LaTeX math, and code display

Text: Text R6 Class
MarkupText: MarkupText R6 Class
Title: Title R6 Class
BulletedList: BulletedList R6 Class
Paragraph: Paragraph R6 Class
MathTex: MathTex R6 Class
Tex: Tex R6 Class
Code: Code R6 Class
TextObject: TextObject R6 Class
LaTeXObject: LaTeXObject R6 Class

Animations — Creation

Introduce objects into a scene

Animation: Animation R6 Class
AnimationBuilder: AnimationBuilder R6 Class
Create: Create R6 Class
Write: Write R6 Class
DrawBorderThenFill: DrawBorderThenFill R6 Class
Uncreate: Uncreate R6 Class
ShowIncreasingSubsets: ShowIncreasingSubsets R6 Class
ShowSubmobjectsOneByOne: ShowSubmobjectsOneByOne R6 Class

Animations — Fading

Fade objects in and out

FadeIn: FadeIn R6 Class
FadeOut: FadeOut R6 Class
FocusOn: FocusOn R6 Class

Animations — Growing

Grow objects from points, edges, and centers

GrowFromCenter: GrowFromCenter R6 Class
GrowFromEdge: GrowFromEdge R6 Class
GrowFromPoint: GrowFromPoint R6 Class
GrowArrow: GrowArrow R6 Class
SpinInFromNothing: SpinInFromNothing R6 Class
SpiralIn: SpiralIn R6 Class

Animations — Transform

Morph and transform between objects

Transform: Transform R6 Class
ReplacementTransform: ReplacementTransform R6 Class
MoveToTarget: MoveToTarget R6 Class
ApplyMethod: ApplyMethod R6 Class
ApplyFunction: ApplyFunction R6 Class
ApplyComplexFunction: ApplyComplexFunction R6 Class
TransformMatchingShapes: TransformMatchingShapes R6 Class
MoveAlongPath: MoveAlongPath R6 Class
Homotopy: Homotopy R6 Class
PhaseFlow: PhaseFlow R6 Class
MethodAnimation: MethodAnimation (internal)
ValueAnimation: ValueAnimation R6 Class

Animations — Indication

Draw attention to objects

flash(): Flash animation
indicate(): Indicate/highlight animation
circumscribe(): Circumscribe an object
ApplyWave: ApplyWave R6 Class
ShowPassingFlash: ShowPassingFlash R6 Class

Animations — Rotation & Speed

Rotation animations and speed control

RotateAnim: Rotate R6 Class (Animation)
Rotating: Rotating R6 Class
ChangeSpeed: ChangeSpeed R6 Class
speed_ramp(): Create a linear speed ramp
speed_with_slow_section(): Create a slow-motion section

Animations — Composition

Combine and sequence animations

AnimationGroup: AnimationGroup R6 Class
Succession: Succession R6 Class
LaggedStart: LaggedStart R6 Class
LaggedStartMap: LaggedStartMap R6 Class
Wait: Wait R6 Class

Animations — Updaters

Dynamic, continuously updating objects

ValueTracker: ValueTracker R6 Class
UpdateFromFunc: UpdateFromFunc R6 Class
UpdateFromAlphaFunc: UpdateFromAlphaFunc R6 Class
always_redraw(): Create an always-redrawing mobject
DecimalNumber: DecimalNumber R6 Class
Variable: Variable R6 Class

Camera

Camera positioning and movement

Camera: Camera R6 Class
MovingCamera: MovingCamera R6 Class
ThreeDCamera: ThreeDCamera R6 Class

Coordinate Systems

Axes, number lines, and grids

Axes: Axes R6 Class
ThreeDAxes: ThreeDAxes R6 Class
NumberLine: NumberLine R6 Class
NumberPlane: NumberPlane R6 Class
ComplexPlane: ComplexPlane R6 Class
PolarPlane: PolarPlane R6 Class
FunctionGraph: FunctionGraph
ParametricFunction: ParametricFunction

3D Objects

Three-dimensional shapes and primitives

ThreeDVMobject: ThreeDVMobject R6 Class
Surface: Surface R6 Class
ParametricFunction3D: ParametricFunction3D R6 Class
Sphere: Sphere R6 Class
Torus: Torus R6 Class
Cylinder: Cylinder R6 Class
Cone: Cone R6 Class
Cube: Cube R6 Class
Prism: Prism R6 Class
Dot3D: Dot3D R6 Class
Line3D: Line3D R6 Class
Arrow3D: Arrow3D R6 Class
Tetrahedron: Tetrahedron R6 Class
Octahedron: Octahedron R6 Class
Icosahedron: Icosahedron R6 Class
Dodecahedron: Dodecahedron R6 Class

Scene Types

Specialized scene types

ThreeDScene: ThreeDScene R6 Class
VectorScene: VectorScene R6 Class
GraphScene: GraphScene R6 Class
StatScene: StatScene R6 Class

Graph & Network

Graph theory visualizations

Graph: Graph R6 Class
DiGraph: DiGraph R6 Class

Vector Fields

Vector field visualizations

ArrowVectorField: ArrowVectorField R6 Class
StreamLines: StreamLines R6 Class

Tables & Matrices

Tabular and matrix display

Table: Table R6 Class
MathTable: MathTable R6 Class
IntegerTable: IntegerTable R6 Class
MatrixMobject: Matrix display R6 Class

Renderers

Rendering backends

AbstractRenderer: AbstractRenderer R6 Class
AggRenderer: AggRenderer R6 Class
SVGRenderer: SVGRenderer R6 Class
GridRenderer: GridRenderer R6 Class

Grammar of Animated Graphics

ggplot2-style API for animated plots

manim_plot(): Create a manim animation plot
aes(): Aesthetic mapping for manim grammar
anim_point(): Add animated points
anim_line(): Add animated lines/curves
anim_bar(): Add animated bars
anim_text(): Add animated text labels
anim_function(): Add an animated mathematical function
anim_axes(): Add animated axes
anim_latex(): Add a LaTeX equation
anim_transition(): Specify animation transition type
anim_timing(): Set animation timing
anim_camera(): Set camera configuration
anim_render(): Trigger rendering of the ManimPlot
anim_theme_dark(): Dark theme (default manim look)
anim_theme_light(): Light theme
anim_theme_3b1b(): 3Blue1Brown theme
anim_theme_academic(): Academic theme (LaTeX-friendly)

Data-Driven Animation

Animate data frames and statistical graphics

animate_data_scatter(): Animate a scatter plot from data
animate_bar_race(): Animate a bar chart race
animate_time_series(): Animate a time series
animate_data_transition(): Smooth data transition

Statistical Visualization

Animated statistical displays

animate_histogram(): Animate a histogram
animate_normal_distribution(): Animate a normal distribution
animate_regression(): Animate linear regression
animate_boxplot(): Animate a box plot
animate_function_trace(): Animate correlation between two variables
normal_distribution_tutorial(): Normal Distribution Animated Tutorial

Pipe API — Add Objects

Add objects with the pipe API

add_text(): Add text to a scene
add_latex(): Add LaTeX to a scene
add_shape(): Add a shape to a scene
add_circle(): Add a circle to a scene
add_rectangle(): Add a rectangle to a scene
add_line(): Add a line to a scene
add_function_plot(): Add a function plot to a scene
add_arrow(): Add an arrow to a scene
add_image(): Add an image to a scene
add_mobject(): Add a generic mobject to a scene

Pipe API — Animate

Animate with the pipe API

animate(): Animate an object (generic)
write_in(): Write-in animation (typing effect)
fade_in(): Fade-in animation
fade_out(): Fade-out animation
grow_from_center(): Grow from center animation
shrink_to_center(): Shrink to center animation
draw_border(): Draw border animation
pulse(): Pulse animation
wiggle(): Wiggle animation

Pipe API — Transform & Time

Transform and time with the pipe API

transform_to(): Transform one object into another
morph(): Morph between objects
move_to(): Move an object to a new position
shift(): Shift an object by a vector
rotate(): Rotate an object
scale_object(): Scale an object
highlight_term(): Highlight a term in a LaTeX expression
change_color(): Change object color
pause() wait(): Pause the animation
then(): Chain animations sequentially

Data Integration

Data frame and ggplot2 integration

animate_scatter(): Create an animated scatter plot
animate_bar_chart(): Create an animated bar chart
animate_line_chart(): Create an animated line chart
convert_ggplot_to_manim(): Convert a ggplot to a manimR scene
as_manim(): Pipe data into animation

Color System

Colors, palettes, and gradients

ManimColor: ManimR Theme and Colors
interpolate_color(): Interpolate between two colors
color_gradient(): Create a color gradient
manim_palette(): Get a predefined color palette
WHITE GREY_A GREY_B GREY_C GREY_D GREY_E BLACK BLUE_A BLUE_B BLUE_C BLUE_D BLUE_E BLUE TEAL_A TEAL_B TEAL_C TEAL_D TEAL_E TEAL GREEN_A GREEN_B GREEN_C GREEN_D GREEN_E GREEN YELLOW_A YELLOW_B YELLOW_C YELLOW_D YELLOW_E YELLOW GOLD_A GOLD_B GOLD_C GOLD_D GOLD_E GOLD RED_A RED_B RED_C RED_D RED_E RED MAROON_A MAROON_B MAROON_C MAROON_D MAROON_E MAROON PURPLE_A PURPLE_B PURPLE_C PURPLE_D PURPLE_E PURPLE PINK LIGHT_PINK ORANGE LIGHT_BROWN DARK_BROWN GREY GRAY LIGHT_GREY LIGHT_GRAY DARK_GREY DARK_GRAY: Standard Manim Colors

Easing Functions

Animation timing curves

list_easings(): List all available easing functions

Constants

Direction vectors, math, and sizing constants

ORIGIN UP DOWN LEFT RIGHT OUT IN UL UR DL DR: Direction Constants
PI TAU DEGREES: Mathematical Constants
FRAME_WIDTH FRAME_HEIGHT FRAME_X_RADIUS FRAME_Y_RADIUS: Frame Constants
DEFAULT_DOT_RADIUS DEFAULT_SMALL_DOT_RADIUS DEFAULT_DASH_LENGTH DEFAULT_ARROW_TIP_LENGTH DEFAULT_ARROW_TIP_WIDTH DEFAULT_STROKE_WIDTH DEFAULT_FONT_SIZE SMALL_BUFF MED_SMALL_BUFF MED_LARGE_BUFF LARGE_BUFF: Size Constants

Backend & Performance

Computation backends and C++ acceleration

get_backend(): Get current backend
set_backend(): Set computational backend
list_backends(): List available backends
has_compiled_backend(): Check if compiled backend is available
benchmark_backends(): Benchmark backends
cpp_easing_vectorized(): Vectorized Easing Function (C++ Backend)
cpp_lerp_vectorized(): Vectorized Linear Interpolation (C++ Backend)
cpp_color_interpolate(): Color Interpolation (C++ Backend)
cpp_calculate_animation_progress(): Batch Ease Calculation for Animations
cpp_smoothstep(): Smooth Step Function (GPU-friendly)
cpp_generate_geometry(): Generate Shape Geometry (C++ Backend)
cpp_transform_vertices(): Transform Vertices (C++ Backend)
cpp_batch_transform_vertices(): Batch Transform Vertices (C++ Backend)
cpp_clear_geometry_cache(): Clear Geometry Cache
cpp_generate_arc(): Generate Arc Path
cpp_generate_bezier(): Generate Bezier Curve
cpp_render_frame_batch(): Render Frame Batch (C++ Backend)
cpp_compute_bbox(): Compute Bounding Box (C++ Backend)
cpp_interpolate_keyframes(): Parallel Frame Interpolation
cpp_optimize_timeline(): Optimize Animation Timeline

Interactive & Shiny

Interactive output and Shiny widgets

manim_widget(): Create an htmlwidget for a manimR animation
manimROutput(): Shiny output for manimR animation
renderManimR(): Render manimR animation for Shiny
manim_explorer(): Shiny app for interactive animation exploration
export_html(): Export animation as HTML page

Templates & Themes

Reusable animation templates

Template: Template R6 Class
use_template(): Use a pre-built template
list_templates(): List available templates
customize(): Customize a template
apply_theme(): Apply visual theme
apply_cinematic_theme(): Apply Theme

Tutorials

Built-in showcase tutorials

tutorial_showcase: Showcase Tutorial Suite
tutorial_algebra: Algebra Tutorial Module
tutorial_calculus: Calculus Tutorial Module
tutorial_geometry: Geometry Tutorial Module
tutorial_graph_theory: Graph Theory Tutorial Module
tutorial_linear_algebra: Linear Algebra Tutorial Module
tutorial_statistics: Statistics Tutorial Module
run_all_showcase_tutorials(): Run All Showcase Tutorials
run_tutorial(): Run interactive tutorial

Options & Configuration

Package configuration and onboarding

manimR_options(): manimR package options
manimR_user_prefs(): User preferences management
run_onboarding_wizard(): Run interactive onboarding wizard
get_user_mode(): Get current user mode
set_user_mode(): Set user mode
reset_onboarding(): Reset onboarding

Internal & Utilities

Internal helper functions, overview pages, and utilities

`+`(<ManimPlot>): Add operator for ManimPlot layers
`%>%`: Pipe operator
`%||%`: %||% Null coalesce operator (internal)
manimR-package: manimR: A Grammar of Mathematical Animation for R
manimR: manimR: A Grammar of Mathematical Animation for R
USER_MODE_TUTORIAL: User modes
animation_creation: Creation Animations
FadeInFromDown() FadeInFromUp() FadeInFromLeft() FadeInFromRight() FadeOutToDown() FadeOutToUp() FadeInFromLarge() FadeInFromSmall(): Fading Animations
animation_growing: Growing Animations
animation_indication: Indication Animations
animation_movement: Movement Animations
animation_rotation: Rotation Animation
animation_speed: Speed Control Animation
animation_transform: Transform Animations
animation_updaters: Updater Animations & Value Tracking
animations: Animation Pipe Functions
backend: Backend Selection and Dispatch
color_system: Color System for manimR
constants: ManimR Constants
coordinate_systems: Legacy Coordinate System Aliases
data_animation: Data-Driven Animation
data-integration: ggplot2 and Data Integration
easing: Easing Functions (Rate Functions)
geometry_angle: Angle Geometry Objects
geometry_arc: Arc-Based Geometry Objects
geometry_bezier: Bezier Curve Object
geometry_boolean: Boolean Geometry Operations
geometry_line: Line-Based Geometry Objects
geometry_polygon: Polygon-Based Geometry Objects
grammar: Grammar of Animated Graphics
interactive: Interactive Output
latex_compiler: LaTeX Compiler
number_plane: NumberPlane and Grid Classes
objects: Mathematical Objects (MObjects) - Legacy Helpers
onboarding: Onboarding and Tutorial System
rendering: Rendering Functions
renderer_abstract: Abstract Renderer Interface
renderer_agg: Agg Renderer Backend
renderer_grid: Grid Graphics Renderer Backend
renderer_svg: SVG Renderer Backend
scene_types: Specialized Scene Types
stat_viz: Statistical Visualization
svg_parser: SVG Parser for ManimR
templates: Animation Templates
three_d_mobject: 3D Base Classes
three_d_shapes: 3D Shape Primitives
transformations: Transformation Pipe Functions
utils: Utility Functions for manimR
vector_field: Vector Field Classes
vector_utils: Vector Math Utilities
draw_frame_from_state(): Draw a frame from pre-computed state
replace_ext_with(): Helper to replace extension
render_frames_batch_accelerated(): Render frames using accelerated backend
render_frames_sequential(): Render frames sequentially (fallback)
prepare_animation_data_for_backend(): Prepare animation data for backend processing
prepare_object_data_for_backend(): Prepare object data for backend processing
private_build_axes(): Build axes layer
private_build_bars(): Build bar layer
private_build_function(): Build function layer
private_build_latex(): Build LaTeX layer
private_build_layer(): Build a layer into mobjects
private_build_lines(): Build line layer
private_build_points(): Build point layer
private_build_texts(): Build text layer
private_create_transition(): Create transition animation for a mobject
ShapeObject: ShapeObject R6 Class
render.Template(): Render a template
print(<ManimPlot>): Print method for ManimPlot
build_manim_plot(): Build a ManimPlot into a Scene
render_manim_plot(): Render a ManimPlot
compile_latex_svg(): Compile LaTeX to SVG (Vector)
check_latex_deps(): Check for LaTeX tools
import_svg_file(): Import SVG file to VMobject points
parse_svg_path_data(): Parse SVG Path Data
base64encode_simple(): Simple base64 encoder (fallback when base64enc not available)
bezier(): Evaluate a point on a cubic Bezier curve
bezier_split_at(): Split a cubic Bezier at parameter t
sample_bezier(): Sample points along Bezier curves
get_smooth_handle_points(): Compute smooth Bezier handles for a sequence of anchor points
interpolate_matrices(): Linear interpolation of matrices
match_curves(): Match curve counts between two point matrices
path_length(): Compute the approximate arc length of Bezier curves
point_from_proportion(): Get point at a proportion along the path
project_points(): Perspective projection from 3D to 2D
rotate_points_3d(): Rotate points in 3D using Rodrigues' formula
set_color_by_gradient(): Apply color to submobjects by gradient
set_derivation_steps(): Set derivation steps
set_proof_steps(): Set proof steps for template
set_theorem(): Set theorem for template
polygon_result_to_vmobject(): Convert polyclip result back to VMobject points
vmobject_to_polygon(): Extract polygon vertices from a VMobject