texture_window.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 #pragma once
30 
31 #include "view_tree.h"
32 #include "../../Display/Window/display_window.h"
33 #include "../../Display/Window/keys.h"
34 
35 namespace clan
36 {
37  class InputEvent;
38  class TextureWindow_Impl;
39 
40  class TextureWindow : public ViewTree
41  {
42  public:
44 
48  void set_viewport(const Rectf &rect);
49 
51  Rectf viewport() const;
52 
53  void set_background_color(const Colorf &background_color = StandardColorf::transparent());
54  void set_clear_background(bool enable = true);
55 
57  void set_always_render(bool enable = true);
58 
59  void update();
60 
68  void set_window(const DisplayWindow &window, bool enable_automatic_events = true, const Mat4f &transform_mouse_matrix = Mat4f::identity());
69 
71  void on_window_close();
72  void on_lost_focus();
73  void on_got_focus();
74  void on_key_down(const clan::InputEvent &);
75  void on_key_up(const clan::InputEvent &);
76  void on_mouse_down(const clan::InputEvent &);
77  void on_mouse_dblclk(const clan::InputEvent &);
78  void on_mouse_up(const clan::InputEvent &);
79  void on_mouse_move(const clan::InputEvent &);
80 
81  DisplayWindow display_window() override;
82  Canvas canvas() const override;
83 
84  protected:
85  void set_needs_render() override;
86 
87  Pointf client_to_screen_pos(const Pointf &pos) override;
88  Pointf screen_to_client_pos(const Pointf &pos) override;
89 
90  private:
91  std::shared_ptr<TextureWindow_Impl> impl;
92 
93  friend class TextureWindow_Impl;
94  };
95 }
Definition: clanapp.h:35
friend class TextureWindow_Impl
Definition: texture_window.h:93
Floating point color description class (for float).
Definition: color.h:798
void set_always_render(bool enable=true)
Always redraw the entire gui.
2D Graphics Canvas
Definition: canvas.h:71
void on_mouse_down(const clan::InputEvent &)
void on_window_close()
User defined events. Call these if set_event_window() is not used.
void set_clear_background(bool enable=true)
static Colorf transparent()
Definition: color.h:1880
static Mat4< Type > identity()
Create the identity matrix.
Definition: mat4.h:504
void on_key_up(const clan::InputEvent &)
Pointf screen_to_client_pos(const Pointf &pos) override
Map from screen to client coordinates.
Rectf viewport() const
Returns the position and size within the canvas.
4D matrix
Definition: mat2.h:50
DisplayWindow display_window() override
2D (left,top,right,bottom) rectangle structure - Float
Definition: rect.h:502
void set_background_color(const Colorf &background_color=StandardColorf::transparent())
void set_window(const DisplayWindow &window, bool enable_automatic_events=true, const Mat4f &transform_mouse_matrix=Mat4f::identity())
Set the window that will contain this canvas.
void set_needs_render() override
Signals that the root view needs to be rendered again.
Pointf client_to_screen_pos(const Pointf &pos) override
Map from client to screen coordinates.
void on_mouse_up(const clan::InputEvent &)
Definition: texture_window.h:40
Canvas canvas() const override
Gets the current canvas used to render.
void set_viewport(const Rectf &rect)
Set position and size within the canvas.
Base class for managing a tree of views.
Definition: view_tree.h:41
void on_mouse_dblclk(const clan::InputEvent &)
void on_mouse_move(const clan::InputEvent &)
2D (x,y) point structure - Float
Definition: point.h:71
Input event class.
Definition: input_event.h:42
void on_key_down(const clan::InputEvent &)
Top-level window class.
Definition: display_window.h:100
TextureWindow(Canvas &canvas)