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
//! Ui screen is a single screen that is visible at one time
//! Uses rctree for reference counted nodes
extern crate simd;

use rctree::NodeRef;
use node_data::{NodeData, FlexDirection};
use rect::Rect;

/// UI screen 
#[derive(Debug)]
pub struct UiScreen<T: Copy + Clone> {
    /// Root node of the UI tree
    pub root: NodeRef<Rect<T>>,
}

impl<T: Copy + Clone> UiScreen<T> {

    /// Creates a new UiScreen
    #[inline]
    pub fn new(initial_width: f32, initial_height: f32, data: NodeData<T>) 
    -> Self 
    {
        Self { root: NodeRef::new(Rect::new(0.0, initial_height, 0.0, initial_width, 0.0, data)) }
    }

    /// Changes the default orientation for the root element from row to column
    #[inline]
    pub fn with_root_as_column(self)
    -> Self
    {
        self.root.borrow_mut().data.flex_direction = FlexDirection::Column;
        self
    }

    /// Converts the UI into a vertex buffer
    pub fn into_rectangles(&mut self, root_width: f32, root_height: f32)
    -> Vec<Rect<T>>
    {
        self.root.borrow_mut().data.width = Some(root_width);
        self.root.borrow_mut().data.height = Some(root_height);

        let mut cur_offset_width = 0.0;
        let mut cur_offset_height = 0.0;
        let parent_width = self.root.borrow().data.width.unwrap().clone();
        let parent_height = self.root.borrow().data.height.unwrap().clone();

        let min_z_index = 0.0;
        let max_z_index = 1.0;
        let root_sibling_count = 0;
        let root_level_children = 1;

        ui_screen_to_dp_list::<T>(&self.root, min_z_index, max_z_index, 
                             root_level_children, root_sibling_count, 
                             parent_width, parent_height, 0.0, 0.0,
                             &mut cur_offset_width, &mut cur_offset_height)
    }
}

/// Recursively traverse and convert the node data into a list of rectangles
/// current: the current node
/// cur_z: The z-index, starts at 0 and increases. Is passed to OpenGL later
/// sibling_count: How many siblings does this node have? (for flex distributing)
/// sibling_count is 1 for root
/// **WARNING**: The root node have a width and a height (usually the case when
/// you create the UiScreen via `.new()`)
fn ui_screen_to_dp_list<T: Copy + Clone>(current: &NodeRef<Rect<T>>,  min_z: f32, max_z: f32,
                           sibling_count: u32, sibling_index: u32,
                           parent_width: f32, parent_height: f32,
                           parent_offset_left: f32, parent_offset_top: f32,
                           cur_offset_left: &mut f32, cur_offset_top: &mut f32)
