RmlUi/Source/Core/TextureLayoutRow.h

/*
 * This source file is part of RmlUi, the HTML/CSS Interface Middleware
 *
 * For the latest information, see http://github.com/mikke89/RmlUi
 *
 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
 * Copyright (c) 2019-2023 The RmlUi Team, and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#ifndef TEXTURELAYOUTROW_H
#define TEXTURELAYOUTROW_H

#include "TextureLayoutRectangle.h"

namespace Rml {

class TextureLayout;

/**
    A texture layout row is a single row of rectangles positioned vertically within a texture.

    @author Peter
 */

class TextureLayoutRow {
public:
	TextureLayoutRow();
	~TextureLayoutRow();

	/// Attempts to position unplaced rectangles from the layout into this row.
	/// @param[in] layout The layout to position rectangles from.
	/// @param[in] width The maximum width of this row.
	/// @param[in] y The y-coordinate of this row.
	/// @return The number of placed rectangles.
	int Generate(TextureLayout& layout, int width, int y);

	/// Assigns allocated texture data to all rectangles in this row.
	/// @param[in] texture_data The pointer to the beginning of the texture's data.
	/// @param[in] stride The stride of the texture's surface, in bytes;
	void Allocate(byte* texture_data, int stride);

	/// Returns the height of the row.
	/// @return The row's height.
	int GetHeight() const;

	/// Resets the placed status for all of the rectangles within this row.
	void Unplace();

private:
	using RectangleList = Vector<TextureLayoutRectangle*>;

	int height;
	RectangleList rectangles;
};

} // namespace Rml
#endif