vrshoot

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

find changesets by author, revision, files, or words in the commit message
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 ASELoader.h
nuclear@0 42 * @brief Definition of the .ASE importer class.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_ASELOADER_H_INCLUDED
nuclear@0 45 #define AI_ASELOADER_H_INCLUDED
nuclear@0 46
nuclear@0 47 #include "BaseImporter.h"
nuclear@0 48 #include "assimp/types.h"
nuclear@0 49
nuclear@0 50 struct aiNode;
nuclear@0 51 #include "ASEParser.h"
nuclear@0 52
nuclear@0 53 namespace Assimp {
nuclear@0 54
nuclear@0 55
nuclear@0 56 // --------------------------------------------------------------------------------
nuclear@0 57 /** Importer class for the 3DS ASE ASCII format.
nuclear@0 58 *
nuclear@0 59 */
nuclear@0 60 class ASEImporter : public BaseImporter {
nuclear@0 61 public:
nuclear@0 62 ASEImporter();
nuclear@0 63 ~ASEImporter();
nuclear@0 64
nuclear@0 65
nuclear@0 66 public:
nuclear@0 67
nuclear@0 68 // -------------------------------------------------------------------
nuclear@0 69 /** Returns whether the class can handle the format of the given file.
nuclear@0 70 * See BaseImporter::CanRead() for details.
nuclear@0 71 */
nuclear@0 72 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 73 bool checkSig) const;
nuclear@0 74
nuclear@0 75 protected:
nuclear@0 76
nuclear@0 77 // -------------------------------------------------------------------
nuclear@0 78 /** Return importer meta information.
nuclear@0 79 * See #BaseImporter::GetInfo for the details
nuclear@0 80 */
nuclear@0 81 const aiImporterDesc* GetInfo () const;
nuclear@0 82
nuclear@0 83
nuclear@0 84 // -------------------------------------------------------------------
nuclear@0 85 /** Imports the given file into the given scene structure.
nuclear@0 86 * See BaseImporter::InternReadFile() for details
nuclear@0 87 */
nuclear@0 88 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 89 IOSystem* pIOHandler);
nuclear@0 90
nuclear@0 91
nuclear@0 92 // -------------------------------------------------------------------
nuclear@0 93 /** Called prior to ReadFile().
nuclear@0 94 * The function is a request to the importer to update its configuration
nuclear@0 95 * basing on the Importer's configuration property list.
nuclear@0 96 */
nuclear@0 97 void SetupProperties(const Importer* pImp);
nuclear@0 98
nuclear@0 99
nuclear@0 100 private:
nuclear@0 101
nuclear@0 102 // -------------------------------------------------------------------
nuclear@0 103 /** Generate normal vectors basing on smoothing groups
nuclear@0 104 * (in some cases the normal are already contained in the file)
nuclear@0 105 * \param mesh Mesh to work on
nuclear@0 106 * \return false if the normals have been recomputed
nuclear@0 107 */
nuclear@0 108 bool GenerateNormals(ASE::Mesh& mesh);
nuclear@0 109
nuclear@0 110
nuclear@0 111 // -------------------------------------------------------------------
nuclear@0 112 /** Create valid vertex/normal/UV/color/face lists.
nuclear@0 113 * All elements are unique, faces have only one set of indices
nuclear@0 114 * after this step occurs.
nuclear@0 115 * \param mesh Mesh to work on
nuclear@0 116 */
nuclear@0 117 void BuildUniqueRepresentation(ASE::Mesh& mesh);
nuclear@0 118
nuclear@0 119
nuclear@0 120 /** Create one-material-per-mesh meshes ;-)
nuclear@0 121 * \param mesh Mesh to work with
nuclear@0 122 * \param Receives the list of all created meshes
nuclear@0 123 */
nuclear@0 124 void ConvertMeshes(ASE::Mesh& mesh, std::vector<aiMesh*>& avOut);
nuclear@0 125
nuclear@0 126
nuclear@0 127 // -------------------------------------------------------------------
nuclear@0 128 /** Convert a material to a aiMaterial object
nuclear@0 129 * \param mat Input material
nuclear@0 130 */
nuclear@0 131 void ConvertMaterial(ASE::Material& mat);
nuclear@0 132
nuclear@0 133
nuclear@0 134 // -------------------------------------------------------------------
nuclear@0 135 /** Setup the final material indices for each mesh
nuclear@0 136 */
nuclear@0 137 void BuildMaterialIndices();
nuclear@0 138
nuclear@0 139
nuclear@0 140 // -------------------------------------------------------------------
nuclear@0 141 /** Build the node graph
nuclear@0 142 */
nuclear@0 143 void BuildNodes(std::vector<ASE::BaseNode*>& nodes);
nuclear@0 144
nuclear@0 145
nuclear@0 146 // -------------------------------------------------------------------
nuclear@0 147 /** Build output cameras
nuclear@0 148 */
nuclear@0 149 void BuildCameras();
nuclear@0 150
nuclear@0 151
nuclear@0 152 // -------------------------------------------------------------------
nuclear@0 153 /** Build output lights
nuclear@0 154 */
nuclear@0 155 void BuildLights();
nuclear@0 156
nuclear@0 157
nuclear@0 158 // -------------------------------------------------------------------
nuclear@0 159 /** Build output animations
nuclear@0 160 */
nuclear@0 161 void BuildAnimations(const std::vector<ASE::BaseNode*>& nodes);
nuclear@0 162
nuclear@0 163
nuclear@0 164 // -------------------------------------------------------------------
nuclear@0 165 /** Add sub nodes to a node
nuclear@0 166 * \param pcParent parent node to be filled
nuclear@0 167 * \param szName Name of the parent node
nuclear@0 168 * \param matrix Current transform
nuclear@0 169 */
nuclear@0 170 void AddNodes(const std::vector<ASE::BaseNode*>& nodes,
nuclear@0 171 aiNode* pcParent,const char* szName);
nuclear@0 172
nuclear@0 173 void AddNodes(const std::vector<ASE::BaseNode*>& nodes,
nuclear@0 174 aiNode* pcParent,const char* szName,
nuclear@0 175 const aiMatrix4x4& matrix);
nuclear@0 176
nuclear@0 177 void AddMeshes(const ASE::BaseNode* snode,aiNode* node);
nuclear@0 178
nuclear@0 179 // -------------------------------------------------------------------
nuclear@0 180 /** Generate a default material and add it to the parser's list
nuclear@0 181 * Called if no material has been found in the file (rare for ASE,
nuclear@0 182 * but not impossible)
nuclear@0 183 */
nuclear@0 184 void GenerateDefaultMaterial();
nuclear@0 185
nuclear@0 186 protected:
nuclear@0 187
nuclear@0 188 /** Parser instance */
nuclear@0 189 ASE::Parser* mParser;
nuclear@0 190
nuclear@0 191 /** Buffer to hold the loaded file */
nuclear@0 192 char* mBuffer;
nuclear@0 193
nuclear@0 194 /** Scene to be filled */
nuclear@0 195 aiScene* pcScene;
nuclear@0 196
nuclear@0 197 /** Config options: Recompute the normals in every case - WA
nuclear@0 198 for 3DS Max broken ASE normal export */
nuclear@0 199 bool configRecomputeNormals;
nuclear@0 200 bool noSkeletonMesh;
nuclear@0 201 };
nuclear@0 202
nuclear@0 203 } // end of namespace Assimp
nuclear@0 204
nuclear@0 205 #endif // AI_3DSIMPORTER_H_INC