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
|
use super::BoxStyle;
use super::Draw;
use crate::display::draw_box::draw_box;
use crate::display::utils::clone_times;
use crate::types::{pos, BoundingBox, Position, Positioned};
use std::fmt::{self, Debug};
use std::io::{self, Write};
pub struct Viewport<W> {
/// The box describing the visible part of the viewport.
///
/// Generally the size of the terminal, and positioned at 0, 0
pub outer: BoundingBox,
/// The box describing the game part of the viewport.
pub game: BoundingBox,
/// The box describing the inner part of the viewport
///
/// Its position is relative to `outer.inner()`, and its size should
/// generally not be smaller than outer
pub inner: BoundingBox,
/// The actual screen that the viewport writes to
pub out: W,
/// Reset the cursor back to this position after every draw
pub cursor_position: Position,
}
impl<W> Viewport<W> {
pub fn new(outer: BoundingBox, inner: BoundingBox, out: W) -> Self {
Viewport {
outer,
inner,
out,
game: outer.move_tr_corner(Position { x: 0, y: 1 }),
cursor_position: pos(0, 0),
}
}
/// Returns true if the (inner-relative) position of the given entity is
/// visible within this viewport
pub fn visible<E: Positioned>(&self, ent: &E) -> bool {
self.on_screen(ent.position()).within(self.game.inner())
}
/// Convert the given inner-relative position to one on the actual screen
fn on_screen(&self, pos: Position) -> Position {
pos + self.inner.position + self.game.inner().position
}
}
impl<W> Debug for Viewport<W> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(
f,
"Viewport {{ outer: {:?}, inner: {:?}, out: <OUT> }}",
self.outer, self.inner
)
}
}
impl<W: Write> Viewport<W> {
/// Draw the given entity to the viewport at its position, if visible
pub fn draw<T: Draw>(&mut self, entity: &T) -> io::Result<()> {
if !self.visible(entity) {
return Ok(());
}
self.cursor_goto(entity.position())?;
entity.do_draw(self)?;
self.reset_cursor()
}
fn reset_cursor(&mut self) -> io::Result<()> {
self.cursor_goto(self.cursor_position)
}
/// Move the cursor to the given inner-relative position
pub fn cursor_goto(&mut self, pos: Position) -> io::Result<()> {
write!(self, "{}", self.on_screen(pos).cursor_goto())
}
/// Clear whatever single character is drawn at the given inner-relative
/// position, if visible
pub fn clear(&mut self, pos: Position) -> io::Result<()> {
write!(self, "{} ", self.on_screen(pos).cursor_goto(),)?;
self.reset_cursor()
}
/// Initialize this viewport by drawing its outer box to the screen
pub fn init(&mut self) -> io::Result<()> {
draw_box(self, self.game, BoxStyle::Thin)
}
/// Write a message to the message area on the screen
///
/// Will overwrite any message already present, and if the given message is
/// longer than the screen will truncate. This means callers should handle
/// message buffering and ellipsisization
pub fn write_message(&mut self, msg: &str) -> io::Result<()> {
write!(
self,
"{}{}{}",
self.outer.position.cursor_goto(),
if msg.len() <= self.outer.dimensions.w as usize {
msg
} else {
&msg[0..self.outer.dimensions.w as usize]
},
clone_times::<_, String>(
" ".to_string(),
self.outer.dimensions.w - msg.len() as u16
),
)?;
self.reset_cursor()
}
}
impl<W> Positioned for Viewport<W> {
fn position(&self) -> Position {
self.outer.position
}
}
impl<W: Write> Write for Viewport<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.out.write(buf)
}
fn flush(&mut self) -> io::Result<()> {
self.out.flush()
}
fn write_all(&mut self, buf: &[u8]) -> io::Result<()> {
self.out.write_all(buf)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::types::Dimensions;
// use proptest::prelude::*;
#[test]
fn test_visible() {
assert!(Viewport::new(
BoundingBox::at_origin(Dimensions { w: 10, h: 10 }),
BoundingBox {
position: Position { x: -10, y: -10 },
dimensions: Dimensions { w: 15, h: 15 },
},
()
)
.visible(&Position { x: 13, y: 13 }));
assert!(!Viewport::new(
BoundingBox::at_origin(Dimensions { w: 10, h: 10 }),
BoundingBox {
position: Position { x: -10, y: -10 },
dimensions: Dimensions { w: 15, h: 15 },
},
(),
)
.visible(&Position { x: 1, y: 1 }));
}
// proptest! {
// #[test]
// fn nothing_is_visible_in_viewport_off_screen(pos: Position, outer: BoundingBox) {
// let invisible_viewport = Viewport {
// outer,
// inner: BoundingBox {
// position: Position {x: -(outer.dimensions.w as i16), y: -(outer.dimensions.h as i16)},
// dimensions: outer.dimensions,
// },
// out: ()
// };
// assert!(!invisible_viewport.visible(&pos));
// }
// }
}
|
