1 2 3 4 5 6 7 8 9 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 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 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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
//! # Drawing
//!
//! The `drawing` module provides functionality for drawing shapes and text with multiple styles
//! to the terminal screen.
use super::spatial::Vec2;
use super::terminal::{Canvas, Color, Style};
use num::cast::ToPrimitive;
/// The set of all characters needed to draw all edges and corners of a variable-length rectangle
/// in the terminal.
#[derive(Debug, Clone)]
pub struct RectCharset {
pub top: char,
pub bottom: char,
pub left: char,
pub right: char,
pub top_left: char,
pub top_right: char,
pub bottom_left: char,
pub bottom_right: char,
}
impl RectCharset {
/// Returns a [`RectCharset`] for a single-line rectangle.
///
/// # Rectangle
///
/// Using this charset will provide a rectangle that looks like this:
///
/// ```text
/// ┌──────┐
/// │ruscii│
/// └──────┘
/// ```
pub fn simple_lines() -> RectCharset {
RectCharset::from("──││┌┐└┘")
}
/// Returns a [`RectCharset`] for a single-line rounded-corner rectangle.
///
/// # Rectangle
///
/// Using this charset will provide a rectangle that looks like this:
///
/// ```text
/// ╭──────╮
/// │ruscii│
/// ╰──────╯
/// ```
pub fn simple_round_lines() -> RectCharset {
RectCharset::from("──││╭╮╰╯")
}
/// Returns a [`RectCharset`] for a double-line rectangle.
///
/// # Rectangle
///
/// Using this charset will provide a rectangle that looks like this:
///
/// ```text
/// ╔══════╗
/// ║ruscii║
/// ╚══════╝
/// ```
pub fn double_lines() -> RectCharset {
RectCharset::from("══║║╔╗╚╝")
}
}
impl From<&str> for RectCharset {
/// A utility function that generates a [`RectCharset`] from the characters in a `&str`.
///
/// # Panics
///
/// This function will `panic!` if the given `item` is a `&str` of fewer than 8 characters.
fn from(item: &str) -> Self {
if item.len() < 8 {
panic!("Build a RectCharset requires at least 8 characters.");
}
let mut chars = item.chars();
RectCharset {
top: chars.next().unwrap(),
bottom: chars.next().unwrap(),
left: chars.next().unwrap(),
right: chars.next().unwrap(),
top_left: chars.next().unwrap(),
top_right: chars.next().unwrap(),
bottom_left: chars.next().unwrap(),
bottom_right: chars.next().unwrap(),
}
}
}
/// An object that stores several text style options and the [`Canvas`] to which text and shapes can
/// be written.
///
/// # Options
///
/// - Origin - A [`Vec2`] on the [`Canvas`] which becomes the new "origin" for drawn characters. All
/// [`Vec2`]s subsequently passed to associated functions are relative to this [`Vec2`]. For example,
/// if the origin is set to (2, 3) and [`Pencil::draw_text`] is called with position
/// (1, 0), the string will be drawn at (3, 3).
/// - Foreground (character) [`Color`]
/// - Background [`Color`]
/// - [`Style`] (boldness)
///
/// # Examples
///
/// An introductory example using a [`Pencil`] could be:
///
/// ```rust,no_run
/// # use ruscii::app::{App, State};
/// # use ruscii::terminal::{Window};
/// # use ruscii::drawing::{Pencil};
/// # use ruscii::spatial::{Vec2};
/// #
/// # fn main() {
/// # let mut app = App::default();
/// #
/// # app.run(|app_state: &mut State, window: &mut Window| {
/// let mut pencil = Pencil::new(window.canvas_mut());
/// pencil.draw_text("Hello, world!", Vec2::xy(0, 0));
/// # });
/// # }
/// ```
///
/// Most associated functions return a mutable reference to the function's receiver (`self`),
/// allowing for chaining multiple calls as in the following example.
///
/// From `pong.rs` in the [examples](https://github.com/lemunozm/ruscii/tree/master/examples)
/// folder:
///
/// ```rust,ignore
/// Pencil::new(window.canvas_mut())
/// .draw_text(&format!("FPS: {}", fps_counter.count()), Vec2::xy(0, 0))
/// .set_origin(Vec2::xy((win_size.x - score_msg.len() as i32) / 2, (win_size.y - state.dimension.y) / 2 - 1))
/// .draw_text(score_msg, Vec2::xy(0, 0))
/// .set_origin((win_size - state.dimension) / 2)
/// .draw_rect(&RectCharset::simple_round_lines(), Vec2::zero(), state.dimension)
/// .draw_vline('\'', Vec2::xy(state.dimension.x / 2, 1), state.dimension.y - 2)
/// .set_foreground(Color::Blue)
/// .draw_rect(&RectCharset::double_lines(), state.left_player.position - Vec2::y(PAD_HEIGHT), Vec2::xy(2, PAD_HEIGHT * 2))
/// .set_foreground(Color::Red)
/// .draw_rect(&RectCharset::double_lines(), state.right_player.position - Vec2::y(PAD_HEIGHT), Vec2::xy(2, PAD_HEIGHT * 2))
/// .set_foreground(Color::Yellow)
/// .set_style(Style::Bold)
/// .draw_char('o', state.ball_position);
///```
pub struct Pencil<'a> {
origin: Vec2,
foreground: Color,
background: Color,
style: Style,
canvas: &'a mut Canvas,
}
impl<'a> Pencil<'a> {
/// Constructs a [`Pencil`] that can write to the given [`Canvas`].
pub fn new(canvas: &'a mut Canvas) -> Pencil {
Pencil {
origin: Vec2::zero(),
foreground: canvas.default_element().foreground,
background: canvas.default_element().background,
style: canvas.default_element().style,
canvas,
}
}
/// Sets a [`VisualElement`] cell of the [`Canvas`].
fn draw_element(&mut self, position: Vec2, value: char) {
if let Some(element) = self.canvas.elem_mut(position) {
element.value = value;
element.foreground = self.foreground;
element.background = self.background;
element.style = self.style;
}
}
pub fn origin(&self) -> Vec2 {
self.origin
}
/// Returns the dimensions of the positive drawable space past the current origin.
///
/// ## Example
///
/// ```rust
/// # use ruscii::drawing::Pencil;
/// # use ruscii::spatial::Vec2;
/// # use ruscii::terminal::{Canvas, VisualElement};
/// #
/// let mut canvas = Canvas::new(Vec2::xy(10, 5), &VisualElement::default());
/// let mut pencil = Pencil::new(&mut canvas);
/// pencil.set_origin(Vec2::xy(5, 0));
/// assert_eq!(pencil.dimension(), Vec2::xy(5, 5))
/// ```
pub fn dimension(&self) -> Vec2 {
self.canvas.dimension() - self.origin
}
pub fn foreground(&self) -> &Color {
&self.foreground
}
pub fn background(&self) -> &Color {
&self.background
}
pub fn style(&self) -> &Style {
&self.style
}
pub fn set_origin(&mut self, position: Vec2) -> &mut Pencil<'a> {
self.origin = position;
self
}
/// Moves the origin by the given `displacement`.
pub fn move_origin(&mut self, displacement: Vec2) -> &mut Pencil<'a> {
self.origin += displacement;
self
}
pub fn set_foreground(&mut self, color: Color) -> &mut Pencil<'a> {
self.foreground = color;
self
}
pub fn set_background(&mut self, color: Color) -> &mut Pencil<'a> {
self.background = color;
self
}
pub fn set_style(&mut self, style: Style) -> &mut Pencil<'a> {
self.style = style;
self
}
/// Draws a character at the given `position` according to the previously set text style options.
///
/// Returns the receiver for chaining.
pub fn draw_char(&mut self, value: char, position: Vec2) -> &mut Pencil<'a> {
self.draw_element(self.origin + position, value);
self
}
/// Draws a string at the given `position` according to the previously set text style options.
///
/// If the string has multiple characters, each subsequent character is drawn one point to the
/// right (as you'd probably expect).
///
/// Returns the receiver for chaining.
pub fn draw_text(&mut self, text: &str, position: Vec2) -> &mut Pencil<'a> {
let width = self.canvas.dimension().x;
for (i, value) in text.chars().enumerate() {
let elem_pos = self.origin + position + Vec2::x(i);
let elem_pos = Vec2::xy(elem_pos.x % width, elem_pos.y + elem_pos.x / width);
self.draw_element(elem_pos, value);
}
self
}
/// Draws a string centered at the given `position` according to the previously set text style
/// options.
///
/// Returns the receiver for chaining.
pub fn draw_center_text(&mut self, text: &str, position: Vec2) -> &mut Pencil<'a> {
let position = position - Vec2::x(text.len() as i32 / 2);
self.draw_text(text, position)
}
/// Draws a right-aligned string ending at the given `position`.
///
/// Returns the receiver for chaining.
pub fn draw_right_aligned_text(&mut self, text: &str, position: Vec2) -> &mut Pencil<'a> {
let position = position - Vec2::x(text.len() as i32);
self.draw_text(text, position)
}
/// Draws a vertical line starting from the given `position` and extending for `size`
/// lines downwards. This line is composed of the given `value` characters.
///
/// Returns the receiver for chaining.
pub fn draw_vline<T: ToPrimitive>(
&mut self,
value: char,
position: Vec2,
size: T,
) -> &mut Pencil<'a> {
let elem_pos = self.origin + position;
for i in 0..size.to_usize().unwrap() {
self.draw_element(elem_pos + Vec2::y(i), value);
}
self
}
/// Draws a horizontal line starting from the given `position` and extending for `size`
/// lines rightwards. This line is composed of the given `value` characters.
///
/// Returns the receiver for chaining.
pub fn draw_hline<T: ToPrimitive>(
&mut self,
value: char,
position: Vec2,
size: T,
) -> &mut Pencil<'a> {
let elem_pos = self.origin + position;
for i in 0..size.to_usize().unwrap() {
self.draw_element(elem_pos + Vec2::x(i), value);
}
self
}
/// Draws an empty rectangle from the given `charset` with the given `dimension`. The given
/// `position` sets the position of the top-left corner of the rectangle.
///
/// The given `dimension` includes the characters used to draw the rectangle, so the dimension
/// of the enclosed space has a width of `dimension.x - 2` and a height of `dimension.y - 2`.
///
/// Returns the receiver for chaining.
pub fn draw_rect(
&mut self,
charset: &RectCharset,
position: Vec2,
dimension: Vec2,
) -> &mut Pencil<'a> {
self.move_origin(position)
.draw_hline(charset.top, Vec2::x(0), dimension.x - 1)
.draw_hline(
charset.bottom,
Vec2::xy(0, dimension.y - 1),
dimension.x - 1,
)
.draw_vline(charset.left, Vec2::y(0), dimension.y - 1)
.draw_vline(charset.right, Vec2::xy(dimension.x - 1, 0), dimension.y - 1)
.draw_char(charset.top_left, Vec2::xy(0, 0))
.draw_char(charset.top_right, Vec2::x(dimension.x - 1))
.draw_char(charset.bottom_left, Vec2::y(dimension.y - 1))
.draw_char(charset.bottom_right, dimension - Vec2::xy(1, 1))
.move_origin(-position)
}
/// Draws a filled rectangle from the given `charset` with the given `dimension`. The given
/// `position` sets the position of the top-left corner of the rectangle. The rectangle is
/// composed of the given `fill` characters.
///
/// Returns the receiver for chaining.
pub fn draw_filled_rect(
&mut self,
fill: char,
position: Vec2,
dimension: Vec2,
) -> &mut Pencil<'a> {
self.move_origin(position);
for i in 0..dimension.x {
self.draw_vline(fill, Vec2::xy(position.x + i, position.y), dimension.y);
}
self.move_origin(-position)
}
/// Draws one of the frames of the given `animator` based on the number of times this has
/// been previously called.
pub fn draw_animator(&mut self, animator: &mut Animator, position: Vec2) {
self.draw_text(&animator.access_frame(), position);
}
}
/// An object that runs an animation.
///
/// ## Example
///
/// An [`Animator`] must be supplied with a [`Vec`] of [`AnimationFrame`]s and then drawn by a
/// [`Pencil`] like so:
///
/// ```rust
/// # use ruscii::drawing::{AnimationFrame, Animator, Pencil};
/// # use ruscii::spatial::Vec2;
/// # use ruscii::terminal::{Canvas, VisualElement};
/// # let mut canvas = Canvas::new(Vec2::xy(3, 1), &VisualElement::default());
/// # let mut pencil = Pencil::new(&mut canvas);
/// let animation = vec![
/// AnimationFrame::new("X ", 1),
/// AnimationFrame::new(" X ", 1),
/// AnimationFrame::new(" X", 1),
/// AnimationFrame::new(" X ", 1),
/// ];
/// let mut animator = Animator::new(animation);
///
/// pencil.draw_animator(&mut animator, Vec2::zero());
/// ```
pub struct Animator {
animation: Vec<AnimationFrame>,
frame_index: usize,
counter: u32,
speed: u32,
}
impl Animator {
/// Creates a new [`Animator`] with the given `animation`.
pub fn new(animation: Vec<AnimationFrame>) -> Animator {
Animator {
animation,
frame_index: 0,
counter: 0,
speed: 1,
}
}
/// Sets the speed of animation.
pub fn set_speed(&mut self, speed: u32) {
self.speed = speed
}
/// Gets the text of the current frame and updates the frame counter, changing the current
/// frame if the duration is exceeded.
fn access_frame(&mut self) -> String {
let current_frame = &self.animation[self.frame_index];
self.counter += 1;
if self.counter >= current_frame.duration / self.speed {
self.counter = 0;
self.frame_index = (self.frame_index + 1) % self.animation.len();
}
current_frame.text.clone()
}
}
/// A single frame of an animation.
#[derive(Clone, Debug, PartialEq)]
pub struct AnimationFrame {
pub(crate) text: String,
duration: u32,
}
impl AnimationFrame {
/// Creates an [`AnimationFrame`] from the given `text` that lasts for the given `duration`.
pub fn new(text: impl Into<String>, duration: u32) -> AnimationFrame {
AnimationFrame {
text: text.into(),
duration,
}
}
}