1/**************************************************************************/
2/* aspect_ratio_container.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef ASPECT_RATIO_CONTAINER_H
32#define ASPECT_RATIO_CONTAINER_H
33
34#include "scene/gui/container.h"
35
36class AspectRatioContainer : public Container {
37 GDCLASS(AspectRatioContainer, Container);
38
39protected:
40 void _notification(int p_what);
41 static void _bind_methods();
42 virtual Size2 get_minimum_size() const override;
43
44public:
45 enum StretchMode {
46 STRETCH_WIDTH_CONTROLS_HEIGHT,
47 STRETCH_HEIGHT_CONTROLS_WIDTH,
48 STRETCH_FIT,
49 STRETCH_COVER,
50 };
51 enum AlignmentMode {
52 ALIGNMENT_BEGIN,
53 ALIGNMENT_CENTER,
54 ALIGNMENT_END,
55 };
56
57private:
58 float ratio = 1.0;
59 StretchMode stretch_mode = STRETCH_FIT;
60 AlignmentMode alignment_horizontal = ALIGNMENT_CENTER;
61 AlignmentMode alignment_vertical = ALIGNMENT_CENTER;
62
63public:
64 void set_ratio(float p_ratio);
65 float get_ratio() const { return ratio; }
66
67 void set_stretch_mode(StretchMode p_mode);
68 StretchMode get_stretch_mode() const { return stretch_mode; }
69
70 void set_alignment_horizontal(AlignmentMode p_alignment_horizontal);
71 AlignmentMode get_alignment_horizontal() const { return alignment_horizontal; }
72
73 void set_alignment_vertical(AlignmentMode p_alignment_vertical);
74 AlignmentMode get_alignment_vertical() const { return alignment_vertical; }
75
76 virtual Vector<int> get_allowed_size_flags_horizontal() const override;
77 virtual Vector<int> get_allowed_size_flags_vertical() const override;
78};
79
80VARIANT_ENUM_CAST(AspectRatioContainer::StretchMode);
81VARIANT_ENUM_CAST(AspectRatioContainer::AlignmentMode);
82
83#endif // ASPECT_RATIO_CONTAINER_H
84