]> git.lizzy.rs Git - minetest.git/blob - src/mesh.h
Document that write_json will error on unserializable types. (#5539)
[minetest.git] / src / mesh.h
1 /*
2 Minetest
3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
4
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
9
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 GNU Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifndef MESH_HEADER
21 #define MESH_HEADER
22
23 #include "irrlichttypes_extrabloated.h"
24 #include "nodedef.h"
25
26 /*!
27  * Applies shading to a color based on the surface's
28  * normal vector.
29  */
30 void applyFacesShading(video::SColor &color, const v3f &normal);
31
32 /*
33         Create a new cube mesh.
34         Vertices are at (+-scale.X/2, +-scale.Y/2, +-scale.Z/2).
35
36         The resulting mesh has 6 materials (up, down, right, left, back, front)
37         which must be defined by the caller.
38 */
39 scene::IAnimatedMesh* createCubeMesh(v3f scale);
40
41 /*
42         Multiplies each vertex coordinate by the specified scaling factors
43         (componentwise vector multiplication).
44 */
45 void scaleMesh(scene::IMesh *mesh, v3f scale);
46
47 /*
48         Translate each vertex coordinate by the specified vector.
49 */
50 void translateMesh(scene::IMesh *mesh, v3f vec);
51
52 /*
53         Set a constant color for all vertices in the mesh
54 */
55 void setMeshColor(scene::IMesh *mesh, const video::SColor &color);
56
57 void colorizeMeshBuffer(scene::IMeshBuffer *buf, const video::SColor *buffercolor);
58
59 /*
60         Set the color of all vertices in the mesh.
61         For each vertex, determine the largest absolute entry in
62         the normal vector, and choose one of colorX, colorY or
63         colorZ accordingly.
64 */
65 void setMeshColorByNormalXYZ(scene::IMesh *mesh,
66                 const video::SColor &colorX,
67                 const video::SColor &colorY,
68                 const video::SColor &colorZ);
69
70 void setMeshColorByNormal(scene::IMesh *mesh, const v3f &normal,
71                 const video::SColor &color);
72
73 /*
74         Rotate the mesh by 6d facedir value.
75         Method only for meshnodes, not suitable for entities.
76 */
77 void rotateMeshBy6dFacedir(scene::IMesh *mesh, int facedir);
78
79 /*
80         Rotate the mesh around the axis and given angle in degrees.
81 */
82 void rotateMeshXYby (scene::IMesh *mesh, f64 degrees);
83 void rotateMeshXZby (scene::IMesh *mesh, f64 degrees);
84 void rotateMeshYZby (scene::IMesh *mesh, f64 degrees); 
85  
86 /*
87         Clone the mesh.
88 */
89 scene::IMesh* cloneMesh(scene::IMesh *src_mesh);
90
91 /*
92         Convert nodeboxes to mesh. Each tile goes into a different buffer.
93         boxes - set of nodeboxes to be converted into cuboids
94         uv_coords[24] - table of texture uv coords for each cuboid face
95         expand - factor by which cuboids will be resized
96 */
97 scene::IMesh* convertNodeboxesToMesh(const std::vector<aabb3f> &boxes,
98                 const f32 *uv_coords = NULL, float expand = 0);
99
100 /*
101         Update bounding box for a mesh.
102 */
103 void recalculateBoundingBox(scene::IMesh *src_mesh);
104
105 /*
106         Vertex cache optimization according to the Forsyth paper:
107         http://home.comcast.net/~tom_forsyth/papers/fast_vert_cache_opt.html
108         Ported from irrlicht 1.8
109 */
110 scene::IMesh* createForsythOptimizedMesh(const scene::IMesh *mesh);
111
112 #endif