rect_packer.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Kenneth Gangstoe
00027 */
00028 
00031 
00032 #pragma once
00033 
00034 #include "../api_core.h"
00035 #include "../System/sharedptr.h"
00036 #include "rect.h"
00037 
00038 class CL_Size;
00039 class CL_RectPacker_Impl;
00040 
00044 class CL_API_CORE CL_RectPacker
00045 {
00048 public:
00050         enum AllocationPolicy
00051         {
00052                 create_new_group,
00053                 search_previous_groups,
00054                 fail_if_full
00055         };
00056 
00057         struct AllocatedRect
00058         {
00059         public:
00060                 AllocatedRect(int group_index, CL_Rect rect) : group_index(group_index), rect(rect) {}
00061                 int group_index;
00062                 CL_Rect rect;
00063         };
00064 
00068 public:
00070         CL_RectPacker();
00071 
00073         CL_RectPacker(const CL_Size &max_group_size, AllocationPolicy policy = create_new_group);
00074 
00075         ~CL_RectPacker();
00076 
00080 public:
00082         bool is_null() const { return !impl; }
00083 
00085         void throw_if_null() const;
00086 
00088         AllocationPolicy get_allocation_policy() const;
00089 
00091         CL_Size get_max_group_size() const;
00092 
00094         int get_total_rect_count() const;
00095 
00097         int get_rect_count(unsigned int group_index = 0) const;
00098 
00100         int get_group_count() const;
00101 
00105 public:
00107         void set_allocation_policy(AllocationPolicy policy);
00108 
00110         AllocatedRect add(const CL_Size &size);
00111 
00115 private:
00116         CL_SharedPtr<CL_RectPacker_Impl> impl;
00118 };
00119