Reference Manual¶
Detailed API documentation for all of Algan’s modules, classes, methods, and functions. If you are looking for guides and tutorials, head to New User Tutorials or Advanced User Tutorials.
Class Hierarchies¶
Animatables and Mobs¶
Cameras¶
Scenes¶
Module Index¶
- Scenes
- Animation
- animatable
- mob
- mob_hierarchy
- mob_orientation
- mob_movement
- mob_layout
- mob_morph
- mob_materials
- animation_contexts
- timeline
- AnimationTimeline
- AttributeTimeline
- EditQueryIndex
- EditRecord
- FunctionApplicationEvent
- FunctionTimeline
- Lifespan
- RowRanges
- SegmentWindow
- TimelineEvent
- TimelineManager
- TimelineSpan
- UpdaterEvent
- UpdaterSpan
bump_hierarchy_version()bump_spawn_version()bump_structure_version()bump_timing_version()clear_wide_attribute_device_pin()generate_array_states()wide_attribute_device_pin()
- manim_animations
- movement
- changing
- indication
- Runtime Mob Attributes
- Core
- errors
- algan.errors.AlganConfigurationError
- algan.errors.AlganError
- algan.errors.AlganWarning
- algan.errors.ApproximationWarning
- algan.errors.AudioTranscriptMismatchError
- algan.errors.ContextReuseError
- algan.errors.DespawnedMobWarning
- algan.errors.HierarchyChangedDuringUpdaterWarning
- algan.errors.HierarchyError
- algan.errors.InvalidColorError
- algan.errors.LegacySceneDiscoveryWarning
- algan.errors.ModifiedProtectedAttributeError
- algan.errors.NeverSpawnedMobWarning
- algan.errors.UnsupportedFeatureError
- algan.errors.UnsupportedFeatureWarning
- color
- material_presets
- spatial
- math
- easings
delay_fade()ease_in_back()ease_in_bounce()ease_in_circ()ease_in_cubic()ease_in_elastic()ease_in_expo()ease_in_out_back()ease_in_out_bounce()ease_in_out_circ()ease_in_out_cubic()ease_in_out_elastic()ease_in_out_quad()ease_in_out_quart()ease_in_out_quint()ease_in_out_sine()ease_in_quad()ease_in_quart()ease_in_quint()ease_in_sine()ease_out_back()ease_out_bounce()ease_out_circ()ease_out_cubic()ease_out_elastic()ease_out_exp()ease_out_exp_square()ease_out_expo()ease_out_quad()ease_out_quart()ease_out_quint()ease_out_quintic()ease_out_sine()identity()inversed()linear()pulse_fade()rush_from()rush_into()slow_into()smooth()tan()
- geometry
distance()get_2d_polygon_mask()get_2d_polygon_mask2()get_orthonormal_vector()get_rotation_around_axis()get_rotation_between_3d_vectors()get_rotation_between_bases()get_rotation_between_orthonormal_bases()intersect_line_with_plane()intersect_line_with_plane_colinear()invert_row_basis()map_global_to_local_coords()map_local_to_global_coords()normalize()project_onto_basis()project_point_onto_line()project_point_onto_line_segment()project_point_onto_plane()rotate_basis_to_direction()rotate_vector_around_axis()
- logger
- errors
- Mobs
- group
- text
- image_mob
- image_compat
- manim_compat
- Angle
- AnnotationDot
- AnnularSector
- Annulus
- Arc
- ArcBetweenPoints
- ArcBrace
- ArcPolygon
- ArcPolygonFromArcs
- Arrow
- Arrow3D
- ArrowCircleFilledTip
- ArrowCircleTip
- ArrowSquareFilledTip
- ArrowSquareTip
- ArrowTip
- ArrowTriangleFilledTip
- ArrowTriangleTip
- ArrowVectorField
- Axes
- BackgroundRectangle
- BarChart
- Brace
- BraceBetweenPoints
- BraceLabel
- BraceText
- BulletedList
- Circle
- Code
- ComplexPlane
- ComplexValueTracker
- Cone
- ConvexHull
- ConvexHull3D
- Cross
- Cube
- CubicBezier
- CurvedArrow
- CurvedDoubleArrow
- CurvesAsSubmobjects
- Cutout
- Cylinder
- DashedLine
- DashedVMobject
- DecimalMatrix
- DecimalNumber
- DecimalTable
- DiGraph
- Difference
- Dodecahedron
- Dot
- Dot3D
- DoubleArrow
- Elbow
- Ellipse
- Exclusion
- FullScreenRectangle
- FunctionGraph
- Graph
- Group
- Icosahedron
- ImplicitFunction
- Integer
- IntegerMatrix
- IntegerTable
- Intersection
- Label
- LabeledArrow
- LabeledDot
- LabeledLine
- LabeledPolygram
- Line
- Line3D
- ManimBanner
- ManimCompatMob
- MarkupText
- MathTable
- MathTex
- MathTexPart
- Matrix
- MobjectMatrix
- MobjectTable
- NumberLine
- NumberPlane
- Octahedron
- OpenGLAnnularSector
- OpenGLAnnulus
- OpenGLArc
- OpenGLArcBetweenPoints
- OpenGLArrow
- OpenGLArrowTip
- OpenGLCircle
- OpenGLCubicBezier
- OpenGLCurvedArrow
- OpenGLCurvedDoubleArrow
- OpenGLCurvesAsSubmobjects
- OpenGLDashedLine
- OpenGLDashedVMobject
- OpenGLDot
- OpenGLDoubleArrow
- OpenGLElbow
- OpenGLEllipse
- OpenGLGroup
- OpenGLLine
- OpenGLPoint
- OpenGLPolygon
- OpenGLRectangle
- OpenGLRegularPolygon
- OpenGLRoundedRectangle
- OpenGLSector
- OpenGLSquare
- OpenGLTangentLine
- OpenGLTipableVMobject
- OpenGLTriangle
- OpenGLVGroup
- OpenGLVMobject
- OpenGLVector
- OpenGLVectorizedPoint
- Paragraph
- ParametricFunction
- Point
- PolarPlane
- Polygon
- Polygram
- Polyhedron
- Prism
- Rectangle
- RegularPolygon
- RegularPolygram
- RightAngle
- RoundedRectangle
- SVGMobject
- SampleSpace
- ScreenRectangle
- Sector
- SingleStringMathTex
- Sphere
- Square
- Star
- StealthTip
- StreamLines
- Surface
- SurroundingRectangle
- Table
- TangentLine
- TangentialArc
- Tetrahedron
- Tex
- Text
- ThreeDAxes
- ThreeDVMobject
- TipableVMobject
- Title
- Torus
- Triangle
- Underline
- Union
- UnitInterval
- VDict
- VGroup
- VMobject
- VMobjectFromSVGPath
- ValueTracker
- Variable
- Vector
- VectorField
- VectorizedPoint
from_manim()install_opengl_aliases()to_manim()
- opengl_compat
- bezier_circuit
- triangulated_bezier_circuit
- TriangulatedBezierCircuit
cubic_bezier_derivative_eval()cubic_bezier_eval()get_corners()get_points_along_cubic_bezier()get_points_along_line()get_points_per_tile()params_to_tensor()point_to_tensor()point_to_tensor2()project_onto_cubic_bezier()project_onto_line()tile_region()tile_region2()triangulate_simple_polygon()
- shapes_2d
- shapes_3d
- point_cloud
- surface
- procedural_textures
- three_d_models
- mesh
- model_mob
- assimp_loader
- gltf_loader
- scene_data
- manim_mob
- numeric_display
- The Manim Compatibility Layer
- Delegated Manim Methods
- SceneData Fields
algan.mobs.three_d_models.scene_data.SceneData.meshesalgan.mobs.three_d_models.scene_data.SceneData.materialsalgan.mobs.three_d_models.scene_data.SceneData.nodesalgan.mobs.three_d_models.scene_data.SceneData.animationsalgan.mobs.three_d_models.scene_data.SceneData.unit_scalealgan.mobs.three_d_models.scene_data.SceneData.source_path
- Rendering
- camera
- lights
- materials
- Texture maps
- Limitations
- AdvancedPBRMaterial
- DiffuseMaterial
- ManimMaterial
- Material
- MeshBasicMaterial
- MeshDepthMaterial
- MeshLambertMaterial
- MeshMatcapMaterial
- MeshNormalMaterial
- MeshPhongMaterial
- MeshPhysicalMaterial
- MeshStandardMaterial
- MeshToonMaterial
- PBRMaterial
- Side
- SpecularMaterial
- UnlitMaterial
- material_shaders
- pbr_shaders
- fragment_shaders
- tracer
- raytracing
- settings
analytic_aa_bez_active()analytic_aa_bez_mode()analytic_aa_sliver_mode()analytic_aa_tri_active()effective_analytic_aa_secondary_samples()glossy_blur_sigma_px()glossy_reflection_mode()hdr_frame_dtype()is_post_process_tonemap_enabled()is_post_tonemap_kernel_enabled()kernel_compiled_in_values()merge_on_gpu_active()nested_ior_mode()note_sparse_discovery_footprint()pn_criterion_kernel_active()project_on_gpu_active()raster_write_compact_active()refit_bvh_active()report_unsupported_features()set_analytic_aa()set_bez_bvh_split()set_bvh_defer()set_bvh_refit()set_denoise_precision()set_frag_pid_gate()set_fragment_shading()set_glossy_reflection()set_hdr_buffer_f16()set_hybrid_raster()set_linear_color_space()set_merge_dedup_geometry()set_merge_dedup_time()set_merge_on_gpu()set_mesh_id()set_nested_ior()set_opaque_bvh_skip_dead()set_per_mob_shadow_flags()set_pn_criterion_kernel()set_polyhedron_winding()set_post_process_tonemap()set_post_tonemap_kernel()set_project_on_gpu()set_pt_authored_light_sampling()set_raster_bez_precompute()set_raster_covered_shade()set_raster_empty_skip()set_raster_fused_gather()set_raster_opaque_trunc_kernel()set_raster_pair_expand_kernel()set_raster_pair_flags()set_raster_span_candidates()set_raster_sparse_coverage()set_raster_ss()set_raster_straddle_clip()set_raster_tri_precompute()set_raster_write_compact()set_rgb_shadow_tint()set_samples_per_pixel()set_shadow_adaptive_taps()set_shadow_anyhit()set_shadow_eps_relative()set_shadow_identity_reject()set_shadow_near_fraction()set_shadow_sided_cull()set_shadow_terminator()set_shadows()set_sheet_band_stats_kernel()set_sheet_mask_kernel()set_sheet_one_mesh_kernel()set_sheet_positioned_depth()set_sheet_rank_kernel()set_sheet_resolve()set_sheet_resolve_memo()set_sheet_sample_depth()set_sheet_sample_depth_kernel()set_sheet_shade_split()set_sheet_shell_ceiling_kernel()set_sliver_split()set_texture_content_dedup()set_texture_opacity_in_kernel()set_texture_time_flat()set_texture_time_lerp()set_texture_u8_storage()set_texture_window_collapse()set_tonemap_exposure()set_tonemap_method()set_tonemapping()set_unsupported_feature_policy()set_watertight_tri()set_wavefront_tile_auto()set_weld_surface_seams()set_wf_deferred_shadows()set_wf_gen_fused()set_wf_ray_sort()set_wf_ray_sort_min()set_wf_shadow_event_sort()shadow_terminator_mode()sparse_discovery_bytes_for_frames()texture_opacity_in_kernel_active()texture_time_lerp_active()wf_gen_fused_active()
- truncation
- denoise
- primitive
- triangle_primitive
- bezier_circuit_primitive
- post_processing
- memory_model
- Runtime Light Attributes
- Settings
- Utilities
- algan_utils
- animation_utils
- file_utils
- memory_utils
- AllocationRecorder
- ManualMemory
- ScopeRecord
- TempMemoryContext
auto_record_enabled()begin_cuda_peak()clear_recorded_arenas()cuda_peak_scope()end_cuda_peak()ensure_render_headroom()get_num_available_bytes()is_cuda_oom()note_nonarena_peak()peak_allocated()recorded_arenas()recorded_nonarena_peaks()release_torch_memory()reset_peak_floor()scene_excluded_from_gc()set_auto_record()- algan.utils.memory_utils.InsufficientMemoryException
- mob_utils
- manim_svg_cache
- singleton
- tensor_utils
add_dummy_dims_left()add_dummy_dims_right()broadcast()broadcast_all()broadcast_both()broadcast_both_left()broadcast_cross_product()broadcast_gather()broadcast_interleave()broadcast_scatter()cast_to_direction()cast_to_tensor()cast_to_tensor_single()concat_dicts()dot_product()dot_product_in_place()expand_as_left()expand_as_right()implements()interpolate()make_grid()mean()mid_point()offset()pack_tensor()packed_reorder()pad_dim_left()pad_dim_right()pad_dims()reduce_max_score()reject_non_finite()reject_outside_unit_interval()robust_concat()shuffle()squish()texture_u8_provenance()unpack_tensor()unsqueeze_dims()unsqueeze_left()unsqueeze_pack_tensors()unsqueeze_right()unsqueeze_until_dim()unsquish()
- python_utils
- audio_effect