Collections

Generated from the schema registry by ernie schema --markdown.

CollectionAPI

A named set of prims, as light linking and material collections use them.

Multiple-apply API schema, applied as CollectionAPI:<name>

Attribute	Type	Description	Fallback	Values	Source
collection:__INSTANCE_NAME__:expansionRule	token	explicitOnly: the targets alone; expandPrims: their descendants too; expandPrimsAndProperties: and their properties.	"expandPrims"	explicitOnly, expandPrims, expandPrimsAndProperties	Usd
collection:__INSTANCE_NAME__:includeRoot	bool	Whether the root prim is a member.	false		Usd
collection:__INSTANCE_NAME__:includes	rel[]	The prims, with their descendants per the rule, in the collection.	[]		Usd
collection:__INSTANCE_NAME__:excludes	rel[]	The prims, with their descendants, left out.	[]		Usd

{
  "$schema": "https://alexmaietta.github.io/ernie/schema/ernie-scene.schema.json",
  "prims": {
    "/World/CollectionAPI": {
      "typeName": "Xform",
      "apiSchemas": ["CollectionAPI:example"],
      "collection:example:expansionRule": "expandPrims",
      "collection:example:includeRoot": false
    }
  }
}