Skip to content

Scene

arabic_animations.core.scene.Scene

A scene represents a complete animation with one or more text objects.

Parameters:

Name Type Description Default
width int

Width of the scene in pixels

 1920
height int

Height of the scene in pixels

 1080
fps int

Frames per second for the animation

 60
Source code in arabic_animations/core/scene.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class Scene:
    """
    A scene represents a complete animation with one or more text objects.

    Args:
        width: Width of the scene in pixels
        height: Height of the scene in pixels
        fps: Frames per second for the animation
    """
    def __init__(self, width: int = 1920, height: int = 1080, fps: int = 60):
        self.width = width
        self.height = height
        self.fps = fps
        self.duration = 0
        self.objects: List[Any] = []
        self.serial = False
        self.background_color: Color = Colors.PAPER_WHITE

    def add(self, *objects: Any, serial: bool = False) -> None:
        """
        Add objects to the scene.

        Args:
            *objects: One or more objects to add to the scene
            serial: If True, objects will animate one after another. If False, they animate simultaneously.
        """
        self.serial = serial
        current_delay = 0

        for obj in objects:
            if hasattr(obj, 'set_scene_dimensions'):
                obj.set_scene_dimensions(self.width, self.height)

            if serial:
                obj.start_time = current_delay
                current_delay += obj.duration
            else:
                obj.start_time = 0

            self.objects.append(obj)

        self.duration = current_delay if serial else max(obj.duration for obj in objects)

    def render_frame(self, t: float) -> np.ndarray:
        """
        Render a single frame at time t.

        Args:
            t: Time in seconds

        Returns:
            A numpy array representing the frame in RGBA format
        """
        surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, self.width, self.height)
        ctx = cairo.Context(surface)

        # Clear background with specified color
        ctx.set_source_rgba(*self.background_color.to_rgb())
        ctx.paint()

        # Render all objects
        for obj in self.objects:
            if hasattr(obj, 'render'):
                if t >= obj.start_time and t <= obj.start_time + obj.duration:
                    obj.render(ctx, t - obj.start_time)
                elif t > obj.start_time + obj.duration:
                    obj.render(ctx, obj.duration)

        # Convert to numpy array
        data = surface.get_data()
        arr = np.ndarray(shape=(self.height, self.width, 4),
                        dtype=np.uint8,
                        buffer=data)
        return arr

add(*objects, serial=False)

Add objects to the scene.

Parameters:

Name Type Description Default
*objects Any

One or more objects to add to the scene

 ()
serial bool

If True, objects will animate one after another. If False, they animate simultaneously.

 False
Source code in arabic_animations/core/scene.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
def add(self, *objects: Any, serial: bool = False) -> None:
    """
    Add objects to the scene.

    Args:
        *objects: One or more objects to add to the scene
        serial: If True, objects will animate one after another. If False, they animate simultaneously.
    """
    self.serial = serial
    current_delay = 0

    for obj in objects:
        if hasattr(obj, 'set_scene_dimensions'):
            obj.set_scene_dimensions(self.width, self.height)

        if serial:
            obj.start_time = current_delay
            current_delay += obj.duration
        else:
            obj.start_time = 0

        self.objects.append(obj)

    self.duration = current_delay if serial else max(obj.duration for obj in objects)

render_frame(t)

Render a single frame at time t.

Parameters:

Name Type Description Default
t float

Time in seconds

 required

Returns:

Type Description
ndarray

A numpy array representing the frame in RGBA format
Source code in arabic_animations/core/scene.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
def render_frame(self, t: float) -> np.ndarray:
    """
    Render a single frame at time t.

    Args:
        t: Time in seconds

    Returns:
        A numpy array representing the frame in RGBA format
    """
    surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, self.width, self.height)
    ctx = cairo.Context(surface)

    # Clear background with specified color
    ctx.set_source_rgba(*self.background_color.to_rgb())
    ctx.paint()

    # Render all objects
    for obj in self.objects:
        if hasattr(obj, 'render'):
            if t >= obj.start_time and t <= obj.start_time + obj.duration:
                obj.render(ctx, t - obj.start_time)
            elif t > obj.start_time + obj.duration:
                obj.render(ctx, obj.duration)

    # Convert to numpy array
    data = surface.get_data()
    arr = np.ndarray(shape=(self.height, self.width, 4),
                    dtype=np.uint8,
                    buffer=data)
    return arr

Usage Examples

Basic Scene Setup

from arabic_animations.core.scene import Scene

# Create a scene with default settings (1920x1080, 60fps)
scene = Scene()

# Create a scene with custom settings
scene = Scene(
    width=1280,
    height=720,
    fps=30
)

Adding Objects

# Add a single object
scene.add(text)

# Add multiple objects in parallel
scene.add(text1, text2, serial=False)

# Add multiple objects serially
scene.add(text1, text2, serial=True)

Scene Background

from arabic_animations.core.color import Colors

# Set scene background color
scene.background_color = Colors.PAPER_CREAM