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
//! Rendering is RLBot's ability to draw directly inside the game window.

use crate::{flat, rlbot::RLBot};
use flatbuffers::{FlatBufferBuilder, WIPOffset};
use std::error::Error;

/// A render group in the process of being built.
///
/// The drawing methods in this class simply collect a list of items to be
/// drawn later. Nothing will actually be drawn to screen until
/// [`render`](RenderGroup::render) is called.
///
/// # Examples
///
/// ## Basic rendering
///
/// ```no_run
/// # use rlbot::flat::ColorArgs;
/// # use std::error::Error;
/// #
/// # fn main() -> Result<(), Box<Error>> {
/// let rlbot = rlbot::init()?;
/// let mut group = rlbot.begin_render_group(1234);
/// let green = group.color_rgb(0, 255, 0);
/// group.draw_string_2d((10.0, 10.0), (2, 2), "I am text!", green);
/// group.render()?;
/// # Ok(())
/// # }
/// ```
///
/// ## Clearing the screen
///
/// ```no_run
/// # use std::error::Error;
/// #
/// # fn main() -> Result<(), Box<Error>> {
/// let rlbot = rlbot::init()?;
/// let group = rlbot.begin_render_group(1234);
/// group.render()?;
/// # Ok(())
/// # }
/// ```
pub struct RenderGroup<'a> {
    rlbot: &'a RLBot,
    id: i32,
    builder: FlatBufferBuilder<'a>,
    messages: Vec<WIPOffset<flat::RenderMessage<'a>>>,
}

impl<'a> RenderGroup<'a> {
    pub(crate) fn new(rlbot: &'a RLBot, id: i32) -> Self {
        Self {
            rlbot,
            id,
            builder: FlatBufferBuilder::new_with_capacity(1024),
            messages: Vec::new(),
        }
    }
}

/// A color that can be used to draw in a [`RenderGroup`].
#[derive(Copy, Clone)]
pub struct Color<'a>(WIPOffset<flat::Color<'a>>);

impl<'a> RenderGroup<'a> {
    /// Send the collected drawings to RLBot to be rendered to screen.
    pub fn render(mut self) -> Result<(), Box<dyn Error>> {
        let messages = self.builder.create_vector(&self.messages);

        let render_group = {
            let mut rg = flat::RenderGroupBuilder::new(&mut self.builder);
            rg.add_renderMessages(messages);
            rg.add_id(self.id);
            rg.finish()
        };

        self.builder.finish(render_group, None);
        let data = self.builder.finished_data();
        self.rlbot.interface().render_group(data)?;
        Ok(())
    }

