7.6 Mapping schema

7.6.1 Overview

This is the documentation about the JSON schema file. The actual file is located in the ASAM OpenMATERIAL 3D GitHub repository.

The following diagram shows the hierarchy of the fields defined in this schema. Fields marked with (R) are required. A field can be optional while some of its children are required. In that case, the required children only have to be filled in if the optional parent field is present.

Diagram

7.6.2 metadata

The key meta information about the mapping table, including its identity, authorship, technical specifications, and legal details.

Type: object
Required: Yes

7.6.2.1 name

The display name of the material mapping table.

Type: string
Required: Yes

7.6.2.2 description

Short description of the mapping table in two to three sentences.

Type: string
Required: No

7.6.2.3 uuid

Universally unique identifier for the mapping table in 8-4-4-4-12 format, see [12]. The uuid stays the same, even if version is updated.

Type: string
Pattern: \b[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\b$
Required: Yes

7.6.2.4 mappingVersion

The version number of the mapping table, following semantic versioning (for example, '1.0.0').

Type: string
Pattern: ^\d+\.\d+\.\d+$
Required: Yes

7.6.2.5 openMaterial3dVersion

The version of the ASAM OpenMATERIAL 3D specification used, adhering to semantic versioning (for example, '1.0.0').

Type: string
Pattern: ^\d+\.\d+\.\d+$
Required: Yes

7.6.2.6 copyrights

Indicates copyright details, including the year and copyright holder (for example, '© 2024 ACME Inc.').

Type: array
Item count: at least 1
Item type: string
Required: Yes

7.6.2.7 license

Describes the license for mapping table distribution. Use an SPDX identifier for open-source licenses (for example, 'MIT'), or provide a URL or filename for proprietary licenses.

Type: string
Required: Yes

7.6.2.8 authors

Lists the author(s) of the mapping table as a name, email, or company.

Type: array
Item count: at least 1
Item type: string
Required: Yes

7.6.2.9 creationDate

The date and time of mapping table creation, formatted as YYYYMMDDTHHMMSSZ according to ISO 8601 [8] (for example, '20240703T101728Z').

Type: string
Pattern: ^\d{8}T\d{6}Z$
Required: No

7.6.3 materialMapping

Array containing material mappings.

Type: array
Required: Yes

Column count: exactly 3

Columns of the table:

Column Type Constraints Description

1

string

Material name or RGB code. The RGB code represents color values in an ASAM OpenMATERIAL 3D assignment texture. RGB codes are formatted as rgb:<R>;<G>;<B>. <R>, <G>, and <B> are integers in the range [0, 255].

2

string

.*\.xomp$

Relative or absolute file path to the material. For cross-platform compatibility, Unix-style paths are recommended.

3

string

Description of the material.