vrshoot

annotate libs/assimp/ScenePreprocessor.h @ 0:b2f14e535253

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +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 search all meshes for
nuclear@0 42 degenerated faces */
nuclear@0 43 #ifndef AI_SCENE_PREPROCESSOR_H_INC
nuclear@0 44 #define AI_SCENE_PREPROCESSOR_H_INC
nuclear@0 45
nuclear@0 46 class ScenePreprocessorTest;
nuclear@0 47 namespace Assimp {
nuclear@0 48
nuclear@0 49 // ----------------------------------------------------------------------------------
nuclear@0 50 /** ScenePreprocessor: Preprocess a scene before any post-processing
nuclear@0 51 * steps are executed.
nuclear@0 52 *
nuclear@0 53 * The step computes data that needn't necessarily be provided by the
nuclear@0 54 * importer, such as aiMesh::mPrimitiveTypes.
nuclear@0 55 */
nuclear@0 56 // ----------------------------------------------------------------------------------
nuclear@0 57 class ScenePreprocessor
nuclear@0 58 {
nuclear@0 59 // Make ourselves a friend of the corresponding test unit.
nuclear@0 60 friend class ::ScenePreprocessorTest;
nuclear@0 61 public:
nuclear@0 62
nuclear@0 63 // ----------------------------------------------------------------
nuclear@0 64 /** Default c'tpr. Use SetScene() to assign a scene to the object.
nuclear@0 65 */
nuclear@0 66 ScenePreprocessor()
nuclear@0 67 : scene (NULL)
nuclear@0 68 {}
nuclear@0 69
nuclear@0 70 /** Constructs the object and assigns a specific scene to it
nuclear@0 71 */
nuclear@0 72 ScenePreprocessor(aiScene* _scene)
nuclear@0 73 : scene (_scene)
nuclear@0 74 {}
nuclear@0 75
nuclear@0 76 // ----------------------------------------------------------------
nuclear@0 77 /** Assign a (new) scene to the object.
nuclear@0 78 *
nuclear@0 79 * One 'SceneProcessor' can be used for multiple scenes.
nuclear@0 80 * Call ProcessScene to have the scene preprocessed.
nuclear@0 81 * @param sc Scene to be processed.
nuclear@0 82 */
nuclear@0 83 void SetScene (aiScene* sc) {
nuclear@0 84 scene = sc;
nuclear@0 85 }
nuclear@0 86
nuclear@0 87 // ----------------------------------------------------------------
nuclear@0 88 /** Preprocess the current scene
nuclear@0 89 */
nuclear@0 90 void ProcessScene ();
nuclear@0 91
nuclear@0 92 protected:
nuclear@0 93
nuclear@0 94 // ----------------------------------------------------------------
nuclear@0 95 /** Preprocess an animation in the scene
nuclear@0 96 * @param anim Anim to be preprocessed.
nuclear@0 97 */
nuclear@0 98 void ProcessAnimation (aiAnimation* anim);
nuclear@0 99
nuclear@0 100
nuclear@0 101 // ----------------------------------------------------------------
nuclear@0 102 /** Preprocess a mesh in the scene
nuclear@0 103 * @param mesh Mesh to be preprocessed.
nuclear@0 104 */
nuclear@0 105 void ProcessMesh (aiMesh* mesh);
nuclear@0 106
nuclear@0 107 protected:
nuclear@0 108
nuclear@0 109 //! Scene we're currently working on
nuclear@0 110 aiScene* scene;
nuclear@0 111 };
nuclear@0 112
nuclear@0 113
nuclear@0 114 } // ! end namespace Assimp
nuclear@0 115
nuclear@0 116 #endif // include guard