rect_packer.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2013 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 "../api_core.h"
33 #include <memory>
34 #include "rect.h"
35 
36 namespace clan
37 {
40 
41 class Size;
42 class RectPacker_Impl;
43 
45 class CL_API_CORE RectPacker
46 {
49 public:
52  {
55  fail_if_full
56  };
57 
59  {
60  public:
61  AllocatedRect(int group_index, Rect rect) : group_index(group_index), rect(rect) {}
64  };
65 
69 public:
71  RectPacker();
72 
74  RectPacker(const Size &max_group_size, AllocationPolicy policy = create_new_group);
75 
76  ~RectPacker();
77 
81 public:
83  bool is_null() const { return !impl; }
84 
86  void throw_if_null() const;
87 
89  AllocationPolicy get_allocation_policy() const;
90 
92  Size get_max_group_size() const;
93 
95  int get_total_rect_count() const;
96 
98  int get_rect_count(unsigned int group_index = 0) const;
99 
101  int get_group_count() const;
102 
106 public:
108  void set_allocation_policy(AllocationPolicy policy);
109 
111  AllocatedRect add(const Size &size);
112 
116 private:
117  std::shared_ptr<RectPacker_Impl> impl;
119 };
120 
121 }
122 
Definition: rect_packer.h:54
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:453
AllocationPolicy
Allocation policy.
Definition: rect_packer.h:51
Definition: rect_packer.h:53
bool is_null() const
Returns true if this object is invalid.
Definition: rect_packer.h:83
Rect rect
Definition: rect_packer.h:63
Definition: rect_packer.h:58
AllocatedRect(int group_index, Rect rect)
Definition: rect_packer.h:61
2D (width,height) size structure - Integer
Definition: size.h:157
Generic rect packer class. Implements an algorithm to pack rects into groups efficiently.
Definition: rect_packer.h:45
int group_index
Definition: rect_packer.h:62