ClanLib  2.3.7
rect_packer.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
31 
32 #pragma once
33 
34 #include "../api_core.h"
35 #include "../System/sharedptr.h"
36 #include "rect.h"
37 
38 class CL_Size;
39 class CL_RectPacker_Impl;
40 
45 {
48 public:
51  {
54  fail_if_full
55  };
56 
58  {
59  public:
60  AllocatedRect(int group_index, CL_Rect rect) : group_index(group_index), rect(rect) {}
63  };
64 
68 public:
70  CL_RectPacker();
71 
73  CL_RectPacker(const CL_Size &max_group_size, AllocationPolicy policy = create_new_group);
74 
75  ~CL_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  CL_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 CL_Size &size);
111 
115 private:
116  CL_SharedPtr<CL_RectPacker_Impl> impl;
118 };
119