Reference Manual¶
This reference manual details modules, functions, and variables included in Algan, describing what they are and what they do. For learning how to use Algan, see New User Tutorials.
Warning
The pages linked to here are currently a work in progress.
Inheritance Graphs¶
Animation¶
Animations¶
digraph inheritancef1be3b2e97 { bgcolor=transparent; concentrate=True; nodesep=0.1; rankdir=LR; ranksep=0.2; size=""; splines=ortho; "Animatable" [URL="reference/algan.animation.animatable.Animatable.html#algan.animation.animatable.Animatable",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for anything that needs animation.",width=0.05]; "AnimatableData" [URL="reference/algan.animation.animatable.AnimatableData.html#algan.animation.animatable.AnimatableData",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A container for all of the animation-relevant data for a mob, including its ModificationHistory.",width=0.05]; "Mob" [URL="reference/algan.mobs.mob.Mob.html#algan.mobs.mob.Mob",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all objects that have a location and orientation in 3-D space.",width=0.05]; "Animatable" -> "Mob" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "ModificationHistory" [URL="reference/algan.animation.animatable.ModificationHistory.html#algan.animation.animatable.ModificationHistory",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A complete record of every change applied to a particular Mob, and the timestamps those changes occur over.",width=0.05]; "ModifiedProtectedAttributeError" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",width=0.05]; "TimeInterval" [URL="reference/algan.animation.animatable.TimeInterval.html#algan.animation.animatable.TimeInterval",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; }Cameras¶
digraph inheritancee160abe75a { bgcolor=transparent; concentrate=True; nodesep=0.1; rankdir=LR; ranksep=0.2; size=""; splines=ortho; "Camera" [URL="reference/algan.rendering.camera.Camera.html#algan.rendering.camera.Camera",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; }Mobs¶
digraph inheritance77334eaf37 { bgcolor=transparent; concentrate=True; nodesep=0.1; rankdir=LR; ranksep=0.2; size=""; splines=ortho; "BezierCircuitCubic" [URL="reference/algan.mobs.bezier_circuit.BezierCircuitCubic.html#algan.mobs.bezier_circuit.BezierCircuitCubic",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Renderable" -> "BezierCircuitCubic" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "BezierCurveCubic" [URL="reference/algan.mobs.bezier_circuit.BezierCurveCubic.html#algan.mobs.bezier_circuit.BezierCurveCubic",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "BezierCircuitCubic" -> "BezierCurveCubic" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Circle" [URL="reference/algan.mobs.shapes_2d.Circle.html#algan.mobs.shapes_2d.Circle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A circle.",width=0.05]; "BezierCircuitCubic" -> "Circle" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Mob" [URL="reference/algan.mobs.mob.Mob.html#algan.mobs.mob.Mob",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for all objects that have a location and orientation in 3-D space.",width=0.05]; "OldTex" [URL="reference/algan.mobs.text.OldTex.html#algan.mobs.text.OldTex",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mob for displaying tex.",width=0.05]; "Mob" -> "OldTex" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Polygon" [URL="reference/algan.mobs.shapes_2d.Polygon.html#algan.mobs.shapes_2d.Polygon",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A 2-D planar polygon with N vertices.",width=0.05]; "BezierCircuitCubic" -> "Polygon" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Quad" [URL="reference/algan.mobs.shapes_2d.Quad.html#algan.mobs.shapes_2d.Quad",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Polygon" -> "Quad" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "QuadTriangulated" [URL="reference/algan.mobs.shapes_2d.QuadTriangulated.html#algan.mobs.shapes_2d.QuadTriangulated",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Mob" -> "QuadTriangulated" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Rectangle" [URL="reference/algan.mobs.shapes_2d.Rectangle.html#algan.mobs.shapes_2d.Rectangle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A rectangle.",width=0.05]; "Quad" -> "Rectangle" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "RegularPolygon" [URL="reference/algan.mobs.shapes_2d.RegularPolygon.html#algan.mobs.shapes_2d.RegularPolygon",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A 2-D planar polygon with the given number of vertices spaced evenly around",width=0.05]; "Polygon" -> "RegularPolygon" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Renderable" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",tooltip="Base class for all objects that appear on screen.",width=0.05]; "Mob" -> "Renderable" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Square" [URL="reference/algan.mobs.shapes_2d.Square.html#algan.mobs.shapes_2d.Square",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A square.",width=0.05]; "Rectangle" -> "Square" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Tex" [URL="reference/algan.mobs.text.Tex.html#algan.mobs.text.Tex",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Mob" -> "Tex" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Text" [URL="reference/algan.mobs.text.Text.html#algan.mobs.text.Text",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Mob for displaying LaTeX.",width=0.05]; "Tex" -> "Text" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "Triangle" [URL="reference/algan.mobs.shapes_2d.Triangle.html#algan.mobs.shapes_2d.Triangle",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Polygon" -> "Triangle" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "TriangleTriangulated" [URL="reference/algan.mobs.shapes_2d.TriangleTriangulated.html#algan.mobs.shapes_2d.TriangleTriangulated",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Mob" -> "TriangleTriangulated" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; "TriangleVertices" [URL="reference/algan.mobs.shapes_2d.TriangleVertices.html#algan.mobs.shapes_2d.TriangleVertices",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; "Renderable" -> "TriangleVertices" [arrowsize=0.5,penwidth=1,style="setlinewidth(0.5)"]; }Scenes¶
digraph inheritancec645c56b77 { bgcolor=transparent; concentrate=True; nodesep=0.1; rankdir=LR; ranksep=0.2; size=""; splines=ortho; "EmptySceneWarning" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",width=0.05]; "Scene" [URL="reference/algan.scene.Scene.html#algan.scene.Scene",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.05,margin=0.05,penwidth=0,shape=box,style="setlinewidth(0.5),filled",target="_top",width=0.05]; }Module Index¶
- Mobs
- Animation
- Rendering
- camera
- pbr_shaders
- primitive
- triangle_primitive
- bezier_circuit_primitive
- BezierCircuitPrimitive
evaluate_cubic_bezier()evaluate_cubic_bezier_derivative()evaluate_cubic_bezier_derivative_old()evaluate_cubic_bezier_derivative_with_end()evaluate_cubic_bezier_old()evaluate_cubic_bezier_old2()evaluate_cubic_bezier_old3()evaluate_cubic_bezier_second_derivative()solve_cubic_bezier_second_derivative_equal_to_0()
- Scenes
- Settings
- Utils
render_to_file()- algan_utils
- animation_utils
- 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_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()prepare_kwargs()reduce_max_score()robust_concat()scatter_arg_max()shuffle()squish()unpack_tensor()unsqueeze_dims()unsqueeze_left()unsqueeze_pack_tensors()unsqueeze_right()unsqueeze_until_dim()unsquish()
- python_utils