Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete linguistic review #304

Merged
merged 22 commits into from
Jan 21, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Continue review
Signed-off-by: FKlopfer <fabian.klopfer@parson-europe.com>
FKlopfer committed Jan 20, 2025
commit f502808998697013980396fe68659f6f5863d502
22 changes: 11 additions & 11 deletions content/general-docs/introduction.adoc
Original file line number Diff line number Diff line change
@@ -30,11 +30,11 @@ Standardization efforts have been made for scenarios and road data using ASAM Op

=== The two main chapters of {THIS_STANDARD}

{THIS_STANDARD} is divided into distinct yet complementary chapters enabling a modular approach to implementation. Key to this is the distinction between Material and Geometry. Based on specific use-cases, users of {THIS_STANDARD} can implement the standard for one or both chapters. At least one of the two chapters shall be implemented to conform with the standard.
{THIS_STANDARD} is divided into distinct yet complementary chapters enabling a modular approach to implementation. Key to this is the distinction between material and geometry. Based on specific use-cases, users of {THIS_STANDARD} can implement the standard for one or both chapters. At least one of the two chapters shall be implemented to conform with the standard.

* *Material*: This chapter 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. Tools or systems focusing on material properties can implement support for the Material chapter. For example: “This tool supports {THIS_STANDARD}: Material”.
* *Material*: This chapter 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. Tools or systems focusing on material properties can implement support for the material chapter. For example: “This tool supports {THIS_STANDARD}: Material”.

* *Geometry*: This chapter contains structures for different object classes. These structures define uniform node structure, naming scheme and coordinate systems to enable exchange, common integration and animation of 3D models. Tools or systems working primarily with geometric data, such as 3D models or spatial structures, can implement support for the Geometry chapter. For example: “This tool supports {THIS_STANDARD}: Geometry”.
* *Geometry*: This chapter contains structures for different object classes. These structures define uniform node structure, naming scheme and coordinate systems to enable exchange, common integration and animation of 3D models. Tools or systems working primarily with geometric data, such as 3D models or spatial structures, can implement support for the geometry chapter. For example: “This tool supports {THIS_STANDARD}: Geometry”.

* *Full Compliance*: For a full exchange of simulation-ready 3D assets however, both chapters must be supported. Systems or tools providing full support for both material and geometric data can be described as follows: “This tool supports {THIS_STANDARD}”.

@@ -44,8 +44,8 @@ A list of use cases examples can be found in the https://asam-ev.github.io/OpenM

{THIS_STANDARD} 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[].
The definitions of the geometry related data formats marked in red can be found in the geometry chapter.
The definitions of the _material_ related data formats marked in blue can be found in the material chapter.

[#fig-openmaterial-overview]
.Overview of {THIS_STANDARD} file formats and data flow
@@ -55,7 +55,7 @@ The first interaction with an {THIS_STANDARD}-compliant _3D model_ is through th

The *asset file* is a JSON file with the file extension .xoma ({THIS_STANDARD} Asset).
A detailed definition of the https://github.com/asam-ev/OpenMATERIAL/blob/main/schemas/asset_schema.json[asset file JSON schema] is given in xref:geometry/asset-schema.adoc[].
The asset file shall have the same name as a corresponding 3D data file in glTF, FBX or USD format.
The asset file shall have the same name as a corresponding 3D data file in glTF, FBX, or USD format.
To facilitate instancing, multiple asset file may be linked to a single _3D model_ file by adding an index separated by a dot (.) as a suffix to the asset file name.
It contains metadata, such as description, unique identifier, version information, copyright details, and so on.
It also includes a _material_ texture assignment table, allowing dedicated _material_ mapping textures to be assigned to materials within 3D data files.
@@ -65,10 +65,10 @@ For the mapping currently only the rba channels are used (first 24 Bit).
The last channel is reserved for future use.
An https://github.com/asam-ev/OpenMATERIAL/tree/main/examples/example_asset.xoma[example asset] is provided in the examples folder of the repository.

The *3D data file* is a standard _3D model_ file in glTF, FBX or USD format.
The *3D data file* is a standard _3D model_ file in glTF, FBX, or USD format.
Multiple formats can exist in parallel, so one asset file can have multiple 3D data files with different formats with the same name as the asset file.
However, to be standard compliant, a simulation environment must support at least one of the named 3D data formats.
More information about the file formats is given in is given in xref:geometry/file-format-support.adoc[].
However, to be compliant with {THIS_STANDARD}, a simulation environment must support at least one of the named 3D data formats.
More information about the file formats is given in in xref:geometry/file-format-support.adoc[].
An https://github.com/asam-ev/OpenMATERIAL/tree/main/examples/example_asset.gltf[example model] is provided in the examples folder of the repository.

The *material mapping file* is separated from the asset file to facilitate reusability.
@@ -93,7 +93,7 @@ The defined look-up tables include:
* xref:material/material-emp-schema.adoc[Electromagnetic properties]
* xref:material/material-optical-schema.adoc[Optical properties]
* xref:material/material-brdf-schema.adoc[Bidirectional reflectance distribution functions (BRDFs)]
* xref:material/material-reflectance-schema.adoc[Reflectance table]
//* xref:material/material-reflectance-schema.adoc[Reflectance table]

Examples for _material property_ files and look-up table files are provided in the https://github.com/asam-ev/OpenMATERIAL/tree/main/examples/[examples folder] of the repository.

@@ -104,7 +104,7 @@ Examples for _material property_ files and look-up table files are provided in t

To ensure compliance with the {THIS_STANDARD} specification, users need to be able to distinguish between requirements, recommendations, permissions, possibilities and capabilities, and external constraints.

The following rules for using modal verbs apply:
The rules listed in <<tab-modal-verbs>> for using modal verbs apply:

[#tab-modal-verbs]
.Verbal forms for expressions of provisions
2 changes: 1 addition & 1 deletion content/index.adoc
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ This document is the copyrighted property of ASAM e.V.
In alteration to the regular https://www.asam.net/license[license terms], ASAM allows unrestricted distribution of this standard. §2 (1) of ASAM's regular https://www.asam.net/license[license terms] is therefore substituted by the following clause: "The licensor grants everyone a basic, non-exclusive and unlimited license to use the standard {THIS_STANDARD}".
====

ASAM OpenMATERIAL is a registered trade mark of ASAM e.V.
ASAM OpenMATERIAL 3D is a registered trademark of ASAM e.V.

//
// DO NOT CHANGE!!!