PyMaterialXCore.Document¶

class Document¶

Bases: GraphElement

A MaterialX document, which represents the top-level element in the MaterialX ownership hierarchy.

Use the factory function createDocument() to create a Document instance.

See:: https://materialx.org/docs/api/class_document.html

Methods

`__init__`(args, *kwargs)
`addAttributeDef`(self, arg0)
`addCollection`(self[, name])
`addGeomInfo`(self[, name, geom])
`addGeomPropDef`(self, arg0, arg1)
`addImplementation`(self[, name])
`addLook`(self[, name])
`addLookGroup`(self[, name])
`addNodeDef`(self[, name, type, node])
`addNodeDefFromGraph`(args, *kwargs)	Overloaded function.
`addNodeGraph`(self[, name])
`addPropertySet`(self[, name])
`addTargetDef`(self, arg0)
`addTypeDef`(self[, name])
`addUnitDef`(self, arg0)
`addUnitTypeDef`(self, arg0)
`addVariantSet`(self[, name])
`copy`(self)
`getAttributeDef`(self, arg0)
`getAttributeDefs`(self)
`getCollection`(self, arg0)
`getCollections`(self)
`getColorManagementConfig`(self)
`getColorManagementSystem`(self)
`getGeomInfo`(self, arg0)
`getGeomInfos`(self)
`getGeomPropDef`(self, arg0)
`getGeomPropDefs`(self)
`getGeomPropValue`(self, geomPropName[, geom])
`getImplementation`(self, arg0)
`getImplementations`(self)
`getLook`(self, arg0)
`getLookGroup`(self, arg0)
`getLookGroups`(self)
`getLooks`(self)
`getMatchingImplementations`(self, arg0)
`getMatchingNodeDefs`(self, arg0)
`getMatchingPorts`(self, arg0)
`getMaterialOutputs`(self)
`getNodeDef`(self, arg0)
`getNodeDefs`(self)
`getNodeGraph`(self, arg0)
`getNodeGraphs`(self)
`getPropertySet`(self, arg0)
`getPropertySets`(self)
`getReferencedSourceUris`(self)
`getTargetDef`(self, arg0)
`getTargetDefs`(self)
`getTypeDef`(self, arg0)
`getTypeDefs`(self)
`getUnitDef`(self, arg0)
`getUnitDefs`(self)
`getUnitTypeDef`(self, arg0)
`getUnitTypeDefs`(self)
`getVariantSet`(self, arg0)
`getVariantSets`(self)
`hasColorManagementConfig`(self)
`hasColorManagementSystem`(self)
`importLibrary`(self, arg0)
`initialize`(self)
`removeAttributeDef`(self, arg0)
`removeCollection`(self, arg0)
`removeGeomInfo`(self, arg0)
`removeGeomPropDef`(self, arg0)
`removeImplementation`(self, arg0)
`removeLook`(self, arg0)
`removeLookGroup`(self, arg0)
`removeNodeDef`(self, arg0)
`removeNodeGraph`(self, arg0)
`removePropertySet`(self, arg0)
`removeTargetDef`(self, arg0)
`removeTypeDef`(self, arg0)
`removeUnitDef`(self, arg0)
`removeUnitTypeDef`(self, arg0)
`removeVariantSet`(self, arg0)
`setColorManagementConfig`(self, arg0)
`setColorManagementSystem`(self, arg0)
`upgradeVersion`(self)

Methods¶

__init__(*args, **kwargs)¶

addAttributeDef(self: Document, arg0: str) → AttributeDef¶

addCollection(self: Document, name: str = '') → Collection¶

addGeomInfo(self: Document, name: str = '', geom: str = '/') → GeomInfo¶

addGeomPropDef(self: Document, arg0: str, arg1: str) → GeomPropDef¶

addImplementation(self: Document, name: str = '') → Implementation¶

addLook(self: Document, name: str = '') → Look¶

addLookGroup(self: Document, name: str = '') → LookGroup¶

addNodeDef(self: Document, name: str = '', type: str = 'color3', node: str = '') → NodeDef¶

addNodeDefFromGraph(*args, **kwargs)¶

Overloaded function.

addNodeDefFromGraph(self: PyMaterialXCore.Document, arg0: PyMaterialXCore.NodeGraph, arg1: str, arg2: str, arg3: str) -> PyMaterialXCore.NodeDef
addNodeDefFromGraph(self: PyMaterialXCore.Document, arg0: PyMaterialXCore.NodeGraph, arg1: str, arg2: str, arg3: str, arg4: bool, arg5: str, arg6: str) -> PyMaterialXCore.NodeDef

