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 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
use std::cell::RefCell; use std::rc::Rc; use std::fmt::Debug; use turtle_window::TurtleWindow; use state::DrawingState; use {Point, Color, Event}; /// Represents a size /// /// A `Size` can be converted from either a tuple or array. These forms are often more ergonomic /// than using the `Size` struct on its own. The [`set_size()`](struct.Drawing.html#method.set_size) /// method accepts either form (without needing to use `into()`). See that method's documentation /// for more information. /// /// ```rust /// # use turtle::Size; /// assert_eq!(Size {width: 640, height: 480}, (640, 480).into()); /// assert_eq!(Size {width: 640, height: 480}, [640, 480].into()); /// ``` /// /// You can access the `width` and `height` fields directly on any `Size` struct. /// /// ```rust /// # use turtle::Size; /// let size: Size = (800, 600).into(); /// assert_eq!(size.width, 800); /// assert_eq!(size.height, 600); /// ``` #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub struct Size { /// The width in pixels pub width: u32, /// The height in pixels pub height: u32, } impl From<(u32, u32)> for Size { fn from(size: (u32, u32)) -> Self { Self { width: size.0, height: size.1, } } } impl From<[u32; 2]> for Size { fn from(size: [u32; 2]) -> Self { Self { width: size[0], height: size[1], } } } /// Represents the drawing that the turtle is creating /// /// This struct is usually accessed using the [`drawing()`](struct.Turtle.html#method.drawing) /// and [`drawing_mut()`](struct.Turtle.html#method.drawing_mut) methods on the /// [`Turtle` struct](struct.Turtle.html). pub struct Drawing { window: Rc<RefCell<TurtleWindow>>, } impl Drawing { pub(crate) fn with_window(window: Rc<RefCell<TurtleWindow>>) -> Self { Self { window, } } /// Returns the title of the drawing /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().set_title("Hello, world!"); /// assert_eq!(&*turtle.drawing().title(), "Hello, world!"); /// ``` pub fn title(&self) -> String { self.window.borrow().fetch_drawing().title } /// Sets the title of the drawing to the given text /// /// # Example /// /// ```rust,no_run /// extern crate turtle; /// use turtle::Turtle; /// /// fn main() { /// let mut turtle = Turtle::new(); /// turtle.drawing_mut().set_title("My Fancy Title! - Yay!"); /// } /// ``` /// /// This will produce the following: /// /// ![turtle set title](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/changed_title.png) pub fn set_title(&mut self, title: &str) { self.window.borrow_mut().with_drawing_mut(|drawing| drawing.title = title.to_owned()); } /// Returns the color of the background. /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().set_background_color("purple"); /// assert_eq!(turtle.drawing().background_color(), "purple".into()); /// ``` /// /// See the [`color` module](color/index.html) for more information about colors. pub fn background_color(&self) -> Color { self.window.borrow().fetch_drawing().background } /// Sets the color of the background to the given color. /// /// Any type that can be converted into a color can be passed into this function. /// See the [`color` module](color/index.html) for more information. /// /// # Example /// /// ```rust,no_run /// extern crate turtle; /// use turtle::Turtle; /// /// fn main() { /// let mut turtle = Turtle::new(); /// turtle.drawing_mut().set_background_color("orange"); /// } /// ``` /// /// This will produce the following: /// /// ![turtle background](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/orange_background.png) pub fn set_background_color<C: Into<Color> + Copy + Debug>(&mut self, color: C) { let bg_color = color.into(); assert!(bg_color.is_valid(), "Invalid color: {:?}. See the color module documentation for more information.", color); self.window.borrow_mut().with_drawing_mut(|drawing| drawing.background = bg_color); } /// Returns the center of the drawing /// /// ```rust /// # use turtle::*; /// let mut turtle = Turtle::new(); /// assert_eq!(turtle.drawing().center(), Point {x: 0.0, y: 0.0}); /// turtle.drawing_mut().set_center([4.0, 3.0]); /// assert_eq!(turtle.drawing().center(), Point {x: 4.0, y: 3.0}); /// ``` pub fn center(&self) -> Point { self.window.borrow().fetch_drawing().center } /// Sets the center of the drawing to the given point. See the [`Point` struct](struct.Point.html) /// documentation for more information. /// /// The center represents the offset from the center of the viewport at which to draw the /// drawing. The default center is (0, 0) which means that the drawing is centered at the /// middle of the viewport. /// /// Use this method to move the canvas that the turtle is drawing on. /// /// # Example /// /// ```rust,no_run /// extern crate turtle; /// /// use turtle::Turtle; /// /// fn main() { /// let mut turtle = Turtle::new(); /// /// for _ in 0..360 { /// // Move forward three steps /// turtle.forward(3.0); /// // Rotate to the right (clockwise) by 1 degree /// turtle.right(1.0); /// } /// /// turtle.wait_for_click(); /// turtle.drawing_mut().set_center([50.0, 100.0]); /// } /// ``` /// /// This will produce the following: /// /// ![turtle center middle](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/circle.png) /// /// Once you click on the window: /// /// ![turtle center offset](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/circle_offset_center.png) pub fn set_center<P: Into<Point>>(&mut self, center: P) { let center = center.into(); if !center.is_finite() { return; } self.window.borrow_mut().with_drawing_mut(|drawing| drawing.center = center); } /// Resets the center of the drawing back to its initial value /// /// ```rust /// # use turtle::*; /// let mut turtle = Turtle::new(); /// let default_center = turtle.drawing().center(); /// turtle.drawing_mut().set_center([400.0, -30.0]); /// assert_ne!(turtle.drawing().center(), default_center); /// turtle.drawing_mut().reset_center(); /// assert_eq!(turtle.drawing().center(), default_center); /// ``` pub fn reset_center(&mut self) { let default = DrawingState::default(); self.set_center(default.center); } /// Returns the size of the drawing /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// # assert_eq!(turtle.drawing().size(), Size {width: 800, height: 600}); /// // 1080p is 1920x1080 /// turtle.drawing_mut().set_size((1920, 1080)); /// let size = turtle.drawing().size(); /// assert_eq!(size.width, 1920); /// assert_eq!(size.height, 1080); /// ``` pub fn size(&self) -> Size { let drawing = self.window.borrow().fetch_drawing(); Size { width: drawing.width, height: drawing.height, } } /// Sets the size of the drawing to the given width and height. /// /// You can specify the size as any value that can be converted into a /// [`Size` struct](struct.Size.html). That means that any of the following would work: /// /// ```rust /// # use turtle::Turtle; /// # let mut turtle = Turtle::new(); /// // These are all equivalent to each other /// turtle.drawing_mut().set_size((640, 480)); /// # assert_eq!(turtle.drawing().size(), Size {width: 640, height: 480}); /// turtle.drawing_mut().set_size([640, 480]); /// # assert_eq!(turtle.drawing().size(), Size {width: 640, height: 480}); /// /// // It recommended that you use the options above instead of the following /// use turtle::Size; // Size must be imported /// turtle.drawing_mut().set_size(Size {width: 640, height: 480}); /// # assert_eq!(turtle.drawing().size(), Size {width: 640, height: 480}); /// ``` /// /// # Example /// /// ```rust,no_run /// extern crate turtle; /// /// use turtle::Turtle; /// /// fn main() { /// let mut turtle = Turtle::new(); /// /// for _ in 0..360 { /// // Move forward three steps /// turtle.forward(3.0); /// // Rotate to the right (clockwise) by 1 degree /// turtle.right(1.0); /// } /// /// turtle.wait_for_click(); /// turtle.drawing_mut().set_size((300, 300)); /// } /// ``` /// /// This will produce the following: /// /// ![turtle default size](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/circle.png) /// /// Once you click on the window: /// /// ![turtle small drawing](https://github.com/sunjay/turtle/raw/gh-pages/assets/images/docs/small_drawing.png) /// /// Notice that the center of the drawing stays the same. To control that, see /// [`set_center()`](struct.Drawing.html#method.set_center). pub fn set_size<S: Into<Size>>(&mut self, size: S) { let size = size.into(); self.window.borrow_mut().with_drawing_mut(|drawing| { drawing.width = size.width; drawing.height = size.height; }); } /// Resets the size of the drawing back to its initial value /// /// ```rust /// # use turtle::*; /// let mut turtle = Turtle::new(); /// let default_size = turtle.drawing().size(); /// /// turtle.drawing_mut().set_size([920, 680]); /// assert_ne!(turtle.drawing().size(), default_size); /// /// turtle.drawing_mut().reset_size(); /// assert_eq!(turtle.drawing().size(), default_size); /// ``` pub fn reset_size(&mut self) { let default = DrawingState::default(); self.set_size((default.width, default.height)); } /// Returns true if the drawing is currently maximized. /// /// Note: Even if you set the drawing to the width and height of the current display, it won't /// be maximized unless [`maximize()`](struct.Drawing.html#method.maximize) is called. /// /// ```rust /// # use turtle::*; /// let mut turtle = Turtle::new(); /// assert_eq!(turtle.drawing().is_maximized(), false); /// /// turtle.drawing_mut().maximize(); /// assert_eq!(turtle.drawing().is_maximized(), true); /// /// turtle.drawing_mut().unmaximize(); /// assert_eq!(turtle.drawing().is_maximized(), false); /// /// // Calling the same method again doesn't change the result /// turtle.drawing_mut().unmaximize(); /// assert_eq!(turtle.drawing().is_maximized(), false); /// ``` /// /// # Unstable /// /// **This method is currently unstable and unreliable.** /// ([GitHub Issue](https://github.com/sunjay/turtle/issues/49)) /// /// Unfortunately, we cannot currently detect when the window is maximized using the maximize /// button on the window. This method is reliable until that button is pressed. Since there is /// no way to tell when that is, treat the value returned from this method as unreliable and /// potentially inaccurate. pub fn is_maximized(&self) -> bool { self.window.borrow().fetch_drawing().maximized } /// Maximizes the size of the drawing so that it takes up the entire display. /// /// If the drawing is already maximized, this method does nothing. /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().maximize(); /// assert_eq!(turtle.drawing().is_maximized(), true); /// // Calling this method again does nothing /// turtle.drawing_mut().maximize(); /// assert_eq!(turtle.drawing().is_maximized(), true); /// ``` /// /// # Unstable /// /// **This method is currently unstable and unreliable.** /// ([GitHub Issue](https://github.com/sunjay/turtle/issues/49)) /// /// Unfortunately, we cannot currently detect when the window is maximized using the maximize /// button on the window. This method is reliable until that button is pressed. Since there is /// no way to tell when that is, treat the value returned from this method as unreliable and /// potentially inaccurate. /// /// It is usually okay to use this method right when the turtle is created, but don't rely on /// it after that because by then the user may have pressed the maximize button on the window. pub fn maximize(&mut self) { self.window.borrow_mut().with_drawing_mut(|drawing| drawing.maximized = true); } /// Returns the size of the drawing to its value before it was maximized /// /// If the drawing is already unmaximized, this method does nothing. /// /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().maximize(); /// assert_eq!(turtle.drawing().is_maximized(), true); /// turtle.drawing_mut().unmaximize(); /// assert_eq!(turtle.drawing().is_maximized(), false); /// // Calling this again does nothing because the drawing is already unmaximized /// turtle.drawing_mut().unmaximize(); /// assert_eq!(turtle.drawing().is_maximized(), false); /// ``` /// /// # Unstable /// /// **This method is currently unstable and unreliable.** /// ([GitHub Issue](https://github.com/sunjay/turtle/issues/49)) /// /// Unfortunately, we cannot currently detect when the window is maximized using the maximize /// button on the window. This method is reliable until that button is pressed. Since there is /// no way to tell when that is, treat the value returned from this method as unreliable and /// potentially inaccurate. pub fn unmaximize(&mut self) { self.window.borrow_mut().with_drawing_mut(|drawing| drawing.maximized = false); } /// Returns true if the drawing is currently full screen. /// /// ```rust /// # use turtle::*; /// let mut turtle = Turtle::new(); /// assert_eq!(turtle.drawing().is_fullscreen(), false); /// /// turtle.drawing_mut().enter_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), true); /// /// turtle.drawing_mut().exit_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), false); /// /// // Calling the same method again doesn't change the result /// turtle.drawing_mut().exit_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), false); /// ``` pub fn is_fullscreen(&self) -> bool { self.window.borrow().fetch_drawing().fullscreen } /// Makes the drawing take up the entire screen hiding everything else that would have been /// shown on screen otherwise. /// /// If the drawing is already fullscreen, this method does nothing. /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().enter_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), true); /// // Calling this method again does nothing /// turtle.drawing_mut().enter_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), true); /// ``` pub fn enter_fullscreen(&mut self) { self.window.borrow_mut().with_drawing_mut(|drawing| drawing.fullscreen = true); } /// Returns the size of the drawing to its value before it became fullscreen. /// /// If the drawing is already not fullscreen, this method does nothing. /// /// /// ```rust /// # use turtle::*; /// # let mut turtle = Turtle::new(); /// turtle.drawing_mut().enter_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), true); /// turtle.drawing_mut().exit_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), false); /// // Calling this again does nothing because the drawing is already not fullscreen /// turtle.drawing_mut().exit_fullscreen(); /// assert_eq!(turtle.drawing().is_fullscreen(), false); /// ``` pub fn exit_fullscreen(&mut self) { self.window.borrow_mut().with_drawing_mut(|drawing| drawing.fullscreen = false); } /// Returns the next event (if any). Returns `None` if there are no events to be processed at /// the current moment. This **does not** mean that there will never be events later on as the /// application continues to run. /// /// See the [`Event` enum](event/enum.Event.html) for the complete list of events that you can /// handle in your applications. /// /// # Example /// /// To use this advanced method, you need to create what is known as an "event loop". An "event /// loop" is any loop that handles the events generated by the application. The reason that it /// is important to create a loop like this is because events in Turtle are "polled". That /// means that every time an event happens, it is placed in a queue (a list) until you ask to /// look at it. If you do not check for events continuously, there is a chance that the events /// you ask for from `poll_event()` will be outdated. /// /// Even if you do not use every kind of event, you should aim to poll events using this method /// until there are none left to poll. If you do not poll events for a significant amount of /// time during your application, favor the events that come later as you poll since those will /// be the most recent. This can happen if you run many animations between loop iterations. /// /// See the [`examples/`](https://github.com/sunjay/turtle/raw/master/examples) directory in /// the source code of this library for more examples of how to use events. /// /// The following is an example of a basic event loop. Notice that it uses two loops. One to /// move the turtle continuously, and another to handle all the events available at a given /// moment. If it suits your purposes, you may also just use a single loop to handle events /// and move the turtle from within that loop. This example is of a more complex case where /// it really matters that the most recent information is taken into consideration before any /// further movements take place. /// /// ```rust,no_run /// extern crate turtle; /// /// use turtle::Turtle; /// use turtle::event::Key::{Left, Right}; /// use turtle::Event::KeyPressed; /// /// fn main() { /// let mut turtle = Turtle::new(); /// /// loop { /// turtle.forward(1.0); /// /// while let Some(event) = turtle.drawing_mut().poll_event() { /// match event { /// KeyPressed(key) => match key { /// Left => { /// turtle.set_speed(8); /// for _ in 0..20 { /// turtle.forward(1.0); /// turtle.left(4.5); /// } /// turtle.set_speed(4); /// }, /// Right => { /// turtle.set_speed(8); /// for _ in 0..20 { /// turtle.forward(1.0); /// turtle.right(4.5); /// } /// turtle.set_speed(4); /// }, /// _ => {}, /// }, /// _ => {}, /// } /// } /// } /// } /// ``` pub fn poll_event(&mut self) -> Option<Event> { self.window.borrow_mut().poll_event() } } #[cfg(test)] mod tests { use super::*; use turtle::*; #[test] #[should_panic(expected = "Invalid color: Color { red: NaN, green: 0.0, blue: 0.0, alpha: 0.0 }. See the color module documentation for more information.")] fn rejects_invalid_background_color() { let mut turtle = Turtle::new(); turtle.drawing_mut().set_background_color(Color {red: ::std::f64::NAN, green: 0.0, blue: 0.0, alpha: 0.0}); } }