texture_window.h Source File - ClanLib SDK
Description: texture_window.h Source File

texture_window.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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
35namespace clan
36{
37 class InputEvent;
38 class TextureWindow_Impl;
39
40 class TextureWindow : public ViewTree
41 {
42 public:
43 TextureWindow(Canvas &canvas);
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}
clan::Canvas
2D Graphics Canvas
Definition canvas.h:72
clan::Colorf
Floating point color description class (for float).
Definition color.h:799
clan::DisplayWindow
Top-level window class.
Definition display_window.h:101
clan::InputEvent
Input event class.
Definition input_event.h:43
clan::Mat4
4D matrix
Definition vec4.h:58
clan::Pointf
2D (x,y) point structure - Float
Definition point.h:72
clan::Rectf
2D (left,top,right,bottom) rectangle structure - Float
Definition rect.h:503
clan::StandardColorf::transparent
static Colorf transparent()
Definition color.h:1880
clan::TextureWindow
Definition texture_window.h:41
clan::TextureWindow::viewport
Rectf viewport() const
Returns the position and size within the canvas.
clan::TextureWindow::set_window
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.
clan::TextureWindow::on_window_close
void on_window_close()
User defined events. Call these if set_event_window() is not used.
clan::TextureWindow::set_background_color
void set_background_color(const Colorf &background_color=StandardColorf::transparent())
clan::TextureWindow::set_viewport
void set_viewport(const Rectf &rect)
Set position and size within the canvas.
clan::TextureWindow::set_always_render
void set_always_render(bool enable=true)
Always redraw the entire gui.
clan::TextureWindow::set_clear_background
void set_clear_background(bool enable=true)
clan::TextureWindow::on_got_focus
void on_got_focus()
clan::TextureWindow::on_key_up
void on_key_up(const clan::InputEvent &)
clan::TextureWindow::update
void update()
clan::TextureWindow::on_mouse_up
void on_mouse_up(const clan::InputEvent &)
clan::TextureWindow::on_mouse_dblclk
void on_mouse_dblclk(const clan::InputEvent &)
clan::TextureWindow::TextureWindow
TextureWindow(Canvas &canvas)
clan::TextureWindow::client_to_screen_pos
Pointf client_to_screen_pos(const Pointf &pos) override
Map from client to screen coordinates.
clan::TextureWindow::on_mouse_down
void on_mouse_down(const clan::InputEvent &)
clan::TextureWindow::on_key_down
void on_key_down(const clan::InputEvent &)
clan::TextureWindow::on_lost_focus
void on_lost_focus()
clan::TextureWindow::set_needs_render
void set_needs_render() override
Signals that the root view needs to be rendered again.
clan::TextureWindow::TextureWindow_Impl
friend class TextureWindow_Impl
Definition texture_window.h:93
clan::TextureWindow::canvas
Canvas canvas() const override
Gets the current canvas used to render.
clan::TextureWindow::on_mouse_move
void on_mouse_move(const clan::InputEvent &)
clan::TextureWindow::screen_to_client_pos
Pointf screen_to_client_pos(const Pointf &pos) override
Map from screen to client coordinates.
clan::TextureWindow::display_window
DisplayWindow display_window() override
clan::ViewTree
Base class for managing a tree of views.
Definition view_tree.h:42
clan::Mat4::identity
static Mat4< Type > identity()
Create the identity matrix.
Definition mat4.h:504
clan
Definition clanapp.h:36