addNodeGraph(self: Document, name: str = '') → NodeGraph¶

addPropertySet(self: Document, name: str = '') → PropertySet¶

addTargetDef(self: Document, arg0: str) → TargetDef¶

addTypeDef(self: Document, name: str = '') → TypeDef¶

addUnitDef(self: Document, arg0: str) → UnitDef¶

addUnitTypeDef(self: Document, arg0: str) → UnitTypeDef¶

addVariantSet(self: Document, name: str = '') → VariantSet¶

copy(self: Document) → Document¶

getAttributeDef(self: Document, arg0: str) → AttributeDef¶

getAttributeDefs(self: Document) → list[AttributeDef]¶

getCollection(self: Document, arg0: str) → Collection¶

getCollections(self: Document) → list[Collection]¶

getColorManagementConfig(self: Document) → str¶

getColorManagementSystem(self: Document) → str¶

getGeomInfo(self: Document, arg0: str) → GeomInfo¶

getGeomInfos(self: Document) → list[GeomInfo]¶

getGeomPropDef(self: Document, arg0: str) → GeomPropDef¶

getGeomPropDefs(self: Document) → list[GeomPropDef]¶

getGeomPropValue(self: Document, geomPropName: str, geom: str = '/') → Value¶

getImplementation(self: Document, arg0: str) → Implementation¶

getImplementations(self: Document) → list[Implementation]¶

getLook(self: Document, arg0: str) → Look¶

getLookGroup(self: Document, arg0: str) → LookGroup¶

getLookGroups(self: Document) → list[LookGroup]¶

getLooks(self: Document) → list[Look]¶

getMatchingImplementations(self: Document, arg0: str) → list[InterfaceElement]¶

getMatchingNodeDefs(self: Document, arg0: str) → list[NodeDef]¶

getMatchingPorts(self: Document, arg0: str) → list[PortElement]¶

getMaterialOutputs(self: Document) → list[Output]¶

getNodeDef(self: Document, arg0: str) → NodeDef¶

getNodeDefs(self: Document) → list[NodeDef]¶

getNodeGraph(self: Document, arg0: str) → NodeGraph¶

getNodeGraphs(self: Document) → list[NodeGraph]¶

getPropertySet(self: Document, arg0: str) → PropertySet¶

getPropertySets(self: Document) → list[PropertySet]¶

getReferencedSourceUris(self: Document) → set[str]¶

getTargetDef(self: Document, arg0: str) → TargetDef¶

getTargetDefs(self: Document) → list[TargetDef]¶

getTypeDef(self: Document, arg0: str) → TypeDef¶

getTypeDefs(self: Document) → list[TypeDef]¶

getUnitDef(self: Document, arg0: str) → UnitDef¶

getUnitDefs(self: Document) → list[UnitDef]¶

getUnitTypeDef(self: Document, arg0: str) → UnitTypeDef¶

getUnitTypeDefs(self: Document) → list[UnitTypeDef]¶

getVariantSet(self: Document, arg0: str) → VariantSet¶

getVariantSets(self: Document) → list[VariantSet]¶

hasColorManagementConfig(self: Document) → bool¶

hasColorManagementSystem(self: Document) → bool¶

importLibrary(self: Document, arg0: Document) → None¶

initialize(self: Document) → None¶

removeAttributeDef(self: Document, arg0: str) → None¶

removeCollection(self: Document, arg0: str) → None¶

removeGeomInfo(self: Document, arg0: str) → None¶

removeGeomPropDef(self: Document, arg0: str) → None¶

removeImplementation(self: Document, arg0: str) → None¶

removeLook(self: Document, arg0: str) → None¶

removeLookGroup(self: Document, arg0: str) → None¶

removeNodeDef(self: Document, arg0: str) → None¶

removeNodeGraph(self: Document, arg0: str) → None¶

removePropertySet(self: Document, arg0: str) → None¶

removeTargetDef(self: Document, arg0: str) → None¶

removeTypeDef(self: Document, arg0: str) → None¶

removeUnitDef(self: Document, arg0: str) → None¶

removeUnitTypeDef(self: Document, arg0: str) → None¶

removeVariantSet(self: Document, arg0: str) → None¶

setColorManagementConfig(self: Document, arg0: str) → None¶

setColorManagementSystem(self: Document, arg0: str) → None¶

upgradeVersion(self: Document) → None¶