Skip to content

Wipe

Demo

Quick Start

wipe.py
from terminaltexteffects.effects.effect_wipe import Wipe

effect = Wipe("YourTextHere")
with effect.terminal_output() as terminal:
    for frame in effect:
        terminal.print(frame)

Performs a wipe across the terminal to reveal characters.

Classes:

Name Description
Wipe

Performs a wipe across the terminal to reveal characters.
WipeConfig

Configuration for the Wipe effect.
WipeIterator

Effect iterator for the Wipe effect. Does not normally need to be called directly.

Wipe

Bases: BaseEffect[WipeConfig]

Performs a wipe across the terminal to reveal characters.

Attributes:

Name Type Description
effect_config WipeConfig

Configuration for the effect.
terminal_config TerminalConfig

Configuration for the terminal.
Source code in terminaltexteffects/effects/effect_wipe.py 
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
class Wipe(BaseEffect[WipeConfig]):
    """Performs a wipe across the terminal to reveal characters.

    Attributes:
        effect_config (WipeConfig): Configuration for the effect.
        terminal_config (TerminalConfig): Configuration for the terminal.

    """

    @property
    def _config_cls(self) -> type[WipeConfig]:
        return WipeConfig

    @property
    def _iterator_cls(self) -> type[WipeIterator]:
        return WipeIterator

WipeConfig dataclass

Bases: ArgsDataClass

Configuration for the Wipe effect.

Attributes:

Name Type Description
wipe_direction Literal['column_left_to_right', 'row_top_to_bottom', 'row_bottom_to_top', 'diagonal_top_left_to_bottom_right', 'diagonal_bottom_left_to_top_right', 'diagonal_top_right_to_bottom_left', 'diagonal_bottom_right_to_top_left', 'center_to_outside', 'outside_to_center']

Direction the text will wipe.
wipe_delay int

Number of frames to wait before adding the next character group. Increase, to slow down the effect. Valid values are n >= 0.
final_gradient_stops tuple[Color, ...]

Tuple of colors for the wipe gradient.
final_gradient_steps tuple[int, ...] | int

Tuple of the number of gradient steps to use. More steps will create a smoother and longer gradient animation. Valid values are n > 0.
final_gradient_frames int

Number of frames to display each gradient step. Increase to slow down the gradient animation.
final_gradient_direction Direction

