7.5 Asset schema
7.5.1 metadata
The key meta information about the asset, including its identity, authorship, technical specifications, and legal details.
Type: object
Required: Yes
7.5.1.1 name
The display name of the asset, such as 'Car Model A' or 'Urban Scene 1'.
Type: string
Required: Yes
7.5.1.2 description
A concise summary of the asset’s purpose or features (2-3 sentences).
Type: string
Required: No
7.5.1.3 uuid
Universally unique identifier for the asset in 8-4-4-4-12 format, see en.wikipedia.org/wiki/Universally_unique_identifier. 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.5.1.4 assetVersion
The version number of the asset, following semantic versioning (e.g., '1.0.0').
Type: string
Pattern: ^\\d+\\.\\d+\\.\\d+$
Required: Yes
7.5.1.5 openMaterialVersion
The version of the OpenMATERIAL 3D specification used, adhering to semantic versioning (e.g., '1.0.0').
Type: string
Pattern: ^\\d+\\.\\d+\\.\\d+$
Required: Yes
7.5.1.6 copyright
Indicates copyright details, including the year and copyright holder (e.g., '© 2024 ACME Inc.').
Type: string
Required: Yes
7.5.1.7 license
Describes the license for asset distribution. Use an SPDX identifier for open-source licenses (e.g., 'MIT'), or provide a URL or filename for proprietary licenses.
Type: string
Required: Yes
7.5.1.8 author
Lists the author(s) of the asset as a name, email, or company. Multiple authors should be comma-separated.
Type: string
Required: Yes
7.5.1.9 modelCreationTool
Specifies the software or tool (and version) used to create the 3D model (e.g., 'Blender 3.5').
Type: string
Required: No
7.5.1.10 creationDate
The date and time of asset creation, formatted as YYYYMMDDTHHMMSSZ according to ISO 8601 (e.g., '20240703T101728Z').
Type: string
Pattern: ^\\d{8}T\\d{6}Z$
Required: No
7.5.1.11 modelingMethod
Indicates how the model was created, e.g., '3D scan', 'photo-based modeling', or 'freehand design'.
Type: string
Required: No
7.5.1.12 validationDescription
Details the validation process used to compare the model geometry with real-world objects.
Type: string
Required: No
7.5.1.13 assetType
Specifies whether the asset represents an individual object ('object') or a collection of objects ('scene').
Type: string
Enum: ['object', 'scene']
Required: Yes
7.5.1.14 objectClass
Classifies the object type when 'assetType' is 'object', i.e., 'vehicle', 'human', 'environment', 'other'.
Type: string
Enum: ['vehicle', 'human', 'environment', 'other']
Required: Yes
7.5.1.15 vehicleClassData
Vehicle specific data. This SHALL be filled if 'objectClass' is 'vehicle' based on the OpenSCENARIO vehicle definition.
Type: object
Required: No
7.5.1.15.1 vehicleCategory
Type of the vehicle.
Type: string
Enum: ['car', 'van', 'truck', 'trailer', 'semitrailer', 'bus', 'motorbike', 'bicycle', 'train', 'tram']
Required: Yes
7.5.1.15.2 performance
Performance values of a vehicle.
Type: object
Required: Yes
7.5.1.15.3 axles
A set of the axles of a vehicle. A vehicle must have a front axle and a rear axle. It might have additional axles.
Type: object
Required: Yes
frontAxle
The definition of vehicle axle. based on the OpenSCENARIO vehicle axle definition.
Type: object
Required: Yes
maxSteering
Maximum steering angle which can be performed by the wheels on this axle. Unit: rad; Range: [0;PI], symmetrical.
Type: number
Required: Yes
wheelDiameter
Diameter of the wheels on this axle. Unit: meter; Range: ]0..inf[.
Type: number
Required: Yes
trackWidth
Distance of the wheels center lines at zero steering. Unit: meter; Range: [0..inf[.
Type: number
Required: Yes
rearAxle
The definition of vehicle axle. based on the OpenSCENARIO vehicle axle definition.
Type: object
Required: Yes
maxSteering
Maximum steering angle which can be performed by the wheels on this axle. Unit: rad; Range: [0;PI], symmetrical.
Type: number
Required: Yes
wheelDiameter
Diameter of the wheels on this axle. Unit: meter; Range: ]0..inf[.
Type: number
Required: Yes
trackWidth
Distance of the wheels center lines at zero steering. Unit: meter; Range: [0..inf[.
Type: number
Required: Yes
additionalAxles
An optional array of additional axles with the same properties as frontAxle and rearAxle.
Type: array
Required: No
The definition of vehicle axle. based on the OpenSCENARIO vehicle axle definition.
7.5.1.16 humanClassData
Human specific data. This SHALL be filled if 'objectClass' is 'human' based on the OpenSCENARIO pedestrian definition.
Type: object
Required: No
7.5.1.17 animated
Indicates whether the 3D model contains keyframe animations.
Type: boolean
Required: Yes
7.5.1.18 pbrMaterialWorkflow
Indicates the usage of a Physically Based Rendering (PBR) material workflow as 'metallic', 'specular' or 'none'. This only applies to the internal materials of the 3D model file, not to mapped OpenMATERIAL 3D property files.
Type: string
Enum: ['metallic', 'specular', 'none']
Required: Yes
7.5.1.19 triangleCount
The total number of triangles in the model. A quad polygon counts as two triangles.
Type: integer
Required: Yes
7.5.1.20 meshCount
The total number of meshes in the 3D geometry. A model geometry typically consists of several sub-meshes.
Type: integer
Required: Yes
7.5.1.21 textureResolutions
Lists all the used texture resolutions in the 3D model i.e. albedo, normal or displacement textures. Possible values are '1K', '2K', '4K'. If no textures are used in the model, add empty element ''
Type: array
Required: Yes
Items enum: ['1K', '2K', '4K', '']
7.5.1.22 normalMapFormat
Specifies whether the 3D model utilizes normal maps as textures. If so, their format should be either 'DirectX' or 'OpenGL'.
Type: string
Enum: ['DirectX', 'OpenGL', 'none']
Required: Yes
7.5.2 materialMappingUri
Relative path to a material mapping file (.xomm). In this file, material names from the 3D model file or texture color codes from textures assigned in materialTextureAssignment are linked to OpenMATERIAL 3D property files.
Type: string
Pattern: .*\\.xomm$
Required: No
7.5.3 materialTextureAssignment
Optional array containing material texture assignments. It links material names contained in the 3D model file to OpenMATERIAL 3D assignment textures. In a separate material mapping file, the 'color' values in this texture are linked to OpenMATERIAL 3D property files.
Type: array
Required: No
Columns of the table:
-
Column 1: Name of the material in the 3D model file.
-
Column 2: File path to the OpenMATERIAL 3D assignment texture. Supported texture formats are png and jpg.