love/src/modules/graphics/Geometry.h

/**
 * Copyright (c) 2006-2013 LOVE Development Team
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 **/

#ifndef LOVE_GRAPHICS_GEOMETRY_H
#define LOVE_GRAPHICS_GEOMETRY_H

// LOVE
#include "common/Object.h"
#include "common/math.h"
#include "common/StringMap.h"
#include "common/int.h"

// stdlib
#include <vector>

namespace love
{
namespace graphics
{

class Geometry : public Object
{
public:

	// How the Geometry's vertices are used when drawing.
	// http://escience.anu.edu.au/lecture/cg/surfaceModeling/image/surfaceModeling015.png
	enum DrawMode
	{
		DRAW_MODE_FAN,
		DRAW_MODE_STRIP,
		DRAW_MODE_TRIANGLES,
		DRAW_MODE_MAX_ENUM
	};

	/**
	 * Creates a new geometry object from a std::vector<vertex>.
	 **/
	Geometry(const std::vector<vertex> &polygon, const std::vector<uint16> &elements, DrawMode mode = DRAW_MODE_FAN);

	/**
	 * Creates a new geometry from (texture) quad information.
	 * @param x Top left position in the image.
	 * @param y Top left position in the image.
	 * @param w Width of the quad.
	 * @param h Height of the quad.
	 * @param sw The reference width, the width of the Image.
	 * @param sh The reference height, the height of the Image.
	 */
	Geometry(float x, float y, float w, float h, float sw, float sh);

	Geometry(const Geometry &other);
	Geometry &operator=(const Geometry &other);
	virtual ~Geometry();

	const vertex &getVertex(size_t i) const;
	void setVertex(size_t i, const vertex &v);

	void flip(bool x, bool y);

	/**
	 * Returns a pointer to the vertex array.
	 **/
	inline const vertex *getVertexArray() const
	{
		return vertexArray;
	}

	/**
	 * Returns the size of the vertex array.
	 **/
	inline size_t getVertexCount() const
	{
		return vertexCount;
	}

	inline const uint16 *getElementArray() const
	{
		return elementArray;
	}

	inline size_t getElementCount() const
	{
		return elementCount;
	}

	void setElementArray(const uint16 *elements, size_t count);

	/**
	 * Sets whether this Geometry will use custom per-vertex colors.
	 **/
	void setVertexColors(bool on);

	/**
	 * Returns whether this Geometry is using custom per-vertex colors.
	 **/
	inline bool hasVertexColors() const
	{
		return vertexColors;
	};

	/**
	 * Returns the mode used when drawing this Geometry.
	 **/
	inline DrawMode getDrawMode() const
	{
		return drawMode;
	}

	static bool getConstant(const char *in, DrawMode &out);
	static bool getConstant(DrawMode in, const char *&out);

private:

	vertex *vertexArray;
	size_t vertexCount;

	uint16 *elementArray;
	size_t elementCount;

	float x_min;
	float x_max;

	float y_min;
	float y_max;

	bool vertexColors;

	DrawMode drawMode;

	static StringMap<DrawMode, DRAW_MODE_MAX_ENUM>::Entry drawModeEntries[];
	static StringMap<DrawMode, DRAW_MODE_MAX_ENUM> drawModes;
};

} // graphics
} // love

#endif // LOVE_GRAPHICS_GEOMETRY_H