Quick Start
from terminaltexteffects.effects.effect_print import Print
effect = Print("YourTextHere")
with effect.terminal_output() as terminal:
for frame in effect:
terminal.print(frame)
Prints the input data one line at at time with a carriage return and line feed.
Classes:
Name | Description |
---|---|
Print |
Prints the input data one line at at time with a carriage return and line feed. |
PrintConfig |
Configuration for the Print effect. |
PrintIterator |
Effect iterator for the Print effect. Does not normally need to be called directly. |
Print
Bases: BaseEffect[PrintConfig]
Prints the input data one line at at time with a carriage return and line feed.
Attributes:
Name | Type | Description |
---|---|---|
effect_config |
PrintConfig
|
Configuration for the effect. |
terminal_config |
TerminalConfig
|
Configuration for the terminal |
Source code in terminaltexteffects/effects/effect_print.py
PrintConfig
dataclass
Bases: ArgsDataClass
Configuration for the Print effect.
Attributes:
Name | Type | Description |
---|---|---|
print_head_return_speed |
float
|
Speed of the print head when performing a carriage return. |
print_speed |
int
|
Speed of the print head when printing characters. |
print_head_easing |
EasingFunction
|
Easing function to use for print head movement. |
final_gradient_stops |
tuple[Color, ...]
|
Tuple of colors for the final color gradient. If only one " "color is provided, the characters will be displayed in that color. |
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_direction |
Direction
|
Direction of the final gradient. |
Source code in terminaltexteffects/effects/effect_print.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 |
|
final_gradient_direction = ArgField(cmd_name='--final-gradient-direction', type_parser=argvalidators.GradientDirection.type_parser, default=Gradient.Direction.DIAGONAL, metavar=argvalidators.GradientDirection.METAVAR, help='Direction of the final gradient.')
class-attribute
instance-attribute
Gradient.Direction : Direction of the final gradient.
final_gradient_steps = ArgField(cmd_name=['--final-gradient-steps'], type_parser=argvalidators.PositiveInt.type_parser, nargs='+', default=12, metavar=argvalidators.PositiveInt.METAVAR, help='Space separated, unquoted, list of the 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('02b8bd'), Color('c1f0e3'), Color('00ffa0')), metavar=argvalidators.ColorArg.METAVAR, help='Space separated, unquoted, list of colors for the character gradient (applied across the canvas). If only one color is provided, the characters will be displayed in that color.')
class-attribute
instance-attribute
tuple[Color, ...] : Tuple of colors for the final color gradient. If only one color is provided, the characters will be displayed in that color.
print_head_easing = ArgField(cmd_name=['--print-head-easing'], default=easing.in_out_quad, type_parser=argvalidators.Ease.type_parser, help='Easing function to use for print head movement.')
class-attribute
instance-attribute
easing.EasingFunction : Easing function to use for print head movement.
print_head_return_speed = ArgField(cmd_name=['--print-head-return-speed'], type_parser=argvalidators.PositiveFloat.type_parser, default=1.25, metavar=argvalidators.PositiveFloat.METAVAR, help='Speed of the print head when performing a carriage return.')
class-attribute
instance-attribute
float : Speed of the print head when performing a carriage return.
print_speed = ArgField(cmd_name=['--print-speed'], type_parser=argvalidators.PositiveInt.type_parser, default=1, metavar=argvalidators.PositiveInt.METAVAR, help='Speed of the print head when printing characters.')
class-attribute
instance-attribute
int : Speed of the print head when printing characters.
PrintIterator
Bases: BaseEffectIterator[PrintConfig]
Effect iterator for the Print effect.
Source code in terminaltexteffects/effects/effect_print.py
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 152 153 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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
|
Row
Row of characters to print.
Source code in terminaltexteffects/effects/effect_print.py
__init__(characters, character_final_color_map, typing_head_color)
Initialize the row of characters to print.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
characters
|
list[EffectCharacter]
|
List of characters to print. |
required |
character_final_color_map
|
dict[EffectCharacter, Color]
|
Mapping of characters to their final colors. |
required |
typing_head_color
|
Color
|
Color of the typing head. |
required |
Source code in terminaltexteffects/effects/effect_print.py
move_up()
Move the row up one row.
Source code in terminaltexteffects/effects/effect_print.py
type_char()
Type the next character in the row.
__init__(effect)
Initialize the iterator with the Print effect.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
effect
|
Print
|
Print effect to apply to the input data. |
required |
Source code in terminaltexteffects/effects/effect_print.py
__next__()
Return the next frame in the animation.
Source code in terminaltexteffects/effects/effect_print.py
build()
Build the initial state of the effect.