rect_packer.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 ** Kenneth Gangstoe
27 */
28
29
30 #pragma once
31
32 #include <memory>
33 #include "rect.h"
34
35 namespace clan
36 {
39
40 class Size;
41 class RectPacker_Impl;
42
44 class RectPacker
45 {
48 public:
50 enum AllocationPolicy
51 {
52 create_new_group,
53 search_previous_groups,
54 fail_if_full
55 };
56
57 struct AllocatedRect
58 {
59 public:
60 AllocatedRect(int group_index, Rect rect) : group_index(group_index), rect(rect) {}
61 int group_index;
62 Rect rect;
63 };
64
68 public:
70 RectPacker();
71
73 RectPacker(const Size &max_group_size, AllocationPolicy policy = create_new_group);
74
75 ~RectPacker();
76
80 public:
82 bool is_null() const { return !impl; }
83
85 void throw_if_null() const;
86
88 AllocationPolicy get_allocation_policy() const;
89
91 Size get_max_group_size() const;
92
94 int get_total_rect_count() const;
95
97 int get_rect_count(unsigned int group_index = 0) const;
98
100 int get_group_count() const;
101
105 public:
107 void set_allocation_policy(AllocationPolicy policy);
108
110 AllocatedRect add(const Size &size);
111
115 private:
116 std::shared_ptr<RectPacker_Impl> impl;
118 };
119
120 }
121
clan
Definition: clanapp.h:35
clan::RectPacker::get_allocation_policy
AllocationPolicy get_allocation_policy() const
Returns the allocation policy.
clan::RectPacker::get_group_count
int get_group_count() const
Returns the amount of rects used by group.
clan::RectPacker::get_max_group_size
Size get_max_group_size() const
Returns the max group size.
clan::RectPacker::search_previous_groups
Definition: rect_packer.h:53
clan::RectPacker::throw_if_null
void throw_if_null() const
Throw an exception if this object is invalid.
clan::RectPacker::fail_if_full
Definition: rect_packer.h:54
clan::RectPacker::add
AllocatedRect add(const Size &size)
Allocate space for another rect.
clan::RectPacker::get_total_rect_count
int get_total_rect_count() const
Returns the total amount of rects.
clan::Rect
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:470
clan::RectPacker::AllocationPolicy
AllocationPolicy
Allocation policy.
Definition: rect_packer.h:50
clan::RectPacker::create_new_group
Definition: rect_packer.h:52
clan::RectPacker::is_null
bool is_null() const
Returns true if this object is invalid.
Definition: rect_packer.h:82
clan::RectPacker::get_rect_count
int get_rect_count(unsigned int group_index=0) const
Returns the amount of rects in a group.
clan::RectPacker::AllocatedRect::rect
Rect rect
Definition: rect_packer.h:62
clan::RectPacker::AllocatedRect
Definition: rect_packer.h:57
clan::RectPacker::AllocatedRect::AllocatedRect
AllocatedRect(int group_index, Rect rect)
Definition: rect_packer.h:60
clan::RectPacker::RectPacker
RectPacker()
Constructs a null instance.
clan::RectPacker::set_allocation_policy
void set_allocation_policy(AllocationPolicy policy)
Set the allocation policy.
clan::Size
2D (width,height) size structure - Integer
Definition: size.h:156
clan::RectPacker::~RectPacker
~RectPacker()
clan::RectPacker
Generic rect packer class. Implements an algorithm to pack rects into groups efficiently.
Definition: rect_packer.h:44
clan::RectPacker::AllocatedRect::group_index
int group_index
Definition: rect_packer.h:61