summaryrefslogtreecommitdiff
path: root/examples/ThirdPartyLibs/Wavefront/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'examples/ThirdPartyLibs/Wavefront/README.md')
-rw-r--r--examples/ThirdPartyLibs/Wavefront/README.md143
1 files changed, 97 insertions, 46 deletions
diff --git a/examples/ThirdPartyLibs/Wavefront/README.md b/examples/ThirdPartyLibs/Wavefront/README.md
index 6f911e523..de226acd3 100644
--- a/examples/ThirdPartyLibs/Wavefront/README.md
+++ b/examples/ThirdPartyLibs/Wavefront/README.md
@@ -38,51 +38,102 @@ Licensed under 2 clause BSD.
Usage
-----
+Data format
+attrib_t contains single and linear array of vertex data(position, normal and texcoord).
- std::string inputfile = "cornell_box.obj";
- std::vector<tinyobj::shape_t> shapes;
-
- std::string err = tinyobj::LoadObj(shapes, inputfile.c_str());
-
- if (!err.empty()) {
- std::cerr << err << std::endl;
- exit(1);
- }
-
- std::cout << "# of shapes : " << shapes.size() << std::endl;
-
- for (size_t i = 0; i < shapes.size(); i++) {
- printf("shape[%ld].name = %s\n", i, shapes[i].name.c_str());
- printf("shape[%ld].indices: %ld\n", i, shapes[i].mesh.indices.size());
- assert((shapes[i].mesh.indices.size() % 3) == 0);
- for (size_t f = 0; f < shapes[i].mesh.indices.size(); f++) {
- printf(" idx[%ld] = %d\n", f, shapes[i].mesh.indices[f]);
- }
-
- printf("shape[%ld].vertices: %ld\n", i, shapes[i].mesh.positions.size());
- assert((shapes[i].mesh.positions.size() % 3) == 0);
- for (size_t v = 0; v < shapes[i].mesh.positions.size() / 3; v++) {
- printf(" v[%ld] = (%f, %f, %f)\n", v,
- shapes[i].mesh.positions[3*v+0],
- shapes[i].mesh.positions[3*v+1],
- shapes[i].mesh.positions[3*v+2]);
- }
-
- printf("shape[%ld].material.name = %s\n", i, shapes[i].material.name.c_str());
- printf(" material.Ka = (%f, %f ,%f)\n", shapes[i].material.ambient[0], shapes[i].material.ambient[1], shapes[i].material.ambient[2]);
- printf(" material.Kd = (%f, %f ,%f)\n", shapes[i].material.diffuse[0], shapes[i].material.diffuse[1], shapes[i].material.diffuse[2]);
- printf(" material.Ks = (%f, %f ,%f)\n", shapes[i].material.specular[0], shapes[i].material.specular[1], shapes[i].material.specular[2]);
- printf(" material.Tr = (%f, %f ,%f)\n", shapes[i].material.transmittance[0], shapes[i].material.transmittance[1], shapes[i].material.transmittance[2]);
- printf(" material.Ke = (%f, %f ,%f)\n", shapes[i].material.emission[0], shapes[i].material.emission[1], shapes[i].material.emission[2]);
- printf(" material.Ns = %f\n", shapes[i].material.shininess);
- printf(" material.map_Ka = %s\n", shapes[i].material.ambient_texname.c_str());
- printf(" material.map_Kd = %s\n", shapes[i].material.diffuse_texname.c_str());
- printf(" material.map_Ks = %s\n", shapes[i].material.specular_texname.c_str());
- printf(" material.map_Ns = %s\n", shapes[i].material.normal_texname.c_str());
- std::map<std::string, std::string>::iterator it(shapes[i].material.unknown_parameter.begin());
- std::map<std::string, std::string>::iterator itEnd(shapes[i].material.unknown_parameter.end());
- for (; it != itEnd; it++) {
- printf(" material.%s = %s\n", it->first.c_str(), it->second.c_str());
- }
- printf("\n");
+attrib_t::vertices => 3 floats per vertex
+
+ v[0] v[1] v[2] v[3] v[n-1]
+ +-----------+-----------+-----------+-----------+ +-----------+
+ | x | y | z | x | y | z | x | y | z | x | y | z | .... | x | y | z |
+ +-----------+-----------+-----------+-----------+ +-----------+
+
+attrib_t::normals => 3 floats per vertex
+
+ n[0] n[1] n[2] n[3] n[n-1]
+ +-----------+-----------+-----------+-----------+ +-----------+
+ | x | y | z | x | y | z | x | y | z | x | y | z | .... | x | y | z |
+ +-----------+-----------+-----------+-----------+ +-----------+
+
+attrib_t::texcoords => 2 floats per vertex
+
+ t[0] t[1] t[2] t[3] t[n-1]
+ +-----------+-----------+-----------+-----------+ +-----------+
+ | u | v | u | v | u | v | u | v | .... | u | v |
+ +-----------+-----------+-----------+-----------+ +-----------+
+
+attrib_t::colors => 3 floats per vertex(vertex color. optional)
+
+ c[0] c[1] c[2] c[3] c[n-1]
+ +-----------+-----------+-----------+-----------+ +-----------+
+ | x | y | z | x | y | z | x | y | z | x | y | z | .... | x | y | z |
+ +-----------+-----------+-----------+-----------+ +-----------+
+
+Each shape_t::mesh_t does not contain vertex data but contains array index to attrib_t. See loader_example.cc for more details.
+
+
+mesh_t::indices => array of vertex indices.
+
+ +----+----+----+----+----+----+----+----+----+----+ +--------+
+ | i0 | i1 | i2 | i3 | i4 | i5 | i6 | i7 | i8 | i9 | ... | i(n-1) |
+ +----+----+----+----+----+----+----+----+----+----+ +--------+
+
+Each index has an array index to attrib_t::vertices, attrib_t::normals and attrib_t::texcoords.
+
+mesh_t::num_face_vertices => array of the number of vertices per face(e.g. 3 = triangle, 4 = quad , 5 or more = N-gons).
+
+
+ +---+---+---+ +---+
+ | 3 | 4 | 3 | ...... | 3 |
+ +---+---+---+ +---+
+ | | | |
+ | | | +-----------------------------------------+
+ | | | |
+ | | +------------------------------+ |
+ | | | |
+ | +------------------+ | |
+ | | | |
+ |/ |/ |/ |/
+
+ mesh_t::indices
+
+ | face[0] | face[1] | face[2] | | face[n-1] |
+ +----+----+----+----+----+----+----+----+----+----+ +--------+--------+--------+
+ | i0 | i1 | i2 | i3 | i4 | i5 | i6 | i7 | i8 | i9 | ... | i(n-3) | i(n-2) | i(n-1) |
+ +----+----+----+----+----+----+----+----+----+----+ +--------+--------+--------+
+
+```c++
+#define TINYOBJLOADER_IMPLEMENTATION // define this in only *one* .cc
+#include "tiny_obj_loader.h"
+
+std::string inputfile = "cornell_box.obj";
+tinyobj::attrib_t attrib;
+std::vector<tinyobj::shape_t> shapes;
+
+LoadObj(attrib, shapes, inputfile.c_str());
+
+// Loop over shapes
+for (size_t s = 0; s < shapes.size(); s++) {
+ // Loop over faces(polygon)
+ size_t index_offset = 0;
+ for (size_t f = 0; f < shapes[s].mesh.indices.size(); f++) {
+ int fv = 3;
+ // Loop over vertices in the face.
+ for (size_t v = 0; v < fv; v++) {
+ // access to vertex
+ tinyobj::index_t idx = shapes[s].mesh.indices[index_offset + v];
+ tinyobj::real_t vx = attrib.vertices[3*idx.vertex_index+0];
+ tinyobj::real_t vy = attrib.vertices[3*idx.vertex_index+1];
+ tinyobj::real_t vz = attrib.vertices[3*idx.vertex_index+2];
+ tinyobj::real_t nx = attrib.normals[3*idx.normal_index+0];
+ tinyobj::real_t ny = attrib.normals[3*idx.normal_index+1];
+ tinyobj::real_t nz = attrib.normals[3*idx.normal_index+2];
+ tinyobj::real_t tx = attrib.texcoords[2*idx.texcoord_index+0];
+ tinyobj::real_t ty = attrib.texcoords[2*idx.texcoord_index+1];
}
+ index_offset += fv;
+ }
+}
+
+```
+