usdaフォーマットチートシート
では、Python コマンドのチートシートをまとめましたが こちらは USD フォーマットの内部構造の記述についての Ascii ファイルとして記述した場合のチートシートです。
Usd ファイル内での Path の記述方法
USD 内で外部ファイルを読んでいる場合は @@ で囲う。
例）Reference 等
#usda 1.0
def "sphereA" (
prepend references = @sphere.usda@
)
{
}
USD 内の SdfPath を指定する場合は
def "hoge" (
prepend inherits = </TestClass>
)
{
}
<>で囲う。
/ から始まる場合は Root からの絶対パス、なにもない場合は現在の Prim からの相対パスになる。
最低限の構造
#usda 1.0
USD ファイルを記述する場合は、一番頭に #usda 1.0 と書きます。
コレがあれば、すべて USD ファイルとしてロードできます。
Prim を定義する
スキーマなしで Prim を定義
#usda 1.0
def "sphereA"
{
}
Prim と呼ばれるタグを作成する
def "sphereA"
{
def "sub"
{
}
}
Prim は、このように の中に def を記述することでネストできる。
スキーマ（Type 指定）付きで Prim を定義する
def Xform "hoge"
{
}
クラスを定義する
class "className"
{
}
クラスで定義されているものは、usdview 等でシーンを読んでもシーングラフには表示されない。
Over を定義する
over "name"
{
}
Over の場合は、Prim と違い
すでに Prim がある場合のみ値を上書きする。
定義されている Prim がない場合はなにもしない。
DefaultPrim を指定する
#usda 1.0
(
defaultPrim = "sphereA"
)
def "sphereA"
{
}
DefaultPrim とは、リファレンスで usd を読み込んだ場合の起点になる Prim の事。
アトリビュートに値をセットする
#usda 1.0
def Xform "base"
{
bool test = false
}
アトリビュートを追加する場合、Prim のの中に 型 名前 = 値
のように指定する。
Metadata を追加する
#usda 1.0
(
"Hello World"
defaultPrim = "sphereA"
)
def "sphereA" (
"Hoge Hoge"
)
{
custom bool testVal (
"Attribute Comment"
)
}
Metadata はレイヤー、プリム、アトリビュートそれぞれに付加情報として設定できる。
指定したい場合は それぞれの定義の後に () を入れて、その中にアトリビュートを追加するように
記述する。
CustomData を追加する
#usda 1.0
def "defPrim" (
customData = {
string hoge = "test"
}
)
{
}
customData = を使うと、好きに自分の入れたい Meta 情報をレイヤー、プリム、アトリビュートに対して
追加できる。
リファレンスでモデルを読み込む
DefaultPrim が指定されている場合
#usda 1.0
def "sphereA" (
prepend references = @sphere.usda@
)
{
}
リファレンスで読み込む場合は、読み込む先の Prim の Metadata に prepend references = ### で
ファイルを指定する。
ファイルパスは @@でかこって表現する。
ファイルパスは、現在の usd ファイルからの相対または絶対パスで指定する。
references 時に Prim を指定する場合
#usda 1.0
def "sphereA" (
prepend references = @sphere.usda@</Model>
)
{
}
DefaultPrim の指定がない、あるいはそれ以外の Prim を狙ってリファレンスしたい場合は
ファイル指定の後に <>で囲って SdfPath を指定する。
SubLayer で読み込む
#usda 1.0
(
subLayers = [
@D:/usdClass.usda@
]
)
サブレイヤーで読み込むときは、レイヤーの Metadata に対して subLayers = []
を追加して、配列で読み込みたいファイルパスを指定する。
ファイルパスは @@ で囲う。
リレーションを追加する
#usda 1.0
def "test"
{
def Xform "param"
{
prepend rel test = [
</rel/data>,
]
}
}
def "rel"
{
def Xform "data"
{
}
}
リレーションを追加したい場合は、 アトリビュートを rel で宣言して、
リレー ション先の SdfPath を配列で指定する。
継承(Inherits)する
def "hoge" (
prepend inherits = </TestClass>
)
{
}
継承の場合は、継承したい Prim の Metadata に対して prepend inherits = SdfPath を追加する。
#usda 1.0
(
subLayers = [
@D:/usdClass.usda@
]
)
def "hoge" (
prepend inherits = </TestClass>
)
{
}
継承は、SdfPath で指定する。
ので、例えば別ファイルに定義されている class や def を継承したい場合は
subLayer で読み込んでから inherits で指定をする。
VariantSet を定義する
#usda 1.0
(
"Hello World"
)
def Xform "World"
{
def Cube "Cube" (
variants = {
string hogehoge = "green"
}
prepend variantSets = "hogehoge"
)
{
variantSet "hogehoge" = {
"blue" {
color3f[] primvars:displayColor = [(0, 0, 1)]
}
"green" {
color3f[] primvars:displayColor = [(0, 1, 0)]
}
"red" {
color3f[] primvars:displayColor = [(1, 0, 0)]
}
}
}
}
variantSet は、 variantSet で定義する。
定義した variantSet を Prim で使う場合は、Metadata 内に prepend variantSets = "名前"
を追加する。
その variantSet のうち、選択されているセットは variants で、選択中の値を指定する。
アニメーションの定義
#usda 1.0
(
endTimeCode = 100
startTimeCode = 0
)
def Xform "World"
{
def Cube "Cube"
{
float xformOp:rotateZ:spin.timeSamples = {
0: 0,
100: 360,
}
uniform token[] xformOpOrder = ["xformOp:rotateZ:spin"]
}
}
コレを手で書くことはないと思うけど念のため。
スタートフレームとエンドフレームは、レイヤーの Metadata に記載。
Key 情報は、timeSamples に Dict 型で記載。
xformOpOrder は、どういう順序で Transform を行うのかを指定する。
マテリアルのアサイン
#usda 1.0
def "test"
{
def Sphere "sphere"
{
rel material:binding = </Model/Material/MyMat>
}
}
def "Model"
{
def "Material"
{
def Material "MyMat"
{
token outputs:surface.connect = </Model/Material/MyMat/testShader.outputs:surface>
def Shader "testShader"
{
uniform token info:id = "UsdPreviewSurface"
color3f inputs:diffuseColor = (0, 1, 0)
float inputs:metalic = 0.9
float inputs:roughness = 0.2
token outputs:surface
}
}
}
}
これもまぁ手では書かないけど念のため。
Material アサインはリレーションによって定義されている。
Mesh データはリレーションで Bind 先の Material 情報を保持し、
Material は、Shader との Connection で値を受け取る。