BansheeEngine/Source/BansheeEngine/Include/BsGUILayoutUtility.h

//********************************** Banshee Engine (www.banshee3d.com) **************************************************//
//**************** Copyright (c) 2016 Marko Pintera ([email protected]). All rights reserved. **********************//
#pragma once

#include "BsPrerequisites.h"
#include "BsRect2I.h"
#include "BsVector2I.h"

namespace BansheeEngine
{
	/** @addtogroup GUI-Internal
	 *  @{
	 */

	/** Helper class that performs various operations related to GUILayout and GUI element sizing/placement. */
	class BS_EXPORT GUILayoutUtility
	{
	public:
		/**
		 * Calculates optimal size of a GUI element. This is the size that allows the GUI element to properly display all of
		 * its content.
		 */
		static Vector2I calcOptimalSize(const GUIElementBase* elem);

		/**
		 * Calculates the size of elements in a layout of the specified size.
		 * 
		 * @param[in]	width				Width of the layout.
		 * @param[in]	height				Height of the layout.
		 * @param[in]	layout				Parent layout of the children to calculate the area for.
		 * @param[in]	updateOptimalSizes	Optimization (doesn't change the results). Set to false if 
		 *									GUIElementBase::_updateOptimalLayoutSizes was already called and optimal sizes
		 *									are up to date to avoid recalculating them. (Normally that is true if this is 
		 *									being called during GUI layout update)
		 */
		static Vector2I calcActualSize(UINT32 width, UINT32 height, GUILayout* layout, bool updateOptimalSizes = true);

	private:
		/**
		 * Calculates the size of elements in a layout of the specified size. Assumes the layout and all its children
		 * have updated optimal sizes.
		 * 
		 * @param[in]	width				Width of the layout.
		 * @param[in]	height				Height of the layout.
		 * @param[in]	layout				Parent layout of the children to calculate the area for.
		 */
		static Vector2I calcActualSizeInternal(UINT32 width, UINT32 height, GUILayout* layout);
	};

	/** @} */
}