-> Vec<Rect<T>>
{
    use std::clone::Clone;
    
    let mut rectangles = Vec::<Rect<T>>::new();

    let mut width = parent_width;
    let mut height = parent_height;

    if let Some(parent) = current.parent() {
        if parent.borrow().data.flex_direction == FlexDirection::Row {
            width /= (sibling_count - sibling_index) as f32;
        } else { 
            height /= (sibling_count - sibling_index) as f32;
        }
    }

    width -= *cur_offset_left;
    height -= *cur_offset_top;

    // correct width if there are hard constraints on max, min or exact width / height
    if let Some(w) = current.borrow().data.width { width = w; }
    if let Some(h) = current.borrow().data.height { height = h; }

    // if the width is greater than the maximal specified width, reduce
    if let Some(max_width) = current.borrow().data.max_width {
        if width > max_width {
            width = max_width;
        }
    }

    if let Some(max_height) = current.borrow().data.max_height {
        if height > max_height {
            height = max_height;
        }
    }

    // if the width is smaller than the minimal width, overflow the parent
    if let Some(min_width) = current.borrow().data.min_width {
        if width < min_width {    
            width = min_width;
        }
    }

    if let Some(min_height) = current.borrow().data.min_height {
        if height < min_height {   
            height = min_height;
        }
    }

    // calculate space top + left
    let offset_top = cur_offset_top.clone() + parent_offset_top;
    let offset_left = cur_offset_left.clone() + parent_offset_left;

    // calculate offset for top and left
    if let Some(parent) = current.parent() {
        if parent.borrow().data.flex_direction == FlexDirection::Row {
            *cur_offset_left += width;
        } else {
            *cur_offset_top += height;
        }     
    }

    // z sorting is done by recursively dividing the range between max_z and 
    // min_z into segments proportional to the siblings - this way the children won't overlap the parent
    let cur_z_stepping = (max_z - min_z) / (sibling_count as f32 + 1.0); 
    let z_index_current_node = cur_z_stepping * (sibling_index as f32 + 1.0);

    // construct rectangle and repeat for children
    // mark if min-width or max-width has modified the remaining width for siblings
    let cur_rect = Rect::new_wh(offset_left, offset_top, width as f32, height as f32, 
                                z_index_current_node, current.borrow().data.clone());

    // iterate children nodes
    let children_count = current.children().count();

    let self_width = width.clone();
    let self_height = height.clone();
    let new_max_z = z_index_current_node + cur_z_stepping;

    let new_offset_left = offset_left.clone();
    let new_offset_top = offset_top.clone();
    let mut offset_top_zeroed = 0.0;
    let mut offset_left_zeroed = 0.0;
    
    for (index, node) in current.children().enumerate() {
        rectangles.append(&mut ui_screen_to_dp_list::<T>(&node, z_index_current_node, new_max_z, 
                                                     children_count as u32, index as u32,
                                                     self_width, self_height,
                                                     new_offset_left, new_offset_top,
                                                     &mut offset_left_zeroed, &mut offset_top_zeroed)); 
    }

    rectangles.push(cur_rect);

    return rectangles;
}

// without rendering: 36 ns / iter
// with rendering (use "vblank_mode=0 cargo bench") to get correct results: ~1.9 ms
#[bench]
fn bench_ui_screen_layout_simple(b: &mut test::Bencher) {
    
    extern crate rand;

    use input;

    const INITIAL_WIDTH: u32 = 600;
    const INITIAL_HEIGHT: u32 = 800;
    let mut window_state = input::WindowState::new(INITIAL_WIDTH, INITIAL_HEIGHT);

    // Construct the explorer UI
    let mut ui_screen = UiScreen::new(INITIAL_WIDTH, INITIAL_HEIGHT)
                            .with_root_as_column();

    // Top bar, 100 - 200 pixels tall, stretches full window
    let top_bar_wrapper = NodeRef::new(NodeData::new(
            None, None, None, None, None, None, 
            FlexDirection::Column, DebugColor::green()));

    // Main explorer view, stretches all sides
    let explorer_wrapper = NodeRef::new(NodeData::new(
        None, None, None, None, None, None, 
        FlexDirection::Row, DebugColor::blue()));

            // navigation side bar
            let navigation_pane = NodeRef::new(NodeData::new(
                Some(500.0), None, Some(700.0), None, None, None, 
                FlexDirection::Column, DebugColor::red()));

            // file list
            let file_list_view = NodeRef::new(NodeData::new(
                None, None, None, None, Some(50.0), None, 
                FlexDirection::Column, DebugColor::blue()));

    // drawing order
    explorer_wrapper.append(navigation_pane);
    explorer_wrapper.append(file_list_view);
    ui_screen.root.append(top_bar_wrapper);
    ui_screen.root.append(explorer_wrapper);

    b.iter(|| {
            let event = glium::glutin::Event::Resized(rand::random::<u32>(), rand::random::<u32>());
            input::handle_event(&event, &mut window_state, &mut ui_screen);
            let _ = ui_screen.into_rectangles();
        }
    )
}