vrshoot

annotate libs/assimp/PlyLoader.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 PLYLoader.h
nuclear@0 42 * @brief Declaration of the .ply importer class.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_PLYLOADER_H_INCLUDED
nuclear@0 45 #define AI_PLYLOADER_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
nuclear@0 52 #include "PlyParser.h"
nuclear@0 53
nuclear@0 54 namespace Assimp {
nuclear@0 55
nuclear@0 56
nuclear@0 57 using namespace PLY;
nuclear@0 58
nuclear@0 59 // ---------------------------------------------------------------------------
nuclear@0 60 /** Importer class to load the stanford PLY file format
nuclear@0 61 */
nuclear@0 62 class PLYImporter : public BaseImporter
nuclear@0 63 {
nuclear@0 64 public:
nuclear@0 65 PLYImporter();
nuclear@0 66 ~PLYImporter();
nuclear@0 67
nuclear@0 68
nuclear@0 69 public:
nuclear@0 70
nuclear@0 71 // -------------------------------------------------------------------
nuclear@0 72 /** Returns whether the class can handle the format of the given file.
nuclear@0 73 * See BaseImporter::CanRead() for details.
nuclear@0 74 */
nuclear@0 75 bool CanRead( const std::string& pFile, IOSystem* pIOHandler,
nuclear@0 76 bool checkSig) const;
nuclear@0 77
nuclear@0 78 protected:
nuclear@0 79
nuclear@0 80 // -------------------------------------------------------------------
nuclear@0 81 /** Return importer meta information.
nuclear@0 82 * See #BaseImporter::GetInfo for the details
nuclear@0 83 */
nuclear@0 84 const aiImporterDesc* GetInfo () const;
nuclear@0 85
nuclear@0 86 // -------------------------------------------------------------------
nuclear@0 87 /** Imports the given file into the given scene structure.
nuclear@0 88 * See BaseImporter::InternReadFile() for details
nuclear@0 89 */
nuclear@0 90 void InternReadFile( const std::string& pFile, aiScene* pScene,
nuclear@0 91 IOSystem* pIOHandler);
nuclear@0 92
nuclear@0 93 protected:
nuclear@0 94
nuclear@0 95
nuclear@0 96 // -------------------------------------------------------------------
nuclear@0 97 /** Extract vertices from the DOM
nuclear@0 98 */
nuclear@0 99 void LoadVertices(std::vector<aiVector3D>* pvOut,
nuclear@0 100 bool p_bNormals = false);
nuclear@0 101
nuclear@0 102 // -------------------------------------------------------------------
nuclear@0 103 /** Extract vertex color channels from the DOM
nuclear@0 104 */
nuclear@0 105 void LoadVertexColor(std::vector<aiColor4D>* pvOut);
nuclear@0 106
nuclear@0 107 // -------------------------------------------------------------------
nuclear@0 108 /** Extract texture coordinate channels from the DOM
nuclear@0 109 */
nuclear@0 110 void LoadTextureCoordinates(std::vector<aiVector2D>* pvOut);
nuclear@0 111
nuclear@0 112 // -------------------------------------------------------------------
nuclear@0 113 /** Extract a face list from the DOM
nuclear@0 114 */
nuclear@0 115 void LoadFaces(std::vector<PLY::Face>* pvOut);
nuclear@0 116
nuclear@0 117 // -------------------------------------------------------------------
nuclear@0 118 /** Extract a material list from the DOM
nuclear@0 119 */
nuclear@0 120 void LoadMaterial(std::vector<aiMaterial*>* pvOut);
nuclear@0 121
nuclear@0 122
nuclear@0 123 // -------------------------------------------------------------------
nuclear@0 124 /** Validate material indices, replace default material identifiers
nuclear@0 125 */
nuclear@0 126 void ReplaceDefaultMaterial(std::vector<PLY::Face>* avFaces,
nuclear@0 127 std::vector<aiMaterial*>* avMaterials);
nuclear@0 128
nuclear@0 129
nuclear@0 130 // -------------------------------------------------------------------
nuclear@0 131 /** Convert all meshes into our ourer representation
nuclear@0 132 */
nuclear@0 133 void ConvertMeshes(std::vector<PLY::Face>* avFaces,
nuclear@0 134 const std::vector<aiVector3D>* avPositions,
nuclear@0 135 const std::vector<aiVector3D>* avNormals,
nuclear@0 136 const std::vector<aiColor4D>* avColors,
nuclear@0 137 const std::vector<aiVector2D>* avTexCoords,
nuclear@0 138 const std::vector<aiMaterial*>* avMaterials,
nuclear@0 139 std::vector<aiMesh*>* avOut);
nuclear@0 140
nuclear@0 141
nuclear@0 142 // -------------------------------------------------------------------
nuclear@0 143 /** Static helper to parse a color from four single channels in
nuclear@0 144 */
nuclear@0 145 static void GetMaterialColor(
nuclear@0 146 const std::vector<PLY::PropertyInstance>& avList,
nuclear@0 147 unsigned int aiPositions[4],
nuclear@0 148 PLY::EDataType aiTypes[4],
nuclear@0 149 aiColor4D* clrOut);
nuclear@0 150
nuclear@0 151
nuclear@0 152 // -------------------------------------------------------------------
nuclear@0 153 /** Static helper to parse a color channel value. The input value
nuclear@0 154 * is normalized to 0-1.
nuclear@0 155 */
nuclear@0 156 static float NormalizeColorValue (
nuclear@0 157 PLY::PropertyInstance::ValueUnion val,
nuclear@0 158 PLY::EDataType eType);
nuclear@0 159
nuclear@0 160
nuclear@0 161 /** Buffer to hold the loaded file */
nuclear@0 162 unsigned char* mBuffer;
nuclear@0 163
nuclear@0 164 /** Document object model representation extracted from the file */
nuclear@0 165 PLY::DOM* pcDOM;
nuclear@0 166 };
nuclear@0 167
nuclear@0 168 } // end of namespace Assimp
nuclear@0 169
nuclear@0 170 #endif // AI_3DSIMPORTER_H_INC