assimp/code/ComputeUVMappingProcess.h

/*
Open Asset Import Library (ASSIMP)
----------------------------------------------------------------------

Copyright (c) 2006-2008, ASSIMP Development Team
All rights reserved.

Redistribution and use of this software in source and binary forms, 
with or without modification, are permitted provided that the 
following conditions are met:

* Redistributions of source code must retain the above
  copyright notice, this list of conditions and the
  following disclaimer.

* Redistributions in binary form must reproduce the above
  copyright notice, this list of conditions and the
  following disclaimer in the documentation and/or other
  materials provided with the distribution.

* Neither the name of the ASSIMP team, nor the names of its
  contributors may be used to endorse or promote products
  derived from this software without specific prior
  written permission of the ASSIMP Development Team.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

----------------------------------------------------------------------
*/

/** @file Defines a post processing step to compute UV coordinates
  from abstract mappings, such as box or spherical*/
#ifndef AI_COMPUTEUVMAPPING_H_INC
#define AI_COMPUTEUVMAPPING_H_INC

#include "BaseProcess.h"
#include "../include/aiMesh.h"

class ComputeUVMappingTest;
namespace Assimp
	{

// ---------------------------------------------------------------------------
/** ComputeUVMappingProcess - converts special mappings, such as spherical,
 *  cylindrical or boxed to proper UV coordinates for rendering.
*/
class ASSIMP_API ComputeUVMappingProcess : public BaseProcess
{
	friend class Importer;
	friend class ::ComputeUVMappingTest; // grant the unit test full access to us

protected:
	/** Constructor to be privately used by Importer */
	ComputeUVMappingProcess();

	/** Destructor, private as well */
	~ComputeUVMappingProcess();

public:
	// -------------------------------------------------------------------
	/** Returns whether the processing step is present in the given flag field.
	* @param pFlags The processing flags the importer was called with. A bitwise
	*   combination of #aiPostProcessSteps.
	* @return true if the process is present in this flag fields, false if not.
	*/
	bool IsActive( unsigned int pFlags) const;

	// -------------------------------------------------------------------
	/** Executes the post processing step on the given imported data.
	* At the moment a process is not supposed to fail.
	* @param pScene The imported data to work at.
	*/
	void Execute( aiScene* pScene);

protected:

	// -------------------------------------------------------------------
	/** Computes spherical UV coordinates for a mesh
	 *
	 *  @param mesh Mesh to be processed
	 *  @param axis Main axis
	 *  @return Index of the newly generated UV channel
	*/
	unsigned int ComputeSphereMapping(aiMesh* mesh,aiAxis axis);

	// -------------------------------------------------------------------
	/** Computes cylindrical UV coordinates for a mesh
	 *
	 *  @param mesh Mesh to be processed
	 *  @param axis Main axis
	 *  @return Index of the newly generated UV channel
	*/
	unsigned int ComputeCylinderMapping(aiMesh* mesh,aiAxis axis);

	// -------------------------------------------------------------------
	/** Computes planar UV coordinates for a mesh
	 *
	 *  @param mesh Mesh to be processed
	 *  @param axis Main axis
	 *  @return Index of the newly generated UV channel
	*/
	unsigned int ComputePlaneMapping(aiMesh* mesh,aiAxis axis);

	// -------------------------------------------------------------------
	/** Computes cubic UV coordinates for a mesh
	 *
	 *  @param mesh Mesh to be processed
	 *  @return Index of the newly generated UV channel
	*/
	unsigned int ComputeBoxMapping(aiMesh* mesh);
};

} // end of namespace Assimp

#endif // AI_COMPUTEUVMAPPING_H_INC