vrshoot

annotate libs/assimp/NFFLoader.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 NFFLoader.h
nuclear@0 42 * @brief Declaration of the NFF importer class.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_NFFLOADER_H_INCLUDED
nuclear@0 45 #define AI_NFFLOADER_H_INCLUDED
nuclear@0 46
nuclear@0 47 #include "BaseImporter.h"
nuclear@0 48 #include <vector>
nuclear@0 49
nuclear@0 50 #include "assimp/types.h"
nuclear@0 51
nuclear@0 52 namespace Assimp {
nuclear@0 53
nuclear@0 54 // ----------------------------------------------------------------------------------
nuclear@0 55 /** NFF (Neutral File Format) Importer class.
nuclear@0 56 *
nuclear@0 57 * The class implements both Eric Haynes NFF format and Sense8's NFF (NFF2) format.
nuclear@0 58 * Both are quite different and the loading code is somewhat dirty at
nuclear@0 59 * the moment. Sense8 should be moved to a separate loader.
nuclear@0 60 */
nuclear@0 61 class NFFImporter : public BaseImporter
nuclear@0 62 {
nuclear@0 63 public:
nuclear@0 64 NFFImporter();
nuclear@0 65 ~NFFImporter();
nuclear@0 66
nuclear@0 67
nuclear@0 68 public:
nuclear@0 69
nuclear@0 70 // -------------------------------------------------------------------
nuclear@0 71 /** Returns whether the class can handle the format of the given file.
nuclear@0 72 * See BaseImporter::CanRead() for details.
nuclear@0 73 */
nuclear@0 74 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 75 bool checkSig) const;
nuclear@0 76
nuclear@0 77 protected:
nuclear@0 78
nuclear@0 79 // -------------------------------------------------------------------
nuclear@0 80 /** Return importer meta information.
nuclear@0 81 * See #BaseImporter::GetInfo for the details
nuclear@0 82 */
nuclear@0 83 const aiImporterDesc* GetInfo () const;
nuclear@0 84
nuclear@0 85 // -------------------------------------------------------------------
nuclear@0 86 /** Imports the given file into the given scene structure.
nuclear@0 87 * See BaseImporter::InternReadFile() for details
nuclear@0 88 */
nuclear@0 89 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 90 IOSystem* pIOHandler);
nuclear@0 91
nuclear@0 92 private:
nuclear@0 93
nuclear@0 94
nuclear@0 95 // describes face material properties
nuclear@0 96 struct ShadingInfo
nuclear@0 97 {
nuclear@0 98 ShadingInfo()
nuclear@0 99 : color (0.6f,0.6f,0.6f)
nuclear@0 100 , diffuse (1.f,1.f,1.f)
nuclear@0 101 , specular (1.f,1.f,1.f)
nuclear@0 102 , ambient (0.f,0.f,0.f)
nuclear@0 103 , emissive (0.f,0.f,0.f)
nuclear@0 104 , refracti (1.f)
nuclear@0 105 , twoSided (false) // for NFF2
nuclear@0 106 , shaded (true) // for NFF2
nuclear@0 107 , opacity (1.f)
nuclear@0 108 , shininess (0.f)
nuclear@0 109 , mapping (aiTextureMapping_UV)
nuclear@0 110 {}
nuclear@0 111
nuclear@0 112 aiColor3D color,diffuse,specular,ambient,emissive;
nuclear@0 113 float refracti;
nuclear@0 114
nuclear@0 115 std::string texFile;
nuclear@0 116
nuclear@0 117 // For NFF2
nuclear@0 118 bool twoSided;
nuclear@0 119 bool shaded;
nuclear@0 120 float opacity, shininess;
nuclear@0 121
nuclear@0 122 std::string name;
nuclear@0 123
nuclear@0 124 // texture mapping to be generated for the mesh - uv is the default
nuclear@0 125 // it means: use UV if there, nothing otherwise. This property is
nuclear@0 126 // used for locked meshes.
nuclear@0 127 aiTextureMapping mapping;
nuclear@0 128
nuclear@0 129 // shininess is ignored for the moment
nuclear@0 130 bool operator == (const ShadingInfo& other) const
nuclear@0 131 {
nuclear@0 132 return color == other.color &&
nuclear@0 133 diffuse == other.diffuse &&
nuclear@0 134 specular == other.specular &&
nuclear@0 135 ambient == other.ambient &&
nuclear@0 136 refracti == other.refracti &&
nuclear@0 137 texFile == other.texFile &&
nuclear@0 138 twoSided == other.twoSided &&
nuclear@0 139 shaded == other.shaded;
nuclear@0 140
nuclear@0 141 // Some properties from NFF2 aren't compared by this operator.
nuclear@0 142 // Comparing MeshInfo::matIndex should do that.
nuclear@0 143 }
nuclear@0 144 };
nuclear@0 145
nuclear@0 146 // describes a NFF light source
nuclear@0 147 struct Light
nuclear@0 148 {
nuclear@0 149 Light()
nuclear@0 150 : intensity (1.f)
nuclear@0 151 , color (1.f,1.f,1.f)
nuclear@0 152 {}
nuclear@0 153
nuclear@0 154 aiVector3D position;
nuclear@0 155 float intensity;
nuclear@0 156 aiColor3D color;
nuclear@0 157 };
nuclear@0 158
nuclear@0 159 enum PatchType
nuclear@0 160 {
nuclear@0 161 PatchType_Simple = 0x0,
nuclear@0 162 PatchType_Normals = 0x1,
nuclear@0 163 PatchType_UVAndNormals = 0x2
nuclear@0 164 };
nuclear@0 165
nuclear@0 166 // describes a NFF mesh
nuclear@0 167 struct MeshInfo
nuclear@0 168 {
nuclear@0 169 MeshInfo(PatchType _pType, bool bL = false)
nuclear@0 170 : pType (_pType)
nuclear@0 171 , bLocked (bL)
nuclear@0 172 , radius (1.f,1.f,1.f)
nuclear@0 173 , dir (0.f,1.f,0.f)
nuclear@0 174 , matIndex (0)
nuclear@0 175 {
nuclear@0 176 name[0] = '\0'; // by default meshes are unnamed
nuclear@0 177 }
nuclear@0 178
nuclear@0 179 ShadingInfo shader;
nuclear@0 180 PatchType pType;
nuclear@0 181 bool bLocked;
nuclear@0 182
nuclear@0 183 // for spheres, cones and cylinders: center point of the object
nuclear@0 184 aiVector3D center, radius, dir;
nuclear@0 185
nuclear@0 186 char name[128];
nuclear@0 187
nuclear@0 188 std::vector<aiVector3D> vertices, normals, uvs;
nuclear@0 189 std::vector<unsigned int> faces;
nuclear@0 190
nuclear@0 191 // for NFF2
nuclear@0 192 std::vector<aiColor4D> colors;
nuclear@0 193 unsigned int matIndex;
nuclear@0 194 };
nuclear@0 195
nuclear@0 196
nuclear@0 197 // -------------------------------------------------------------------
nuclear@0 198 /** Loads the material table for the NFF2 file format from an
nuclear@0 199 * external file.
nuclear@0 200 *
nuclear@0 201 * @param output Receives the list of output meshes
nuclear@0 202 * @param path Path to the file (abs. or rel.)
nuclear@0 203 * @param pIOHandler IOSystem to be used to open the file
nuclear@0 204 */
nuclear@0 205 void LoadNFF2MaterialTable(std::vector<ShadingInfo>& output,
nuclear@0 206 const std::string& path, IOSystem* pIOHandler);
nuclear@0 207
nuclear@0 208 };
nuclear@0 209
nuclear@0 210 } // end of namespace Assimp
nuclear@0 211
nuclear@0 212 #endif // AI_NFFIMPORTER_H_IN