Alliance for OpenUSD · JSON Structure

Aousd Usd Prim Structure

A USD prim — a named container in the scene hierarchy that can have typed schemas, properties, metadata, and composition arcs applied to it.

Type: object Properties: 10 Required: 3
3DInteroperabilityLinux FoundationMetaverseOpenUSDSpecificationStandardsUSDVisual Effects

USDPrim is a JSON Structure definition published by Alliance for OpenUSD, describing 10 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

path name typeName specifier active hidden kind documentation purpose instanceable

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

aousd-usd-prim-structure.json Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aousd/refs/heads/main/json-structure/aousd-usd-prim-structure.json",
  "description": "A USD prim \u2014 a named container in the scene hierarchy that can have typed schemas, properties, metadata, and composition arcs applied to it.",
  "type": "object",
  "properties": {
    "path": {
      "type": "string",
      "description": "The absolute scene path to this prim.",
      "example": "/World/Characters/Hero"
    },
    "name": {
      "type": "string",
      "description": "The name component of the prim path.",
      "example": "Hero"
    },
    "typeName": {
      "type": "string",
      "description": "The typed schema name applied to this prim.",
      "example": "Xform"
    },
    "specifier": {
      "type": "string",
      "enum": [
        "def",
        "over",
        "class"
      ],
      "description": "How this prim is introduced into the scene.",
      "example": "def"
    },
    "active": {
      "type": "boolean",
      "description": "Whether this prim is active (inactive prims are excluded from rendering).",
      "example": true
    },
    "hidden": {
      "type": "boolean",
      "description": "Whether this prim is hidden in interactive contexts.",
      "example": false
    },
    "kind": {
      "type": "string",
      "enum": [
        "",
        "model",
        "group",
        "assembly",
        "component",
        "subcomponent"
      ],
      "description": "The model hierarchy kind of this prim.",
      "example": "component"
    },
    "documentation": {
      "type": "string",
      "description": "Documentation string for this prim.",
      "example": "The hero character asset prim."
    },
    "purpose": {
      "type": "string",
      "enum": [
        "default",
        "render",
        "proxy",
        "guide"
      ],
      "description": "The imaging purpose for this prim.",
      "example": "default"
    },
    "instanceable": {
      "type": "boolean",
      "description": "Whether this prim should be treated as an instance master for instancing.",
      "example": false
    }
  },
  "required": [
    "path",
    "name",
    "specifier"
  ],
  "name": "USDPrim"
}