    /// Create a color with the given **a**lpha, **r**ed, **g**reen, and
    /// **b**lue. An alpha of 255 is fully opaque, and 0 is fully transparent.
    ///
    /// A color can only be used with the `RenderGroup` that created it.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// let transbluecent = group.color_argb(127, 0, 0, 255);
    /// ```
    pub fn color_argb(&mut self, a: u8, r: u8, g: u8, b: u8) -> Color<'a> {
        let args = flat::ColorArgs { a, r, g, b };
        Color(flat::Color::create(&mut self.builder, &args))
    }

    /// Create an opaque color with the given, **r**ed, **g**reen, and **b**lue.
    ///
    /// A color can only be used with the `RenderGroup` that created it.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// let green = group.color_rgb(0, 255, 0);
    /// ```
    pub fn color_rgb(&mut self, r: u8, g: u8, b: u8) -> Color<'a> {
        let args = flat::ColorArgs { a: 255, r, g, b };
        Color(flat::Color::create(&mut self.builder, &args))
    }

    /// Draw a line using screen coordinates.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// # let green = group.color_rgb(0, 255, 0);
    /// group.draw_line_2d((10.0, 10.0), (100.0, 100.0), green);
    /// ```
    pub fn draw_line_2d(
        &mut self,
        (x1, y1): (f32, f32),
        (x2, y2): (f32, f32),
        Color(color): Color<'_>,
    ) {
        let start = flat::Vector3::new(x1, y1, 0.0);
        let end = flat::Vector3::new(x2, y2, 0.0);

        let mut rm = flat::RenderMessageBuilder::new(&mut self.builder);
        rm.add_renderType(flat::RenderType::DrawLine2D);
        rm.add_color(color);
        rm.add_start(&start);
        rm.add_end(&end);
        self.messages.push(rm.finish());
    }

    /// Draw a line using world coordinates.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// # let green = group.color_rgb(0, 255, 0);
    /// group.draw_line_3d((10.0, 10.0, 10.0), (100.0, 100.0, 100.0), green);
    /// ```
    pub fn draw_line_3d(
        &mut self,
        (x1, y1, z1): (f32, f32, f32),
        (x2, y2, z2): (f32, f32, f32),
        Color(color): Color<'_>,
    ) {
        let start = flat::Vector3::new(x1, y1, z1);
        let end = flat::Vector3::new(x2, y2, z2);

        let mut rm = flat::RenderMessageBuilder::new(&mut self.builder);
        rm.add_renderType(flat::RenderType::DrawLine3D);
        rm.add_color(color);
        rm.add_start(&start);
        rm.add_end(&end);
        self.messages.push(rm.finish());
    }

    /// Draw a line with one endpoint in screen coordinates and the other at a
    /// point projected from world coordinates to screen coordinates.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// # let green = group.color_rgb(0, 255, 0);
    /// group.draw_line_2d_3d((10.0, 10.0), (100.0, 100.0, 100.0), green);
    /// ```
    pub fn draw_line_2d_3d(
        &mut self,
        (x1, y1): (f32, f32),
        (x2, y2, z2): (f32, f32, f32),
        Color(color): Color<'_>,
    ) {
        let start = flat::Vector3::new(x1, y1, 0.0);
        let end = flat::Vector3::new(x2, y2, z2);

        let mut rm = flat::RenderMessageBuilder::new(&mut self.builder);
        rm.add_renderType(flat::RenderType::DrawLine2D_3D);
        rm.add_color(color);
        rm.add_start(&start);
        rm.add_end(&end);
        self.messages.push(rm.finish());
    }

    /// Draw text using screen coordinates.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// # let green = group.color_rgb(0, 255, 0);
    /// group.draw_string_2d((10.0, 10.0), (2, 2), "I am text!", green);
    /// ```
    pub fn draw_string_2d(
        &mut self,
        (x, y): (f32, f32),
        (scale_x, scale_y): (i32, i32),
        text: impl AsRef<str>,
        Color(color): Color<'_>,
    ) {
        let start = flat::Vector3::new(x, y, 0.0);
        let text = self.builder.create_string(text.as_ref());

        let mut rm = flat::RenderMessageBuilder::new(&mut self.builder);
        rm.add_renderType(flat::RenderType::DrawString2D);
        rm.add_color(color);
        rm.add_start(&start);
        rm.add_scaleX(scale_x);
        rm.add_scaleY(scale_y);
        rm.add_text(text);
        self.messages.push(rm.finish());
    }

    /// Draw text at a point projected from world coordinates to screen
    /// coordinates.
    ///
    /// # Example
    ///
    /// ```no_run
    /// # use rlbot::RenderGroup;
    /// # let mut group: RenderGroup = unsafe { ::std::mem::uninitialized() };
    /// # let green = group.color_rgb(0, 255, 0);
    /// group.draw_string_3d((10.0, 10.0, 10.0), (2, 2), "I am text!", green);
    /// ```
    pub fn draw_string_3d(
        &mut self,
        (x, y, z): (f32, f32, f32),
        (scale_x, scale_y): (i32, i32),
        text: impl AsRef<str>,
        Color(color): Color<'_>,
    ) {
        let start = flat::Vector3::new(x, y, z);
        let text = self.builder.create_string(text.as_ref());

        let mut rm = flat::RenderMessageBuilder::new(&mut self.builder);
        rm.add_renderType(flat::RenderType::DrawString2D);
        rm.add_color(color);
        rm.add_start(&start);
        rm.add_scaleX(scale_x);
        rm.add_scaleY(scale_y);
        rm.add_text(text);
        self.messages.push(rm.finish());
    }
}