6#ifndef MATERIALX_DOCUMENT
7#define MATERIALX_DOCUMENT
41 shared_ptr<T> doc = std::make_shared<T>(
ElementPtr(), EMPTY_STRING);
47 virtual void initialize();
50 virtual DocumentPtr
copy()
const
52 DocumentPtr doc = createDocument<Document>();
53 doc->copyContentFrom(getSelf());
64 StringSet getReferencedSourceUris()
const;
76 return addChild<NodeGraph>(name);
82 return getChildOfType<NodeGraph>(name);
88 return getChildrenOfType<NodeGraph>();
94 removeChildOfType<NodeGraph>(name);
100 vector<PortElementPtr> getMatchingPorts(
const string& nodeName)
const;
115 geomInfo->setGeom(geom);
122 return getChildOfType<GeomInfo>(name);
128 return getChildrenOfType<GeomInfo>();
134 removeChildOfType<GeomInfo>(name);
138 ValuePtr getGeomPropValue(
const string& geomPropName,
const string& geom = UNIVERSAL_GEOM_NAME)
const;
151 geomPropDef->setGeomProp(geomprop);
158 return getChildOfType<GeomPropDef>(name);
164 return getChildrenOfType<GeomPropDef>();
170 removeChildOfType<GeomPropDef>(name);
184 return addChild<Look>(name);
190 return getChildOfType<Look>(name);
196 return getChildrenOfType<Look>();
202 removeChildOfType<Look>(name);
216 return addChild<LookGroup>(name);
222 return getChildOfType<LookGroup>(name);
228 return getChildrenOfType<LookGroup>();
234 removeChildOfType<LookGroup>(name);
248 return addChild<Collection>(name);
254 return getChildOfType<Collection>(name);
260 return getChildrenOfType<Collection>();
266 removeChildOfType<Collection>(name);
280 return addChild<TypeDef>(name);
286 return getChildOfType<TypeDef>(name);
292 return getChildrenOfType<TypeDef>();
298 removeChildOfType<TypeDef>(name);
315 const string& type = DEFAULT_TYPE_STRING,
316 const string& node = EMPTY_STRING)
318 NodeDefPtr child = addChild<NodeDef>(name);
319 if (!type.empty() && type != MULTI_OUTPUT_TYPE_STRING)
321 child->addOutput(
"out", type);
325 child->setNodeString(node);
340 NodeDefPtr addNodeDefFromGraph(
const NodeGraphPtr nodeGraph,
const string& nodeDefName,
const string& node,
const string& version,
341 bool isDefaultVersion,
const string& nodeGroup,
string& newGraphName);
346 return getChildOfType<NodeDef>(name);
352 return getChildrenOfType<NodeDef>();
358 removeChildOfType<NodeDef>(name);
362 vector<NodeDefPtr> getMatchingNodeDefs(
const string& nodeName)
const;
375 return addChild<AttributeDef>(name);
381 return getChildOfType<AttributeDef>(name);
387 return getChildrenOfType<AttributeDef>();
393 removeChildOfType<AttributeDef>(name);
407 return addChild<TargetDef>(name);
413 return getChildOfType<TargetDef>(name);
419 return getChildrenOfType<TargetDef>();
425 removeChildOfType<TargetDef>(name);
439 return addChild<PropertySet>(name);
445 return getChildOfType<PropertySet>(name);
451 return getChildrenOfType<PropertySet>();
457 removeChildOfType<PropertySet>(name);
471 return addChild<VariantSet>(name);
477 return getChildOfType<VariantSet>(name);
483 return getChildrenOfType<VariantSet>();
489 removeChildOfType<VariantSet>(name);
503 return addChild<Implementation>(name);
509 return getChildOfType<Implementation>(name);
515 return getChildrenOfType<Implementation>();
521 removeChildOfType<Implementation>(name);
527 vector<InterfaceElementPtr> getMatchingImplementations(
const string& nodeDef)
const;
537 throw Exception(
"A unit definition name cannot be empty");
539 return addChild<UnitDef>(name);
545 return getChildOfType<UnitDef>(name);
551 return getChildrenOfType<UnitDef>();
557 removeChildOfType<UnitDef>(name);
568 throw Exception(
"A unit type definition name cannot be empty");
570 return addChild<UnitTypeDef>(name);
576 return getChildOfType<UnitTypeDef>(name);
582 return getChildrenOfType<UnitTypeDef>();
588 removeChildOfType<UnitTypeDef>(name);
596 std::pair<int, int> getVersionIntegers()
const override;
600 void upgradeVersion();
609 setAttribute(CMS_ATTRIBUTE, cms);
615 return hasAttribute(CMS_ATTRIBUTE);
621 return getAttribute(CMS_ATTRIBUTE);
631 setAttribute(CMS_CONFIG_ATTRIBUTE, cmsConfig);
637 return hasAttribute(CMS_CONFIG_ATTRIBUTE);
643 return getAttribute(CMS_CONFIG_ATTRIBUTE);
655 bool validate(
string* message =
nullptr)
const override;
662 void invalidateCache();
667 static const string CATEGORY;
668 static const string CMS_ATTRIBUTE;
669 static const string CMS_CONFIG_ATTRIBUTE;
673 std::unique_ptr<Cache> _cache;
678MX_CORE_API DocumentPtr createDocument();
shared_ptr< TargetDef > TargetDefPtr
A shared pointer to a TargetDef.
Definition: Definition.h:48
shared_ptr< UnitDef > UnitDefPtr
A shared pointer to a UnitDef.
Definition: Definition.h:63
shared_ptr< Implementation > ImplementationPtr
A shared pointer to an Implementation.
Definition: Definition.h:38
shared_ptr< AttributeDef > AttributeDefPtr
A shared pointer to an AttributeDef.
Definition: Definition.h:73
shared_ptr< NodeDef > NodeDefPtr
A shared pointer to a NodeDef.
Definition: Definition.h:33
shared_ptr< UnitTypeDef > UnitTypeDefPtr
A shared pointer to a UnitTypeDef.
Definition: Definition.h:68
shared_ptr< const Document > ConstDocumentPtr
A shared pointer to a const Document.
Definition: Document.h:25
shared_ptr< Document > DocumentPtr
A shared pointer to a Document.
Definition: Document.h:23
shared_ptr< Element > ElementPtr
A shared pointer to an Element.
Definition: Element.h:31
shared_ptr< GeomInfo > GeomInfoPtr
A shared pointer to a GeomInfo.
Definition: Geom.h:39
shared_ptr< Collection > CollectionPtr
A shared pointer to a Collection.
Definition: Geom.h:54
shared_ptr< GeomPropDef > GeomPropDefPtr
A shared pointer to a GeomPropDef.
Definition: Geom.h:49
shared_ptr< LookGroup > LookGroupPtr
A shared pointer to a LookGroup.
Definition: Look.h:33
shared_ptr< Look > LookPtr
A shared pointer to a Look.
Definition: Look.h:28
Import and export declarations for the Core library.
std::set< string > StringSet
A set of strings.
Definition: Library.h:60
shared_ptr< NodeGraph > NodeGraphPtr
A shared pointer to a NodeGraph.
Definition: Node.h:35
shared_ptr< PropertySet > PropertySetPtr
A shared pointer to a PropertySet.
Definition: Property.h:35
shared_ptr< Value > ValuePtr
A shared pointer to a Value.
Definition: Value.h:30
shared_ptr< VariantSet > VariantSetPtr
A shared pointer to a VariantSet.
Definition: Variant.h:29
A MaterialX document, which represents the top-level element in the MaterialX ownership hierarchy.
Definition: Document.h:33
vector< PropertySetPtr > getPropertySets() const
Return a vector of all PropertySet elements in the document.
Definition: Document.h:449
TargetDefPtr addTargetDef(const string &name=EMPTY_STRING)
Add an TargetDef to the document.
Definition: Document.h:405
void removeLookGroup(const string &name)
Remove the LookGroup, if any, with the given name.
Definition: Document.h:232
void removeNodeDef(const string &name)
Remove the NodeDef, if any, with the given name.
Definition: Document.h:356
vector< LookPtr > getLooks() const
Return a vector of all Look elements in the document.
Definition: Document.h:194
void removeUnitTypeDef(const string &name)
Remove the UnitTypeDef, if any, with the given name.
Definition: Document.h:586
void removeVariantSet(const string &name)
Remove the VariantSet, if any, with the given name.
Definition: Document.h:487
vector< UnitTypeDefPtr > getUnitTypeDefs() const
Return a vector of all UnitTypeDef elements in the document.
Definition: Document.h:580
AttributeDefPtr addAttributeDef(const string &name=EMPTY_STRING)
Add an AttributeDef to the document.
Definition: Document.h:373
GeomInfoPtr getGeomInfo(const string &name) const
Return the GeomInfo, if any, with the given name.
Definition: Document.h:120
GeomPropDefPtr getGeomPropDef(const string &name) const
Return the GeomPropDef, if any, with the given name.
Definition: Document.h:156
TargetDefPtr getTargetDef(const string &name) const
Return the AttributeDef, if any, with the given name.
Definition: Document.h:411
ImplementationPtr getImplementation(const string &name) const
Return the Implementation, if any, with the given name.
Definition: Document.h:507
UnitTypeDefPtr getUnitTypeDef(const string &name) const
Return the UnitTypeDef, if any, with the given name.
Definition: Document.h:574
void setColorManagementSystem(const string &cms)
Set the color management system string.
Definition: Document.h:607
void removeImplementation(const string &name)
Remove the Implementation, if any, with the given name.
Definition: Document.h:519
void removeNodeGraph(const string &name)
Remove the NodeGraph, if any, with the given name.
Definition: Document.h:92
bool hasColorManagementSystem() const
Return true if a color management system string has been set.
Definition: Document.h:613
TypeDefPtr getTypeDef(const string &name) const
Return the TypeDef, if any, with the given name.
Definition: Document.h:284
CollectionPtr addCollection(const string &name=EMPTY_STRING)
Add a Collection to the document.
Definition: Document.h:246
vector< ImplementationPtr > getImplementations() const
Return a vector of all Implementation elements in the document.
Definition: Document.h:513
vector< TypeDefPtr > getTypeDefs() const
Return a vector of all TypeDef elements in the document.
Definition: Document.h:290
const string & getColorManagementConfig() const
Return the color management config string.
Definition: Document.h:641
void removeGeomInfo(const string &name)
Remove the GeomInfo, if any, with the given name.
Definition: Document.h:132
vector< NodeGraphPtr > getNodeGraphs() const
Return a vector of all NodeGraph elements in the document.
Definition: Document.h:86
vector< UnitDefPtr > getUnitDefs() const
Return a vector of all Member elements in the TypeDef.
Definition: Document.h:549
CollectionPtr getCollection(const string &name) const
Return the Collection, if any, with the given name.
Definition: Document.h:252
void removeTypeDef(const string &name)
Remove the TypeDef, if any, with the given name.
Definition: Document.h:296
bool hasColorManagementConfig() const
Return true if a color management config string has been set.
Definition: Document.h:635
vector< TargetDefPtr > getTargetDefs() const
Return a vector of all TargetDef elements in the document.
Definition: Document.h:417
GeomPropDefPtr addGeomPropDef(const string &name, const string &geomprop)
Add a GeomPropDef to the document.
Definition: Document.h:148
LookGroupPtr addLookGroup(const string &name=EMPTY_STRING)
Add a LookGroup to the document.
Definition: Document.h:214
void setColorManagementConfig(const string &cmsConfig)
Set the color management config string.
Definition: Document.h:629
void removeTargetDef(const string &name)
Remove the TargetDef, if any, with the given name.
Definition: Document.h:423
GeomInfoPtr addGeomInfo(const string &name=EMPTY_STRING, const string &geom=UNIVERSAL_GEOM_NAME)
Add a GeomInfo to the document.
Definition: Document.h:112
NodeGraphPtr getNodeGraph(const string &name) const
Return the NodeGraph, if any, with the given name.
Definition: Document.h:80
LookPtr addLook(const string &name=EMPTY_STRING)
Add a Look to the document.
Definition: Document.h:182
vector< AttributeDefPtr > getAttributeDefs() const
Return a vector of all AttributeDef elements in the document.
Definition: Document.h:385
UnitDefPtr getUnitDef(const string &name) const
Return the UnitDef, if any, with the given name.
Definition: Document.h:543
void removeLook(const string &name)
Remove the Look, if any, with the given name.
Definition: Document.h:200
vector< GeomInfoPtr > getGeomInfos() const
Return a vector of all GeomInfo elements in the document.
Definition: Document.h:126
NodeGraphPtr addNodeGraph(const string &name=EMPTY_STRING)
Add a NodeGraph to the document.
Definition: Document.h:74
NodeDefPtr addNodeDef(const string &name=EMPTY_STRING, const string &type=DEFAULT_TYPE_STRING, const string &node=EMPTY_STRING)
Add a NodeDef to the document.
Definition: Document.h:314
vector< VariantSetPtr > getVariantSets() const
Return a vector of all VariantSet elements in the document.
Definition: Document.h:481
VariantSetPtr addVariantSet(const string &name=EMPTY_STRING)
Add a VariantSet to the document.
Definition: Document.h:469
NodeDefPtr getNodeDef(const string &name) const
Return the NodeDef, if any, with the given name.
Definition: Document.h:344
AttributeDefPtr getAttributeDef(const string &name) const
Return the AttributeDef, if any, with the given name.
Definition: Document.h:379
ImplementationPtr addImplementation(const string &name=EMPTY_STRING)
Add an Implementation to the document.
Definition: Document.h:501
void removeAttributeDef(const string &name)
Remove the AttributeDef, if any, with the given name.
Definition: Document.h:391
vector< CollectionPtr > getCollections() const
Return a vector of all Collection elements in the document.
Definition: Document.h:258
virtual DocumentPtr copy() const
Create a deep copy of the document.
Definition: Document.h:50
vector< LookGroupPtr > getLookGroups() const
Return a vector of all LookGroup elements in the document.
Definition: Document.h:226
LookGroupPtr getLookGroup(const string &name) const
Return the LookGroup, if any, with the given name.
Definition: Document.h:220
PropertySetPtr getPropertySet(const string &name) const
Return the PropertySet, if any, with the given name.
Definition: Document.h:443
const string & getColorManagementSystem() const
Return the color management system string.
Definition: Document.h:619
LookPtr getLook(const string &name) const
Return the Look, if any, with the given name.
Definition: Document.h:188
static shared_ptr< T > createDocument()
Create a new document of the given subclass.
Definition: Document.h:39
VariantSetPtr getVariantSet(const string &name) const
Return the VariantSet, if any, with the given name.
Definition: Document.h:475
vector< GeomPropDefPtr > getGeomPropDefs() const
Return a vector of all GeomPropDef elements in the document.
Definition: Document.h:162
void removeCollection(const string &name)
Remove the Collection, if any, with the given name.
Definition: Document.h:264
void removeGeomPropDef(const string &name)
Remove the GeomPropDef, if any, with the given name.
Definition: Document.h:168
void removeUnitDef(const string &name)
Remove the UnitDef, if any, with the given name.
Definition: Document.h:555
vector< NodeDefPtr > getNodeDefs() const
Return a vector of all NodeDef elements in the document.
Definition: Document.h:350
TypeDefPtr addTypeDef(const string &name)
Add a TypeDef to the document.
Definition: Document.h:278
PropertySetPtr addPropertySet(const string &name=EMPTY_STRING)
Add a PropertySet to the document.
Definition: Document.h:437
void removePropertySet(const string &name)
Remove the PropertySet, if any, with the given name.
Definition: Document.h:455
The base class for exceptions that are propagated from the MaterialX library to the client applicatio...
Definition: Exception.h:23
The base class for graph elements such as NodeGraph and Document.
Definition: Node.h:177