Dot

Qualified name: algan.mobs.shapes\_2d.Dot

class Dot(location=tensor([0., 0., 0.]), radius=0.08, stroke_width=0, fill_opacity=1.0, color=Color([1., 1., 1., 0., 1.]), **kwargs)[source]

Bases: Circle

A small filled Circle, for marking a point.

Parameters:
  • location – Where to put it, shape (*, 3) in world units. Defaults to ORIGIN (the centre of the scene). The same name as location, which is what it sets.

  • radius – Radius in world units. Defaults to 0.08 – small enough to read as a marker beside shapes of unit size.

  • stroke_width – Width of the outline, in world units. Defaults to 0: a dot is solid fill with no border.

  • fill_opacity – Opacity of the fill, from 0 (invisible) to 1 (opaque). Defaults to 1.0.

  • color – An Algan Color, a named constant such as BLUE, or anything Color() accepts. Defaults to WHITE.

  • **kwargs – Passed to Circle and on to BezierCircuitCubic.

Examples

Three dots marking the corners of a triangle:

Example: Example1Dot

../_images/Example1Dot-1.png
from algan import *

for position in (UP, LEFT + DOWN, RIGHT + DOWN):
    Dot(location=position, radius=0.15, color=BLUE).spawn()

Scene.save_video()

Methods

Attributes

animation_manager

This mob's scene-owned animation manager.

basis

The Mob's orientation and scale, as a flattened 3x3 matrix of shape (*, 9).

casts_shadows

Whether this Mob's geometry blocks light on its way from a light source to another surface -- whether it casts a shadow.

children

The Mobs attached below this one, in attachment order.

closed_shell

Whether this Mob's triangles form a CLOSED shell -- every camera ray that enters the geometry crosses a second time on its way out.

draws_descendants

Whether get_render_primitives returns geometry belonging to this Mob's DESCENDANTS as well as its own.

forward

Get the direction the Mob is facing.

lifespan

This mob's [spawn, despawn) interval on its Scene timeline (a Lifespan).

location

The Mob's position in world space, shape (*, 3).

normalized_basis

The Mob's orientation with scale divided out, shape (*, 9).

parents

The Mobs this one is attached to, in attachment order.

radius

receives_shadows

Whether this Mob's surfaces are darkened by shadows cast onto them.

right

Get the Mob's own rightward direction.

scale_coefficient

The Mob's scale along its own right, up and forward axes, shape (*, 3).

stroke_color

The color of the circuit's border stroke.

two_sided

Whether this Mob's geometry should be lit from whichever side the ray arrives on.

up

Get the Mob's own upward direction.

x

The Mob's x coordinate in world units, shape (*, 1).

xy

The Mob's x and y coordinates in world units, shape (*, 2).

y

The Mob's y coordinate in world units, shape (*, 1).

z

The Mob's z coordinate in world units, shape (*, 1).

z_index

Which of two exactly coplanar circuits draws in front (higher wins).