From ad457b9421e79331af4399150c678a624604d1b7 Mon Sep 17 00:00:00 2001 From: Richard Foligno Date: Mon, 2 Mar 2015 11:29:10 -0500 Subject: [PATCH] Cleaned up docs Updated the doc page to reflect the Readme and organized the page a little. --- index.html | 135 ++++++++++++++++++++++++----------------- stylesheets/styles.css | 23 ++++--- 2 files changed, 95 insertions(+), 63 deletions(-) diff --git a/index.html b/index.html index be1d720..4a8e36f 100644 --- a/index.html +++ b/index.html @@ -28,7 +28,6 @@
-

Tiny obj loader

@@ -38,95 +37,119 @@ Hosted on GitHub Pages — Theme by mattgraham
-

tinyobjloader

-

http://syoyo.github.io/tinyobjloader/

+

Tiny but poweful single file wavefront obj loader written in C++. No dependencies except for C++ STL. It can parse over 10M polygons with moderate memory and time.

-

Tiny but poweful single file wavefront obj loader written in C++. No dependency except for C++ STL. It can parse 10M over polygons with moderate memory and time.

+

A great .obj loader for embedding into your (global illumination) renderer ;-)

+ +

http://syoyo.github.io/tinyobjloader/

-

Good for embedding .obj loader to your (global illumination) renderer ;-)

+

Features

-

Example

+
    +
  • Groups
    • +
  • Indices
    • +
  • Vertices
    • +
  • Texcoords
    • +
  • Normals
    • +
  • Materials +
      +
    • Per-face materials.
      • +
    • Unknown material attributes are treated as key-value.
      • +
    +
    • +
+ +

Example

-

Rungholt

+

tinyobjloader can successfully load the Rungholt scene with 6M triangles.
-

tinyobjloader can successfully load 6M triangles Rungholt scene. -http://graphics.cs.williams.edu/data/meshes.xml

+ Source: http://graphics.cs.williams.edu/data/meshes.xml

+ +

Rungholt

-

Features

+

Usage

-
    -
  • Group
    • -
  • Vertex
    • -
  • Texcoord
    • -
  • Normal
    • -
  • Material - -
      -
    • Unknown material attributes are treated as key-value.
      • -
    -
    • -

Notes

- -

Polygon is converted into triangle.

- -

License

- -

Licensed under 2 clause BSD.

- -

Usage

+

First, load your mesh from file, storing the shapes and materials separately.

std::string inputfile = "cornell_box.obj";
-std::vector<tinyobj::shape_t> shapes;
+std::vector shapes;
+std::vector materials;
 
-std::string err = tinyobj::LoadObj(shapes, inputfile.c_str());
+std::string err = tinyobj::LoadObj(shapes, materials, inputfile.c_str());
 
 if (!err.empty()) {
-  std::cerr << err << std::endl;
+  std::cerr << err << std::endl;
   exit(1);
 }
 
-std::cout << "# of shapes : " << shapes.size() << std::endl;
+std::cout << "# of shapes    : " << shapes.size() << std::endl;
+std::cout << "# of materials : " << materials.size() << std::endl;
+
-for (size_t i = 0; i < shapes.size(); i++) { +

Now that you have loaded the shape and material data from file, you can iterate through each vector to get the information that you need.

+

Each shape will contain vertex indices, positions, normals, UV coordinates and per-face material IDs.

+ +
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());
+  printf("Size of shape[%ld].indices: %ld\n", i, shapes[i].mesh.indices.size());
+  printf("Size of shape[%ld].material_ids: %ld\n", i, shapes[i].mesh.material_ids.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]);
+  for (size_t f = 0; f < shapes[i].mesh.indices.size() / 3; f++) {
+    printf("  idx[%ld] = %d, %d, %d. mat_id = %d\n", f, shapes[i].mesh.indices[3*f+0], shapes[i].mesh.indices[3*f+1], shapes[i].mesh.indices[3*f+2], shapes[i].mesh.material_ids[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++) {
+  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()); +

The per-face material IDs can be used to reference the materials in the materials vector.

+ +
for (size_t i = 0; i < materials.size(); i++) {
+  printf("material[%ld].name = %s\n", i, materials[i].name.c_str());
+  printf("  material.Ka = (%f, %f ,%f)\n", materials[i].ambient[0], materials[i].ambient[1], materials[i].ambient[2]);
+  printf("  material.Kd = (%f, %f ,%f)\n", materials[i].diffuse[0], materials[i].diffuse[1], materials[i].diffuse[2]);
+  printf("  material.Ks = (%f, %f ,%f)\n", materials[i].specular[0], materials[i].specular[1], materials[i].specular[2]);
+  printf("  material.Tr = (%f, %f ,%f)\n", materials[i].transmittance[0], materials[i].transmittance[1], materials[i].transmittance[2]);
+  printf("  material.Ke = (%f, %f ,%f)\n", materials[i].emission[0], materials[i].emission[1], materials[i].emission[2]);
+  printf("  material.Ns = %f\n", materials[i].shininess);
+  printf("  material.Ni = %f\n", materials[i].ior);
+  printf("  material.dissolve = %f\n", materials[i].dissolve);
+  printf("  material.illum = %d\n", materials[i].illum);
+  printf("  material.map_Ka = %s\n", materials[i].ambient_texname.c_str());
+  printf("  material.map_Kd = %s\n", materials[i].diffuse_texname.c_str());
+  printf("  material.map_Ks = %s\n", materials[i].specular_texname.c_str());
+  printf("  material.map_Ns = %s\n", materials[i].normal_texname.c_str());
+  std::map::const_iterator it(materials[i].unknown_parameter.begin());
+  std::map::const_iterator itEnd(materials[i].unknown_parameter.end());
   for (; it != itEnd; it++) {
-    printf("  material.%s = %s\n", it->first.c_str(), it->second.c_str());
+    printf("  material.%s = %s\n", it->first.c_str(), it->second.c_str());
   }
   printf("\n");
-}
-
-
+} +

Notes

+ + + +
+

Licensed under 2 clause BSD.

+
+
+ diff --git a/stylesheets/styles.css b/stylesheets/styles.css index e7b4ffc..3d9cb2d 100644 --- a/stylesheets/styles.css +++ b/stylesheets/styles.css @@ -529,8 +529,8 @@ table { } body { - padding: 0px 0 20px 0px; - margin: 0px; + padding: 0; + margin: 0; font: 14px/1.5 "OpenSansRegular", "Helvetica Neue", Helvetica, Arial, sans-serif; color: #f0e7d5; font-weight: normal; @@ -605,7 +605,7 @@ strong { } .wrapper { - max-width: 650px; + max-width: 960px; margin: 0 auto; position: relative; padding: 0 20px; @@ -709,7 +709,7 @@ dt { box-shadow: 0px 1px 3px rgba(0, 0, 0, 0.25); } #header nav { - max-width: 650px; + max-width: 960px; margin: 0 auto; padding: 0 10px; background: blue; @@ -781,8 +781,8 @@ dt { } section { - max-width: 650px; - padding: 30px 0px 50px 0px; + max-width: 960px; + padding: 30px 0 0 0; margin: 20px 0; margin-top: 70px; } @@ -819,6 +819,10 @@ section #title .credits.left { section #title .credits.right { float: right; } +footer { + border-top: 2px solid #434343; + padding-top: 20px; +} @media print, screen and (max-width: 720px) { #title .credits { @@ -845,7 +849,12 @@ section #title .credits.right { margin-top: 40px; } - nav { + #header nav { + margin: 15px auto; + text-align: center; + } + + #header nav .downloads, #header nav .title { display: none; } }