UV MAPS Tutorial (#3538)

* UV MAPS tutorial added * Add code snippets to go with image examples --------- Co-authored-by: Rene Sepulveda <errissa@gmail.com>
isl-org · Feb 20, 2023 · dd69a8f · dd69a8f
1 parent 51deb93
commit dd69a8f
Show file tree

Hide file tree

Showing 26 changed files with 182 additions and 0 deletions.
diff --git a/docs/_static/geometry/uvmaps/uv1.png b/docs/_static/geometry/uvmaps/uv1.png
diff --git a/docs/_static/geometry/uvmaps/uv10.png b/docs/_static/geometry/uvmaps/uv10.png
diff --git a/docs/_static/geometry/uvmaps/uv11.png b/docs/_static/geometry/uvmaps/uv11.png
diff --git a/docs/_static/geometry/uvmaps/uv12.png b/docs/_static/geometry/uvmaps/uv12.png
diff --git a/docs/_static/geometry/uvmaps/uv13.png b/docs/_static/geometry/uvmaps/uv13.png
diff --git a/docs/_static/geometry/uvmaps/uv14.png b/docs/_static/geometry/uvmaps/uv14.png
diff --git a/docs/_static/geometry/uvmaps/uv15.png b/docs/_static/geometry/uvmaps/uv15.png
diff --git a/docs/_static/geometry/uvmaps/uv16.png b/docs/_static/geometry/uvmaps/uv16.png
diff --git a/docs/_static/geometry/uvmaps/uv17.png b/docs/_static/geometry/uvmaps/uv17.png
diff --git a/docs/_static/geometry/uvmaps/uv18.png b/docs/_static/geometry/uvmaps/uv18.png
diff --git a/docs/_static/geometry/uvmaps/uv19.png b/docs/_static/geometry/uvmaps/uv19.png
diff --git a/docs/_static/geometry/uvmaps/uv2.png b/docs/_static/geometry/uvmaps/uv2.png
diff --git a/docs/_static/geometry/uvmaps/uv20.png b/docs/_static/geometry/uvmaps/uv20.png
diff --git a/docs/_static/geometry/uvmaps/uv21.png b/docs/_static/geometry/uvmaps/uv21.png
diff --git a/docs/_static/geometry/uvmaps/uv22.png b/docs/_static/geometry/uvmaps/uv22.png
diff --git a/docs/_static/geometry/uvmaps/uv23.png b/docs/_static/geometry/uvmaps/uv23.png
diff --git a/docs/_static/geometry/uvmaps/uv24.png b/docs/_static/geometry/uvmaps/uv24.png
diff --git a/docs/_static/geometry/uvmaps/uv25.png b/docs/_static/geometry/uvmaps/uv25.png
diff --git a/docs/_static/geometry/uvmaps/uv3.png b/docs/_static/geometry/uvmaps/uv3.png
diff --git a/docs/_static/geometry/uvmaps/uv4.png b/docs/_static/geometry/uvmaps/uv4.png
diff --git a/docs/_static/geometry/uvmaps/uv5.png b/docs/_static/geometry/uvmaps/uv5.png
diff --git a/docs/_static/geometry/uvmaps/uv6.png b/docs/_static/geometry/uvmaps/uv6.png
diff --git a/docs/_static/geometry/uvmaps/uv7.png b/docs/_static/geometry/uvmaps/uv7.png
diff --git a/docs/_static/geometry/uvmaps/uv8.png b/docs/_static/geometry/uvmaps/uv8.png
diff --git a/docs/_static/geometry/uvmaps/uv9.png b/docs/_static/geometry/uvmaps/uv9.png
diff --git a/docs/tutorial/geometry/uvmaps.rst b/docs/tutorial/geometry/uvmaps.rst
@@ -0,0 +1,182 @@
+UV Maps
+##########################
+
+UV Maps
+--------------------
+
+********************
+What is a UV Map ?
+********************
+
+[Ref: `Wikipedia <https://en.wikipedia.org/wiki/UV_mapping>`_] UV mapping is the 3D modeling process of projecting a 2D image to a 3D model's surface for texture mapping. The letters "U" and "V" denote the axes of the 2D texture because "X", "Y", and "Z" are already used to denote the axes of the 3D object in model space.
+UV texturing permits polygons that make up a 3D object to be painted with color (and other surface attributes) from an ordinary image. The image is called a UV texture map.
+
+*****************************
+How to add custom UV maps ?
+*****************************
+
+* UV Map coordinates ``(U, V)`` are stored as ``std::vector<Eigen::Vector2d>`` of length ``3 x number of triangles``. So, there is a set of 3 (U, V) coordinates for each triangle, each associated with it's vertices.
+* One may assume the UV map, maps a texture image of height and width of length 1.0 to the geometry. So, the range of U and V is from 0.0 to 1.0 (both inclusive).
+
+
+Quick Reference to default UV Maps for some primitive shapes provided by Open3D
+--------------------------------------------------------------------------------
+
+The examples below all assume the following code preamble:
+
+.. code_block:: python
+    import open3d as o3d
+    import open3d.visualization.rendering as rendering
+
+    material = rendering.MaterialRecord()
+    material.shader = 'defaultUnlit'
+    material.albedo_img = o3d.io.read_image('/Users/renes/Downloads/uv1.png')
+
+
+*****************************
+Example Texture Map
+*****************************
+
+.. image:: ../../_static/geometry/uvmaps/uv1.png
+    :width: 200px
+    :align: center
+
+************************************
+Box (map uv to each face = false) 
+************************************
+
+.. code_block:: python
+    box = o3d.geometry.TriangleMesh.create_box(create_uv_map=True)
+    o3d.visualization.draw({'name': 'box', 'geometry': box, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv2.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv3.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv4.png
+    :width: 200px
+
+**************************************
+Box (map uv to each face = true)
+**************************************
+
+.. code_block:: python
+    box = o3d.geometry.TriangleMesh.create_box(create_uv_map=True, map_texture_to_each_face=True)
+    o3d.visualization.draw({'name': 'box', 'geometry': box, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv5.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv6.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv7.png
+    :width: 200px
+
+
+*************
+Tetrahedral
+*************
+
+.. code_block:: python
+    tetra = o3d.geometry.TriangleMesh.create_tetrahedron(create_uv_map=True)
+    o3d.visualization.draw({'name': 'tetrahedron', 'geometry': tetra, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv8.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv9.png
+    :width: 200px
+
+
+.. image:: ../../_static/geometry/uvmaps/uv10.png
+    :width: 200px
+
+***************
+Octahedral
+***************
+
+.. code_block:: python
+    octo = o3d.geometry.TriangleMesh.create_octahedron(create_uv_map=True)
+    o3d.visualization.draw({'name': 'octahedron', 'geometry': octo, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv11.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv12.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv13.png
+    :width: 200px
+
+**************
+Icosahedron
+**************
+
+.. code_block:: python
+    ico = o3d.geometry.TriangleMesh.create_icosahedron(create_uv_map=True)
+    o3d.visualization.draw({'name': 'icosahedron', 'geometry': ico, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv14.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv15.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv16.png
+    :width: 200px
+
+*************
+Cylinder
+*************
+
+.. code_block:: python
+    cylinder = o3d.geometry.TriangleMesh.create_cylinder(create_uv_map=True)
+    o3d.visualization.draw({'name': 'cylinder', 'geometry': cylinder, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv17.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv18.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv19.png
+    :width: 200px
+
+*******
+Cone
+*******
+
+.. code_block:: python
+    cone = o3d.geometry.TriangleMesh.create_cone(create_uv_map=True)
+    o3d.visualization.draw({'name': 'cone', 'geometry': cone, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv20.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv21.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv22.png
+    :width: 200px
+
+*******
+Sphere
+*******
+
+.. code_block:: python
+    sphere = o3d.geometry.TriangleMesh.create_sphere(create_uv_map=True)
+    o3d.visualization.draw({'name': 'sphere', 'geometry': sphere, 'material': material})
+
+.. image:: ../../_static/geometry/uvmaps/uv23.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv24.png
+    :width: 200px
+
+.. image:: ../../_static/geometry/uvmaps/uv25.png
+    :width: 200px
+
+