Template: Conceptual Data Mapping Document#
Important
Template Version: 1.0.0
Last Update: 2024-09-18
You can download the Markdown for this conceptual data mapping document template to use as a starting point for your own document.
Introduction#
Overview#
Overview text
References#
This document has been prepared in reference to the software or specification versions listed below. Adjustments or considerations may need to be made for previous or future versions than those referenced in this document.
X Reference#
Version |
Reference Documents |
|---|---|
OpenUSD Reference#
Version |
Reference Documents |
|---|---|
24.08 |
OpenUSD C++ and Schema Documentation, OpenUSD Github Repository, USD Terms and Concepts |
General Assumptions and Constraints#
Explain if this document focuses only on One-Way mapping (X->OpenUSD) or Two-Way. Any decision that has a ripple effect on lots of concepts could be briefly noted here and then described in more detail in an Appendix (e.g. Transcoding). One advantage of utilizing Appendices in this way is that we can potentially explain a pattern once and reuse it in multiple Conceptual Data Mapping documents.
Definitions, Acronyms, Abbreviations#
Define terms used in this document. They could come from one of the source formats and be presented here for reader convenience. No need for establishing mappings for these in this table.
Term or Abbreviation |
Description |
|---|---|
scenegraph |
A data structure that organizes a graphical scene’s logical and spatial representation as a tree or graph of nodes. |
Concepts#
You can include introduction/overview text here. Then followed by a table showing high-level concept mappings. List all concepts from X even if there is no direct mapping or support for the feature in OpenUSD. If the concept doesn’t exist or map to OpenUSD, leave the OpenUSD cell blank and briefly explain in the Description.
Not required, but beneficial for Two-Way translation, also list all OpenUSD concepts even if there is no direct mapping or support for a feature in X. If the concept doesn’t exist or map to X, leave the X cell blank and briefly explain in the Description. You can link the OpenUSD cell to a drilldown section to explain the limitation in more detail.
X |
OpenUSD |
Description |
|---|---|---|
A brief description of the concept or comment on the mapping. More details in the drilldown. |
||
Feature is not supported in format X and should be documented as a limitation for Two-Way mapping. |
ConceptA#
Each high-level concept from the table should link to subsections like this one where you can go into more detail and then breakdown how you would encode this concept using
Properties#
X |
OpenUSD |
Description |
|---|---|---|
propA |
||
PropB |
propB |
Property: PropA#
More info about the property and any data transformations that should be applied.
Name |
Data Type |
|
|---|---|---|
X |
PropA |
float |
OpenUSD |
propA |
float |
Metadata#
Composition#
UsdConceptB#
This is an example of a concept that only exists in OpenUSD and it’s optionally documented for the purpose of Two-Way translation.You can explain the limitation in more detail and perhaps offer a solution to be able to roundtrip this data without data loss.