vrshoot

annotate libs/assimp/SGSpatialSort.h @ 1:e7ca128b8713

looks nice :)
author John Tsiombikas <nuclear@member.fsf.org>
date Sun, 02 Feb 2014 00:35:22 +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 /** Small helper classes to optimise finding vertizes close to a given location
nuclear@0 42 */
nuclear@0 43 #ifndef AI_D3DSSPATIALSORT_H_INC
nuclear@0 44 #define AI_D3DSSPATIALSORT_H_INC
nuclear@0 45
nuclear@0 46 #include <vector>
nuclear@0 47 #include "assimp/types.h"
nuclear@0 48
nuclear@0 49 namespace Assimp {
nuclear@0 50
nuclear@0 51 // ----------------------------------------------------------------------------------
nuclear@0 52 /** Specialized version of SpatialSort to support smoothing groups
nuclear@0 53 * This is used in by the 3DS, ASE and LWO loaders. 3DS and ASE share their
nuclear@0 54 * normal computation code in SmoothingGroups.inl, the LWO loader has its own
nuclear@0 55 * implementation to handle all details of its file format correctly.
nuclear@0 56 */
nuclear@0 57 // ----------------------------------------------------------------------------------
nuclear@0 58 class SGSpatialSort
nuclear@0 59 {
nuclear@0 60 public:
nuclear@0 61
nuclear@0 62 SGSpatialSort();
nuclear@0 63
nuclear@0 64 // -------------------------------------------------------------------
nuclear@0 65 /** Construction from a given face array, handling smoothing groups
nuclear@0 66 * properly
nuclear@0 67 */
nuclear@0 68 SGSpatialSort(const std::vector<aiVector3D>& vPositions);
nuclear@0 69
nuclear@0 70 // -------------------------------------------------------------------
nuclear@0 71 /** Add a vertex to the spatial sort
nuclear@0 72 * @param vPosition Vertex position to be added
nuclear@0 73 * @param index Index of the vrtex
nuclear@0 74 * @param smoothingGroup SmoothingGroup for this vertex
nuclear@0 75 */
nuclear@0 76 void Add(const aiVector3D& vPosition, unsigned int index,
nuclear@0 77 unsigned int smoothingGroup);
nuclear@0 78
nuclear@0 79 // -------------------------------------------------------------------
nuclear@0 80 /** Prepare the spatial sorter for use. This step runs in O(logn)
nuclear@0 81 */
nuclear@0 82 void Prepare();
nuclear@0 83
nuclear@0 84 /** Destructor */
nuclear@0 85 ~SGSpatialSort();
nuclear@0 86
nuclear@0 87 // -------------------------------------------------------------------
nuclear@0 88 /** Returns an iterator for all positions close to the given position.
nuclear@0 89 * @param pPosition The position to look for vertices.
nuclear@0 90 * @param pSG Only included vertices with at least one shared smooth group
nuclear@0 91 * @param pRadius Maximal distance from the position a vertex may have
nuclear@0 92 * to be counted in.
nuclear@0 93 * @param poResults The container to store the indices of the found
nuclear@0 94 * positions. Will be emptied by the call so it may contain anything.
nuclear@0 95 * @param exactMatch Specifies whether smoothing groups are bit masks
nuclear@0 96 * (false) or integral values (true). In the latter case, a vertex
nuclear@0 97 * cannot belong to more than one smoothing group.
nuclear@0 98 * @return An iterator to iterate over all vertices in the given area.
nuclear@0 99 */
nuclear@0 100 // -------------------------------------------------------------------
nuclear@0 101 void FindPositions( const aiVector3D& pPosition, uint32_t pSG,
nuclear@0 102 float pRadius, std::vector<unsigned int>& poResults,
nuclear@0 103 bool exactMatch = false) const;
nuclear@0 104
nuclear@0 105 protected:
nuclear@0 106 /** Normal of the sorting plane, normalized. The center is always at (0, 0, 0) */
nuclear@0 107 aiVector3D mPlaneNormal;
nuclear@0 108
nuclear@0 109 // -------------------------------------------------------------------
nuclear@0 110 /** An entry in a spatially sorted position array. Consists of a
nuclear@0 111 * vertex index, its position and its precalculated distance from
nuclear@0 112 * the reference plane */
nuclear@0 113 // -------------------------------------------------------------------
nuclear@0 114 struct Entry
nuclear@0 115 {
nuclear@0 116 unsigned int mIndex; ///< The vertex referred by this entry
nuclear@0 117 aiVector3D mPosition; ///< Position
nuclear@0 118 uint32_t mSmoothGroups;
nuclear@0 119 float mDistance; ///< Distance of this vertex to the sorting plane
nuclear@0 120
nuclear@0 121 Entry() { /** intentionally not initialized.*/ }
nuclear@0 122 Entry( unsigned int pIndex, const aiVector3D& pPosition, float pDistance,uint32_t pSG)
nuclear@0 123 :
nuclear@0 124 mIndex( pIndex),
nuclear@0 125 mPosition( pPosition),
nuclear@0 126 mSmoothGroups (pSG),
nuclear@0 127 mDistance( pDistance)
nuclear@0 128 { }
nuclear@0 129
nuclear@0 130 bool operator < (const Entry& e) const { return mDistance < e.mDistance; }
nuclear@0 131 };
nuclear@0 132
nuclear@0 133 // all positions, sorted by distance to the sorting plane
nuclear@0 134 std::vector<Entry> mPositions;
nuclear@0 135 };
nuclear@0 136
nuclear@0 137 } // end of namespace Assimp
nuclear@0 138
nuclear@0 139 #endif // AI_SPATIALSORT_H_INC