Direction of the final gradient.
Source code in terminaltexteffects/effects/effect_wipe.py 
 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
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
@argclass(
    name="wipe",
    help="Wipes the text across the terminal to reveal characters.",
    description="wipe | Wipes the text across the terminal to reveal characters.",
    epilog=(
        "Example: terminaltexteffects wipe --wipe-direction diagonal_bottom_left_to_top_right "
        "--final-gradient-stops 833ab4 fd1d1d fcb045 --final-gradient-steps 12 "
        "--final-gradient-frames 5 --wipe-delay 0"
    ),
)
@dataclass
class WipeConfig(ArgsDataClass):
    """Configuration for the Wipe effect.

    Attributes:
        wipe_direction (typing.Literal["column_left_to_right","row_top_to_bottom","row_bottom_to_top","diagonal_top_left_to_bottom_right","diagonal_bottom_left_to_top_right","diagonal_top_right_to_bottom_left","diagonal_bottom_right_to_top_left","center_to_outside","outside_to_center"]): Direction the text will wipe.
        wipe_delay (int): Number of frames to wait before adding the next character group. Increase, to
            slow down the effect. Valid values are n >= 0.
        final_gradient_stops (tuple[Color, ...]): Tuple of colors for the wipe gradient.
        final_gradient_steps (tuple[int, ...] | int): Tuple of the number of gradient steps to use. More steps will
            create a smoother and longer gradient animation. Valid values are n > 0.
        final_gradient_frames (int): Number of frames to display each gradient step. Increase to slow down the
            gradient animation.
        final_gradient_direction (Gradient.Direction): Direction of the final gradient.

    """  # noqa: E501

    wipe_direction: typing.Literal[
        "column_left_to_right",
        "row_top_to_bottom",
        "row_bottom_to_top",
        "diagonal_top_left_to_bottom_right",
        "diagonal_bottom_left_to_top_right",
        "diagonal_top_right_to_bottom_left",
        "diagonal_bottom_right_to_top_left",
        "outside_to_center",
        "center_to_outside",
    ] = ArgField(
        cmd_name="--wipe-direction",
        default="diagonal_bottom_left_to_top_right",
        choices=[
            "column_left_to_right",
            "column_right_to_left",
            "row_top_to_bottom",
            "row_bottom_to_top",
            "diagonal_top_left_to_bottom_right",
            "diagonal_bottom_left_to_top_right",
            "diagonal_top_right_to_bottom_left",
            "diagonal_bottom_right_to_top_left",
            "outside_to_center",
            "center_to_outside",
        ],
        help="Direction the text will wipe.",
    )  # type: ignore[assignment]
    "typing.Literal['column_left_to_right','row_top_to_bottom','row_bottom_to_top','diagonal_top_left_to_bottom_right','diagonal_bottom_left_to_top_right','diagonal_top_right_to_bottom_left','diagonal_bottom_right_to_top_left',]"

    wipe_delay: int = ArgField(
        cmd_name="--wipe-delay",
        type_parser=argvalidators.NonNegativeInt.type_parser,
        default=0,
        metavar=argvalidators.NonNegativeInt.METAVAR,
        help="Number of frames to wait before adding the next character group. Increase, to slow down the effect.",
    )  # type: ignore[assignment]
    "int : Number of frames to wait before adding the next character group. Increase, to slow down the effect."

    wipe_ease: easing.EasingFunction = ArgField(
        cmd_name="--wipe-ease",
        type_parser=argvalidators.Ease.type_parser,
        default=easing.linear,
        help="Easing function to use for the wipe effect.",
    )  # type: ignore[assignment]
    "easing.EasingFunction : Easing function to use for the wipe effect."

    wipe_ease_stepsize: float = ArgField(
        cmd_name="--wipe-ease-stepsize",
        type_parser=argvalidators.EasingStep.type_parser,
        default=0.01,
        metavar=argvalidators.EasingStep.METAVAR,
        help="Step size to use for the easing function.",
    )  # type: ignore[assignment]
    "float : Step size to use for the easing function."

    final_gradient_stops: tuple[Color, ...] = ArgField(
        cmd_name="--final-gradient-stops",
        type_parser=argvalidators.ColorArg.type_parser,
        nargs="+",
        default=(Color("#833ab4"), Color("#fd1d1d"), Color("#fcb045")),
        metavar=argvalidators.ColorArg.METAVAR,
        help="Space separated, unquoted, list of colors for the wipe gradient.",
    )  # type: ignore[assignment]
    "tuple[Color, ...] : Tuple of colors for the wipe gradient."

    final_gradient_steps: tuple[int, ...] | int = ArgField(
        cmd_name="--final-gradient-steps",
        type_parser=argvalidators.PositiveInt.type_parser,
        nargs="+",
        default=12,
        metavar=argvalidators.PositiveInt.METAVAR,
        help="Number of gradient steps to use. More steps will create a smoother and longer gradient animation.",
    )  # type: ignore[assignment]
    (
        "tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will "
        "create a smoother and longer gradient animation."
    )

    final_gradient_frames: int = ArgField(
        cmd_name="--final-gradient-frames",
        type_parser=argvalidators.PositiveInt.type_parser,
        default=5,
        metavar=argvalidators.PositiveInt.METAVAR,
        help="Number of frames to display each gradient step. Increase to slow down the gradient animation.",
    )  # type: ignore[assignment]
    "int : Number of frames to display each gradient step. Increase to slow down the gradient animation."

    final_gradient_direction: Gradient.Direction = ArgField(
        cmd_name="--final-gradient-direction",
        type_parser=argvalidators.GradientDirection.type_parser,
        default=Gradient.Direction.VERTICAL,
        metavar=argvalidators.GradientDirection.METAVAR,
        help="Direction of the final gradient.",
    )  # type: ignore[assignment]
    "Gradient.Direction : Direction of the final gradient."

    @classmethod
    def get_effect_class(cls) -> type[Wipe]:
        """Get the effect class associated with this configuration."""
        return Wipe

final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', type_parser=argvalidators.GradientDirection.type_parser, default=Gradient.Direction.VERTICAL, metavar=argvalidators.GradientDirection.METAVAR, help='Direction of the final gradient.') class-attribute instance-attribute

Gradient.Direction : Direction of the final gradient.

