texture_view.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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/root_view.h"
32 #include "../../Display/Window/display_window.h"
33 #include "../../Display/Window/keys.h"
34 
35 namespace clan
36 {
37  class InputEvent;
38  class TextureView_Impl;
39 
40  class TextureView : public RootView
41  {
42  public:
43  TextureView(Canvas &canvas);
44 
48  void set_viewport(const Rectf &rect);
49 
52 
53  void set_background_color(const Colorf &background_color = Colorf::transparent);
54  void set_clear_background(bool enable = true);
55 
56  void update();
57 
61  void set_cursor_window(const DisplayWindow &cursor_window);
62 
68  void set_event_window(const DisplayWindow &event_window, const Mat4f &transform_mouse_matrix = Mat4f::identity());
69 
72  void on_lost_focus();
73  void on_got_focus();
75  void on_key_up(const clan::InputEvent &);
80 
81  protected:
82  bool root_hidden() const override;
83  void set_root_hidden(bool value) override;
84  Canvas get_root_canvas() const override;
85  void set_root_needs_render() override;
86  void layout_local() override;
87  Pointf root_to_screen_pos(const Pointf &pos) override;
88  Pointf root_from_screen_pos(const Pointf &pos) override;
89 
90  private:
91  std::shared_ptr<TextureView_Impl> impl;
92 
93  friend class TextureView_Impl;
94  };
95 }
static Colorf transparent
rgba(0, 0, 0, 0).
Definition: color.h:1263
Input event class.
Definition: input_event.h:44
void on_key_down(const clan::InputEvent &)
void set_viewport(const Rectf &rect)
Set position and size within the canvas.
void layout_local() override
Layout local root.
2D (x,y) point structure - Float
Definition: point.h:73
2D (left,top,right,bottom) rectangle structure - Float
Definition: rect.h:485
Floating point color description class (for float).
Definition: color.h:661
void on_mouse_move(const clan::InputEvent &)
void on_mouse_down(const clan::InputEvent &)
void on_key_up(const clan::InputEvent &)
2D Graphics Canvas
Definition: canvas.h:73
Base class for views participating as a root view in the user interface.
Definition: root_view.h:38
Canvas get_root_canvas() const override
Pointf root_from_screen_pos(const Pointf &pos) override
Map from screen to local content coordinates.
static Mat4< Type > identity()
Create the identity matrix.
Definition: mat4.h:530
void set_root_needs_render() override
Signals this view needs to be rendered again.
4D matrix
Definition: mat2.h:51
void on_mouse_up(const clan::InputEvent &)
Definition: texture_view.h:41
Definition: clanapp.h:36
void on_mouse_dblclk(const clan::InputEvent &)
void set_background_color(const Colorf &background_color=Colorf::transparent)
bool root_hidden() const override
Test if view is set to hidden.
friend class TextureView_Impl
Definition: texture_view.h:93
void set_clear_background(bool enable=true)
void set_event_window(const DisplayWindow &event_window, const Mat4f &transform_mouse_matrix=Mat4f::identity())
Set the window to use to automatically handle window events.
TextureView(Canvas &canvas)
void set_cursor_window(const DisplayWindow &cursor_window)
Set the window to use to automatically set the cursor (including mouse capture)
Pointf root_to_screen_pos(const Pointf &pos) override
Map from local content to screen coordinates.
void on_window_close()
User defined events. Call these if set_event_window() is not used.
Top-level window class.
Definition: display_window.h:102
void set_root_hidden(bool value) override
Hides a view from layout and rendering.
Rectf get_viewport() const
Returns the position and size within the canvas.