Wipe

Wipe transition using directional clip paths.

The incoming scene is revealed from one direction while the outgoing scene is hidden in the same direction. Directions: - "left": Reveal from right to left - "right": Reveal from left to right - "up": Reveal from bottom to top - "down": Reveal from top to bottom

Constructor

Wipe(
    direction: WipeDirection = 'left',
    duration: float = 0.5,
    easing: Callable[[float], float] = <function linear at 0x107ad0cc0>,
    overlapping: bool = False
) -> None

Initialize a wipe transition.

Parameters

direction
Direction of the wipe ("left", "right", "up", "down")
duration
Duration of the transition
easing
Easing function applied to the wipe progress
overlapping
If True, scenes continue animating during transition

Methods

composite

composite(
    scene_out: 'VScene',
    scene_in: 'VScene',
    progress: float,
    time_out: float,
    time_in: float,
    ctx: RenderContext
) -> Drawing

Composite scenes with directional wipe.

Parameters

scene_out
The outgoing scene
scene_in
The incoming scene
progress
Progress through transition (0.0-1.0), already eased
time_out
Current time within outgoing scene (0.0-1.0)
time_in
Current time within incoming scene (0.0-1.0)
ctx
Render context

Returns

Drawing with wiped scenes