vrshoot

annotate libs/assimp/StandardShapes.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 Declares a helper class, "StandardShapes" which generates
nuclear@0 42 * vertices for standard shapes, such as cylnders, cones, spheres ..
nuclear@0 43 */
nuclear@0 44 #ifndef AI_STANDARD_SHAPES_H_INC
nuclear@0 45 #define AI_STANDARD_SHAPES_H_INC
nuclear@0 46
nuclear@0 47 #include <vector>
nuclear@0 48
nuclear@0 49
nuclear@0 50 namespace Assimp {
nuclear@0 51
nuclear@0 52 // ---------------------------------------------------------------------------
nuclear@0 53 /** \brief Helper class to generate vertex buffers for standard geometric
nuclear@0 54 * shapes, such as cylinders, cones, boxes, spheres, elipsoids ... .
nuclear@0 55 */
nuclear@0 56 class StandardShapes
nuclear@0 57 {
nuclear@0 58 // class cannot be instanced
nuclear@0 59 StandardShapes() {}
nuclear@0 60
nuclear@0 61 public:
nuclear@0 62
nuclear@0 63
nuclear@0 64 // ----------------------------------------------------------------
nuclear@0 65 /** Generates a mesh from an array of vertex positions.
nuclear@0 66 *
nuclear@0 67 * @param positions List of vertex positions
nuclear@0 68 * @param numIndices Number of indices per primitive
nuclear@0 69 * @return Output mesh
nuclear@0 70 */
nuclear@0 71 static aiMesh* MakeMesh(const std::vector<aiVector3D>& positions,
nuclear@0 72 unsigned int numIndices);
nuclear@0 73
nuclear@0 74
nuclear@0 75 static aiMesh* MakeMesh ( unsigned int (*GenerateFunc)
nuclear@0 76 (std::vector<aiVector3D>&));
nuclear@0 77
nuclear@0 78 static aiMesh* MakeMesh ( unsigned int (*GenerateFunc)
nuclear@0 79 (std::vector<aiVector3D>&, bool));
nuclear@0 80
nuclear@0 81 static aiMesh* MakeMesh ( unsigned int n, void (*GenerateFunc)
nuclear@0 82 (unsigned int,std::vector<aiVector3D>&));
nuclear@0 83
nuclear@0 84 // ----------------------------------------------------------------
nuclear@0 85 /** @brief Generates a hexahedron (cube)
nuclear@0 86 *
nuclear@0 87 * Hexahedrons can be scaled on all axes.
nuclear@0 88 * @param positions Receives output triangles.
nuclear@0 89 * @param polygons If you pass true here quads will be returned
nuclear@0 90 * @return Number of vertices per face
nuclear@0 91 */
nuclear@0 92 static unsigned int MakeHexahedron(
nuclear@0 93 std::vector<aiVector3D>& positions,
nuclear@0 94 bool polygons = false);
nuclear@0 95
nuclear@0 96 // ----------------------------------------------------------------
nuclear@0 97 /** @brief Generates an icosahedron
nuclear@0 98 *
nuclear@0 99 * @param positions Receives output triangles.
nuclear@0 100 * @return Number of vertices per face
nuclear@0 101 */
nuclear@0 102 static unsigned int MakeIcosahedron(
nuclear@0 103 std::vector<aiVector3D>& positions);
nuclear@0 104
nuclear@0 105
nuclear@0 106 // ----------------------------------------------------------------
nuclear@0 107 /** @brief Generates a dodecahedron
nuclear@0 108 *
nuclear@0 109 * @param positions Receives output triangles
nuclear@0 110 * @param polygons If you pass true here pentagons will be returned
nuclear@0 111 * @return Number of vertices per face
nuclear@0 112 */
nuclear@0 113 static unsigned int MakeDodecahedron(
nuclear@0 114 std::vector<aiVector3D>& positions,
nuclear@0 115 bool polygons = false);
nuclear@0 116
nuclear@0 117
nuclear@0 118 // ----------------------------------------------------------------
nuclear@0 119 /** @brief Generates an octahedron
nuclear@0 120 *
nuclear@0 121 * @param positions Receives output triangles.
nuclear@0 122 * @return Number of vertices per face
nuclear@0 123 */
nuclear@0 124 static unsigned int MakeOctahedron(
nuclear@0 125 std::vector<aiVector3D>& positions);
nuclear@0 126
nuclear@0 127
nuclear@0 128 // ----------------------------------------------------------------
nuclear@0 129 /** @brief Generates a tetrahedron
nuclear@0 130 *
nuclear@0 131 * @param positions Receives output triangles.
nuclear@0 132 * @return Number of vertices per face
nuclear@0 133 */
nuclear@0 134 static unsigned int MakeTetrahedron(
nuclear@0 135 std::vector<aiVector3D>& positions);
nuclear@0 136
nuclear@0 137
nuclear@0 138
nuclear@0 139 // ----------------------------------------------------------------
nuclear@0 140 /** @brief Generates a sphere
nuclear@0 141 *
nuclear@0 142 * @param tess Number of subdivions - 0 generates a octahedron
nuclear@0 143 * @param positions Receives output triangles.
nuclear@0 144 */
nuclear@0 145 static void MakeSphere(unsigned int tess,
nuclear@0 146 std::vector<aiVector3D>& positions);
nuclear@0 147
nuclear@0 148
nuclear@0 149 // ----------------------------------------------------------------
nuclear@0 150 /** @brief Generates a cone or a cylinder, either open or closed.
nuclear@0 151 *
nuclear@0 152 * @code
nuclear@0 153 *
nuclear@0 154 * |-----| <- radius 1
nuclear@0 155 *
nuclear@0 156 * __x__ <- ] ^
nuclear@0 157 * / \ | height |
nuclear@0 158 * / \ | Y
nuclear@0 159 * / \ |
nuclear@0 160 * / \ |
nuclear@0 161 * /______x______\ <- ] <- end cap
nuclear@0 162 *
nuclear@0 163 * |-------------| <- radius 2
nuclear@0 164 *
nuclear@0 165 * @endcode
nuclear@0 166 *
nuclear@0 167 * @param height Height of the cone
nuclear@0 168 * @param radius1 First radius
nuclear@0 169 * @param radius2 Second radius
nuclear@0 170 * @param tess Number of triangles.
nuclear@0 171 * @param bOpened true for an open cone/cylinder. An open shape has
nuclear@0 172 * no 'end caps'
nuclear@0 173 * @param positions Receives output triangles
nuclear@0 174 */
nuclear@0 175 static void MakeCone(float height,float radius1,
nuclear@0 176 float radius2,unsigned int tess,
nuclear@0 177 std::vector<aiVector3D>& positions,bool bOpen= false);
nuclear@0 178
nuclear@0 179
nuclear@0 180 // ----------------------------------------------------------------
nuclear@0 181 /** @brief Generates a flat circle
nuclear@0 182 *
nuclear@0 183 * The circle is constructed in the planed formed by the x,z
nuclear@0 184 * axes of the cartesian coordinate system.
nuclear@0 185 *
nuclear@0 186 * @param radius Radius of the circle
nuclear@0 187 * @param tess Number of segments.
nuclear@0 188 * @param positions Receives output triangles.
nuclear@0 189 */
nuclear@0 190 static void MakeCircle(float radius, unsigned int tess,
nuclear@0 191 std::vector<aiVector3D>& positions);
nuclear@0 192
nuclear@0 193 };
nuclear@0 194 } // ! Assimp
nuclear@0 195
nuclear@0 196 #endif // !! AI_STANDARD_SHAPES_H_INC