Skip to content

wipe

Classes:

WipeEffect

WipeEffect(
    *,
    direction: Literal[
        "left", "right", "up", "down"
    ] = "left",
    **kwargs: Any,
)

Bases: BaseEffect

direction: >
    Direction of the wipe sweep.
    Default is ``left`` (left-to-right reveal).

Methods:

Source code in src/movfx/effects/wipe.py
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(
    self,
    *,
    direction: Literal["left", "right", "up", "down"] = "left",
    **kwargs: Any,
) -> None:
    """
    title: Initialize wipe effect
    parameters:
        direction: >
            Direction of the wipe sweep.
            Default is ``left`` (left-to-right reveal).
    """
    super().__init__(**kwargs)
    self.direction = direction

build_clip

build_clip(
    img_from: ndarray,
    img_to: ndarray,
    duration: float,
    fps: int = 30,
) -> VideoClip
Source code in src/movfx/effects/base.py
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def build_clip(
    self,
    img_from: np.ndarray,
    img_to: np.ndarray,
    duration: float,
    fps: int = 30,
) -> VideoClip:
    """
    title: Build a moviepy VideoClip from the effect
    parameters:
        img_from: Source image as a NumPy RGB array
        img_to: Destination image as a NumPy RGB array
        duration: Duration of the clip in seconds
        fps: Frames per second
    returns: A moviepy VideoClip with the transition
    """

    def make_frame(t: float) -> np.ndarray:
        progress = t / duration if duration > 0 else 1.0
        progress = max(0.0, min(1.0, progress))
        return self.render_frame(img_from, img_to, progress)

    clip = VideoClip(make_frame, duration=duration)
    clip = clip.with_fps(fps)
    return clip

render_frame

render_frame(
    img_from: ndarray, img_to: ndarray, progress: float
) -> ndarray
Source code in src/movfx/effects/wipe.py
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
def render_frame(
    self,
    img_from: np.ndarray,
    img_to: np.ndarray,
    progress: float,
) -> np.ndarray:
    """
    title: Render a wipe frame
    parameters:
        img_from: Source image array
        img_to: Destination image array
        progress: Wipe progress from 0.0 to 1.0
    returns: Composited frame as uint8 array
    """
    h, w = img_from.shape[:2]
    frame = img_from.copy()

    if self.direction == "left":
        boundary = int(w * progress)
        frame[:, :boundary] = img_to[:, :boundary]
    elif self.direction == "right":
        boundary = int(w * (1.0 - progress))
        frame[:, boundary:] = img_to[:, boundary:]
    elif self.direction == "up":
        boundary = int(h * progress)
        frame[:boundary, :] = img_to[:boundary, :]
    elif self.direction == "down":
        boundary = int(h * (1.0 - progress))
        frame[boundary:, :] = img_to[boundary:, :]

    return frame