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 
45 {
48 public:
51  {
55  };
56 
58  {
59  public:
63  };
64 
68 public:
71 
73  RectPacker(const Size &max_group_size, AllocationPolicy policy = create_new_group);
74 
76 
80 public:
82  bool is_null() const { return !impl; }
83 
85  void throw_if_null() const;
86 
89 
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:
108 
110  AllocatedRect add(const Size &size);
111 
115 private:
116  std::shared_ptr<RectPacker_Impl> impl;
118 };
119 
120 }
121 
AllocatedRect(int group_index, Rect rect)
Definition: rect_packer.h:60
Size get_max_group_size() const
Returns the max group size.
2D (left,top,right,bottom) rectangle structure - Integer
Definition: rect.h:471
int group_index
Definition: rect_packer.h:61
void throw_if_null() const
Throw an exception if this object is invalid.
bool is_null() const
Returns true if this object is invalid.
Definition: rect_packer.h:82
int get_rect_count(unsigned int group_index=0) const
Returns the amount of rects in a group.
void set_allocation_policy(AllocationPolicy policy)
Set the allocation policy.
Definition: rect_packer.h:58
int get_total_rect_count() const
Returns the total amount of rects.
@ search_previous_groups
Definition: rect_packer.h:53
RectPacker(const Size &max_group_size, AllocationPolicy policy=create_new_group)
Constructs a rect group.
@ fail_if_full
Definition: rect_packer.h:54
@ create_new_group
Definition: rect_packer.h:52
AllocationPolicy
Allocation policy.
Definition: rect_packer.h:51
Definition: clanapp.h:36
int get_group_count() const
Returns the amount of rects used by group.
RectPacker()
Constructs a null instance.
Generic rect packer class. Implements an algorithm to pack rects into groups efficiently.
Definition: rect_packer.h:45
AllocationPolicy get_allocation_policy() const
Returns the allocation policy.
2D (width,height) size structure - Integer
Definition: size.h:157
Rect rect
Definition: rect_packer.h:62
AllocatedRect add(const Size &size)
Allocate space for another rect.