vrshoot

annotate libs/assimp/GenVertexNormalsProcess.h @ 2:334d17aed7de

visual studio project files
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 02 Feb 2014 18:36:38 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2012, assimp team
nuclear@0 6 All rights reserved.
nuclear@0 7
nuclear@0 8 Redistribution and use of this software in source and binary forms,
nuclear@0 9 with or without modification, are permitted provided that the
nuclear@0 10 following conditions are met:
nuclear@0 11
nuclear@0 12 * Redistributions of source code must retain the above
nuclear@0 13 copyright notice, this list of conditions and the
nuclear@0 14 following disclaimer.
nuclear@0 15
nuclear@0 16 * Redistributions in binary form must reproduce the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer in the documentation and/or other
nuclear@0 19 materials provided with the distribution.
nuclear@0 20
nuclear@0 21 * Neither the name of the assimp team, nor the names of its
nuclear@0 22 contributors may be used to endorse or promote products
nuclear@0 23 derived from this software without specific prior
nuclear@0 24 written permission of the assimp team.
nuclear@0 25
nuclear@0 26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 37
nuclear@0 38 ----------------------------------------------------------------------
nuclear@0 39 */
nuclear@0 40
nuclear@0 41 /** @file Defines a post processing step to compute vertex normals
nuclear@0 42 for all loaded vertizes */
nuclear@0 43 #ifndef AI_GENVERTEXNORMALPROCESS_H_INC
nuclear@0 44 #define AI_GENVERTEXNORMALPROCESS_H_INC
nuclear@0 45
nuclear@0 46 #include "BaseProcess.h"
nuclear@0 47 #include "assimp/mesh.h"
nuclear@0 48
nuclear@0 49 class GenNormalsTest;
nuclear@0 50
nuclear@0 51 namespace Assimp {
nuclear@0 52
nuclear@0 53 // ---------------------------------------------------------------------------
nuclear@0 54 /** The GenFaceNormalsProcess computes vertex normals for all vertizes
nuclear@0 55 */
nuclear@0 56 class ASSIMP_API_WINONLY GenVertexNormalsProcess : public BaseProcess
nuclear@0 57 {
nuclear@0 58 public:
nuclear@0 59
nuclear@0 60 GenVertexNormalsProcess();
nuclear@0 61 ~GenVertexNormalsProcess();
nuclear@0 62
nuclear@0 63 public:
nuclear@0 64 // -------------------------------------------------------------------
nuclear@0 65 /** Returns whether the processing step is present in the given flag.
nuclear@0 66 * @param pFlags The processing flags the importer was called with.
nuclear@0 67 * A bitwise combination of #aiPostProcessSteps.
nuclear@0 68 * @return true if the process is present in this flag fields,
nuclear@0 69 * false if not.
nuclear@0 70 */
nuclear@0 71 bool IsActive( unsigned int pFlags) const;
nuclear@0 72
nuclear@0 73 // -------------------------------------------------------------------
nuclear@0 74 /** Called prior to ExecuteOnScene().
nuclear@0 75 * The function is a request to the process to update its configuration
nuclear@0 76 * basing on the Importer's configuration property list.
nuclear@0 77 */
nuclear@0 78 void SetupProperties(const Importer* pImp);
nuclear@0 79
nuclear@0 80 // -------------------------------------------------------------------
nuclear@0 81 /** Executes the post processing step on the given imported data.
nuclear@0 82 * At the moment a process is not supposed to fail.
nuclear@0 83 * @param pScene The imported data to work at.
nuclear@0 84 */
nuclear@0 85 void Execute( aiScene* pScene);
nuclear@0 86
nuclear@0 87
nuclear@0 88 // setter for configMaxAngle
nuclear@0 89 inline void SetMaxSmoothAngle(float f)
nuclear@0 90 {
nuclear@0 91 configMaxAngle =f;
nuclear@0 92 }
nuclear@0 93
nuclear@0 94 public:
nuclear@0 95
nuclear@0 96 // -------------------------------------------------------------------
nuclear@0 97 /** Computes normals for a specific mesh
nuclear@0 98 * @param pcMesh Mesh
nuclear@0 99 * @param meshIndex Index of the mesh
nuclear@0 100 * @return true if vertex normals have been computed
nuclear@0 101 */
nuclear@0 102 bool GenMeshVertexNormals (aiMesh* pcMesh, unsigned int meshIndex);
nuclear@0 103
nuclear@0 104 private:
nuclear@0 105
nuclear@0 106 /** Configuration option: maximum smoothing angle, in radians*/
nuclear@0 107 float configMaxAngle;
nuclear@0 108 };
nuclear@0 109
nuclear@0 110 } // end of namespace Assimp
nuclear@0 111
nuclear@0 112 #endif // !!AI_GENVERTEXNORMALPROCESS_H_INC
nuclear@0 113