final_gradient_frames = ArgField(cmd_name='--final-gradient-frames', type_parser=argvalidators.PositiveInt.type_parser, default=5, metavar=argvalidators.PositiveInt.METAVAR, help='Number of frames to display each gradient step. Increase to slow down the gradient animation.') class-attribute instance-attribute

int : Number of frames to display each gradient step. Increase to slow down the gradient animation.

final_gradient_steps = ArgField(cmd_name='--final-gradient-steps', type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Number of gradient steps to use. More steps will create a smoother and longer gradient animation.') class-attribute instance-attribute

tuple[int, ...] | int : Int or Tuple of ints for the number of gradient steps to use. More steps will create a smoother and longer gradient animation.

final_gradient_stops = ArgField(cmd_name='--final-gradient-stops', type_parser=argvalidators.ColorArg.type_parser, nargs='+', default=(Color('#833ab4'), Color('#fd1d1d'), Color('#fcb045')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the wipe gradient.') class-attribute instance-attribute

tuple[Color, ...] : Tuple of colors for the wipe gradient.

wipe_delay = ArgField(cmd_name='--wipe-delay', type_parser=argvalidators.NonNegativeInt.type_parser, default=0, metavar=argvalidators.NonNegativeInt.METAVAR, help='Number of frames to wait before adding the next character group. Increase, to slow down the effect.') class-attribute instance-attribute

int : Number of frames to wait before adding the next character group. Increase, to slow down the effect.

wipe_direction = ArgField(cmd_name='--wipe-direction', default='diagonal_bottom_left_to_top_right', choices=['column_left_to_right', 'column_right_to_left', 'row_top_to_bottom', 'row_bottom_to_top', 'diagonal_top_left_to_bottom_right', 'diagonal_bottom_left_to_top_right', 'diagonal_top_right_to_bottom_left', 'diagonal_bottom_right_to_top_left', 'outside_to_center', 'center_to_outside'], help='Direction the text will wipe.') class-attribute instance-attribute

typing.Literal['column_left_to_right','row_top_to_bottom','row_bottom_to_top','diagonal_top_left_to_bottom_right','diagonal_bottom_left_to_top_right','diagonal_top_right_to_bottom_left','diagonal_bottom_right_to_top_left',]

wipe_ease = ArgField(cmd_name='--wipe-ease', type_parser=argvalidators.Ease.type_parser, default=easing.linear, help='Easing function to use for the wipe effect.') class-attribute instance-attribute

easing.EasingFunction : Easing function to use for the wipe effect.

wipe_ease_stepsize = ArgField(cmd_name='--wipe-ease-stepsize', type_parser=argvalidators.EasingStep.type_parser, default=0.01, metavar=argvalidators.EasingStep.METAVAR, help='Step size to use for the easing function.') class-attribute instance-attribute

float : Step size to use for the easing function.

get_effect_class() classmethod

Get the effect class associated with this configuration.

Source code in terminaltexteffects/effects/effect_wipe.py 
148
149
150
151
@classmethod
def get_effect_class(cls) -> type[Wipe]:
    """Get the effect class associated with this configuration."""
    return Wipe

WipeIterator

Bases: BaseEffectIterator[WipeConfig]

Effect iterator for the Wipe effect.

Source code in terminaltexteffects/effects/effect_wipe.py 
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
class WipeIterator(BaseEffectIterator[WipeConfig]):
    """Effect iterator for the Wipe effect."""

    def __init__(self, effect: Wipe) -> None:
        """Initialize the effect iterator.

        Args:
            effect (Wipe): The effect to use for the iterator.

        """
        super().__init__(effect)
        self.groups: list[list[EffectCharacter]] = []
        self.active_groups: list[list[EffectCharacter]] = []
        self.character_final_color_map: dict[EffectCharacter, Color] = {}
        self.wipe_ease = easing.eased_step_function(self.config.wipe_ease, self.config.wipe_ease_stepsize)
        self.complete = False
        self.build()

    def build(self) -> None:
        """Build the effect."""
        final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
        final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
            self.terminal.canvas.text_bottom,
            self.terminal.canvas.text_top,
            self.terminal.canvas.text_left,
            self.terminal.canvas.text_right,
            self.config.final_gradient_direction,
        )
        for character in self.terminal.get_characters():
            self.character_final_color_map[character] = final_gradient_mapping[character.input_coord]
        sort_map = {
            "column_left_to_right": self.terminal.CharacterGroup.COLUMN_LEFT_TO_RIGHT,
            "column_right_to_left": self.terminal.CharacterGroup.COLUMN_RIGHT_TO_LEFT,
            "row_top_to_bottom": self.terminal.CharacterGroup.ROW_TOP_TO_BOTTOM,
            "row_bottom_to_top": self.terminal.CharacterGroup.ROW_BOTTOM_TO_TOP,
            "diagonal_top_left_to_bottom_right": self.terminal.CharacterGroup.DIAGONAL_TOP_LEFT_TO_BOTTOM_RIGHT,
            "diagonal_bottom_left_to_top_right": self.terminal.CharacterGroup.DIAGONAL_BOTTOM_LEFT_TO_TOP_RIGHT,
            "diagonal_top_right_to_bottom_left": self.terminal.CharacterGroup.DIAGONAL_TOP_RIGHT_TO_BOTTOM_LEFT,
            "diagonal_bottom_right_to_top_left": self.terminal.CharacterGroup.DIAGONAL_BOTTOM_RIGHT_TO_TOP_LEFT,
            "center_to_outside": self.terminal.CharacterGroup.CENTER_TO_OUTSIDE_DIAMONDS,
            "outside_to_center": self.terminal.CharacterGroup.OUTSIDE_TO_CENTER_DIAMONDS,
        }
        character_groups = self.terminal.get_characters_grouped(sort_map[self.config.wipe_direction])
        for group in character_groups:
            for character in group:
                wipe_scn = character.animation.new_scene(scene_id="wipe")
                wipe_gradient = Gradient(
                    final_gradient.spectrum[0],
                    self.character_final_color_map[character],
                    steps=self.config.final_gradient_steps,
                )
                wipe_scn.apply_gradient_to_symbols(
                    character.input_symbol,
                    self.config.final_gradient_frames,
                    fg_gradient=wipe_gradient,
                )
                character.animation.activate_scene(wipe_scn)
            self.groups.append(group)
        self._wipe_delay = self.config.wipe_delay

    def __next__(self) -> str:
        """Return the next frame in the animation."""
        if not self.complete or self.active_characters:
            if not self._wipe_delay:
                current_step, progress_ratio = self.wipe_ease()
                target_active_group_count = min(int(len(self.groups) * progress_ratio), len(self.groups))

                # if the easing function results in a decreased progress ratio, deactivate groups
                if target_active_group_count < len(self.active_groups):
                    for group in self.active_groups[target_active_group_count:]:
                        for character in group:
                            self.terminal.set_character_visibility(character, is_visible=False)
                            scn = character.animation.active_scene
                            if scn:
                                scn.reset_scene()
                                character.animation.deactivate_scene(scn)

                    self.active_groups = self.active_groups[:target_active_group_count]

                if len(self.active_groups) < target_active_group_count:
                    for i in range(target_active_group_count):
                        group = self.groups[i]
                        if group in self.active_groups:
                            continue
                        for character in group:
                            self.terminal.set_character_visibility(character, is_visible=True)
                            scn = character.animation.query_scene("wipe")
                            if scn:
                                character.animation.activate_scene(scn)
                            self.active_characters.add(character)
                        self.active_groups.append(group)
                self._wipe_delay = self.config.wipe_delay
                if current_step == 1:
                    self.complete = True
            else:
                self._wipe_delay -= 1
            self.update()
            return self.frame

        raise StopIteration

__init__(effect)

Initialize the effect iterator.

Parameters:

Name Type Description Default
effect Wipe

The effect to use for the iterator.

 required
Source code in terminaltexteffects/effects/effect_wipe.py 
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def __init__(self, effect: Wipe) -> None:
    """Initialize the effect iterator.

    Args:
        effect (Wipe): The effect to use for the iterator.

    """
    super().__init__(effect)
    self.groups: list[list[EffectCharacter]] = []
    self.active_groups: list[list[EffectCharacter]] = []
    self.character_final_color_map: dict[EffectCharacter, Color] = {}
    self.wipe_ease = easing.eased_step_function(self.config.wipe_ease, self.config.wipe_ease_stepsize)
    self.complete = False
    self.build()

__next__()

Return the next frame in the animation.

Source code in terminaltexteffects/effects/effect_wipe.py 
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def __next__(self) -> str:
    """Return the next frame in the animation."""
    if not self.complete or self.active_characters:
        if not self._wipe_delay:
            current_step, progress_ratio = self.wipe_ease()
            target_active_group_count = min(int(len(self.groups) * progress_ratio), len(self.groups))

            # if the easing function results in a decreased progress ratio, deactivate groups
            if target_active_group_count < len(self.active_groups):
                for group in self.active_groups[target_active_group_count:]:
                    for character in group:
                        self.terminal.set_character_visibility(character, is_visible=False)
                        scn = character.animation.active_scene
                        if scn:
                            scn.reset_scene()
                            character.animation.deactivate_scene(scn)

                self.active_groups = self.active_groups[:target_active_group_count]

            if len(self.active_groups) < target_active_group_count:
                for i in range(target_active_group_count):
                    group = self.groups[i]
                    if group in self.active_groups:
                        continue
                    for character in group:
                        self.terminal.set_character_visibility(character, is_visible=True)
                        scn = character.animation.query_scene("wipe")
                        if scn:
                            character.animation.activate_scene(scn)
                        self.active_characters.add(character)
                    self.active_groups.append(group)
            self._wipe_delay = self.config.wipe_delay
            if current_step == 1:
                self.complete = True
        else:
            self._wipe_delay -= 1
        self.update()
        return self.frame

    raise StopIteration

build()

Build the effect.

Source code in terminaltexteffects/effects/effect_wipe.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
def build(self) -> None:
    """Build the effect."""
    final_gradient = Gradient(*self.config.final_gradient_stops, steps=self.config.final_gradient_steps)
    final_gradient_mapping = final_gradient.build_coordinate_color_mapping(
        self.terminal.canvas.text_bottom,
        self.terminal.canvas.text_top,
        self.terminal.canvas.text_left,
        self.terminal.canvas.text_right,
        self.config.final_gradient_direction,
    )
    for character in self.terminal.get_characters():
        self.character_final_color_map[character] = final_gradient_mapping[character.input_coord]
    sort_map = {
        "column_left_to_right": self.terminal.CharacterGroup.COLUMN_LEFT_TO_RIGHT,
        "column_right_to_left": self.terminal.CharacterGroup.COLUMN_RIGHT_TO_LEFT,
        "row_top_to_bottom": self.terminal.CharacterGroup.ROW_TOP_TO_BOTTOM,
        "row_bottom_to_top": self.terminal.CharacterGroup.ROW_BOTTOM_TO_TOP,
        "diagonal_top_left_to_bottom_right": self.terminal.CharacterGroup.DIAGONAL_TOP_LEFT_TO_BOTTOM_RIGHT,
        "diagonal_bottom_left_to_top_right": self.terminal.CharacterGroup.DIAGONAL_BOTTOM_LEFT_TO_TOP_RIGHT,
        "diagonal_top_right_to_bottom_left": self.terminal.CharacterGroup.DIAGONAL_TOP_RIGHT_TO_BOTTOM_LEFT,
        "diagonal_bottom_right_to_top_left": self.terminal.CharacterGroup.DIAGONAL_BOTTOM_RIGHT_TO_TOP_LEFT,
        "center_to_outside": self.terminal.CharacterGroup.CENTER_TO_OUTSIDE_DIAMONDS,
        "outside_to_center": self.terminal.CharacterGroup.OUTSIDE_TO_CENTER_DIAMONDS,
    }
    character_groups = self.terminal.get_characters_grouped(sort_map[self.config.wipe_direction])
    for group in character_groups:
        for character in group:
            wipe_scn = character.animation.new_scene(scene_id="wipe")
            wipe_gradient = Gradient(
                final_gradient.spectrum[0],
                self.character_final_color_map[character],
                steps=self.config.final_gradient_steps,
            )
            wipe_scn.apply_gradient_to_symbols(
                character.input_symbol,
                self.config.final_gradient_frames,
                fg_gradient=wipe_gradient,
            )
            character.animation.activate_scene(wipe_scn)
        self.groups.append(group)
    self._wipe_delay = self.config.wipe_delay

get_effect_and_args()

Get the effect class and its configuration class.

Source code in terminaltexteffects/effects/effect_wipe.py 
20
21
22
def get_effect_and_args() -> tuple[type[typing.Any], type[ArgsDataClass]]:
    """Get the effect class and its configuration class."""
    return Wipe, WipeConfig