Merge pull request #175 from asam-ev/173-remove-alpha-channel-from-fi…

…le-structure-overview-in-introduction Fix overview
asam-ev · Nov 15, 2024 · 2f85d5e · 2f85d5e
2 parents 22c8c98 + 0ac04aa
commit 2f85d5e
Show file tree

Hide file tree

Showing 11 changed files with 38 additions and 6 deletions.
diff --git a/content/_images/openmaterial_overview.png b/content/_images/openmaterial_overview.png
diff --git a/content/_images/overview.png b/content/_images/overview.png
diff --git a/content/_images/overview_geometry.png b/content/_images/overview_geometry.png
diff --git a/content/_images/overview_material.png b/content/_images/overview_material.png
diff --git a/content/general-docs/introduction.adoc b/content/general-docs/introduction.adoc
@@ -33,14 +33,20 @@ ASAM OpenMATERIAL consists of two main parts:
 * *Material*: This part includes definitions and file formats for storing and exchanging material properties. These properties can be physical, such as surface roughness, permittivity, and index of refraction, or measured data, like wavelength and angle-dependent reflectance values.
 * *Geometry*: This part contains node hierarchies for different object classes. These structures use a uniform naming scheme and coordinate definitions to enable the exchange of 3D models between various simulation systems.
 
+These two parts may be used independently.
+For example, a simulation tool may use the material definitions without supporting the geometry part, or the other way around.
+For a full exchange of simulation-ready 3D assets however, both parts must be supported.
+
 === Structure and file formats
 
 ASAM OpenMATERIAL defines various file formats for specifying assets, material properties, and the mapping between them.
 <<fig-openmaterial-overview>> illustrates these file formats and their interconnections.
+The definitions of the geometry related data formats marked in red can be found in xref:geometry/geometry-index.adoc[].
+The definitions of the material related data formats marked in blue can be found in xref:material/material-index.adoc[].
 
 [#fig-openmaterial-overview]
 .Overview of ASAM OpenMATERIAL file formats and data flow
-image::openmaterial_overview.png[,1100]
+image::overview.png[,1100]
 
 The first interaction with an ASAM OpenMATERIAL-compliant 3D model is through the asset file.
 

diff --git a/content/geometry/introduction.adoc b/content/geometry/introduction.adoc
@@ -1,5 +1,12 @@
 = Introduction
 
+ifndef::include-only-once[]
+:root-path: ../
+:imagesdir: {root-path}/_images
+:includedir: {root-path}/_images
+include::{root-path}_config.adoc[]
+endif::[]
+
 == Motivation
 
 A 3D asset is a digital entity that includes a 3D geometric representation of an object along with its attributes and metadata. 
@@ -8,11 +15,17 @@ Common formats for storing the geometry and visual materials of 3D models includ
 However, these formats do not provide a standardized way to structure the geometry or provide extensive metadata storage and exchange capabilities. 
 The ASAM OpenMATERIAL standard addresses these needs.
 
+This chapter includes all geometry related definitions of ASAM OpenMATERIAL, marked in red in <<fig-openmaterial-geometry-overview>>.
+
 The ASAM OpenMATERIAL asset file (for example, "omg_my-model.xoma") contains essential information relevant to the display and interactivity attributes of the 3D model in various computer applications.
 This includes metadata, material mappings, and semantic information like coordinate system and pivot point descriptions.
 The mapping of materials is stored in a separate material mapping file (.xomm), which is linked in the asset file.
 This setup ensures that the 3D asset can be consistently integrated into complex simulations or real-time environments with detailed material and dynamic properties.
 
+[#fig-openmaterial-geometry-overview]
+.Overview of ASAM OpenMATERIAL Geometry file formats and data flow
+image::overview_geometry.png[,1100]
+
 
 == Use cases
 

diff --git a/content/index.adoc b/content/index.adoc
@@ -44,7 +44,6 @@ include::geometry/asset-schema.adoc[leveloffset=+1]
 include::geometry/mapping-schema.adoc[leveloffset=+1]
 = Material
 include::material/introduction.adoc[leveloffset=+1]
-include::material/file-structure.adoc[leveloffset=+1]
 include::material/material-schema.adoc[leveloffset=+1]
 include::material/material-emp-schema.adoc[leveloffset=+1]
 include::material/material-optical-schema.adoc[leveloffset=+1]

diff --git a/content/material/file-structure.adoc b/content/material/file-structure.adoc
diff --git a/content/material/introduction.adoc b/content/material/introduction.adoc
@@ -1 +1,16 @@
-= Introduction
+= Introduction
+
+ifndef::include-only-once[]
+:root-path: ../
+:imagesdir: {root-path}/_images
+:includedir: {root-path}/_images
+include::{root-path}_config.adoc[]
+endif::[]
+
+This chapter includes all material related definitions of ASAM OpenMATERIAL, marked in red in <<fig-openmaterial-material-overview>>.
+
+[#fig-openmaterial-material-overview]
+.Overview of ASAM OpenMATERIAL Material file formats and data flow
+image::overview_material.png[,1100]
+
+NOTE: Further introduction t.b.d.
diff --git a/content/material/material-index.adoc b/content/material/material-index.adoc
@@ -1,6 +1,7 @@
 = Material
 
 * xref:material/introduction.adoc[leveloffset=+1]
-* xref:material/file-structure.adoc[leveloffset=+1]
 * xref:material/material-schema.adoc[leveloffset=+1]
 * xref:material/material-emp-schema.adoc[leveloffset=+1]
+* xref:material/material-optical-schema.adoc[leveloffset=+1]
+* xref:material/material-brdf-schema.adoc[leveloffset=+1]
diff --git a/content/nav-openmaterial.adoc b/content/nav-openmaterial.adoc
@@ -24,7 +24,6 @@
 ** xref:geometry/performance.adoc[]
 * xref:material/material-index.adoc[]
 ** xref:material/introduction.adoc[]
-** xref:material/file-structure.adoc[]
 ** xref:material/material-schema.adoc[]
 ** xref:material/material-emp-schema.adoc[]
 ** xref:material/material-optical-schema.adoc[]