Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.
mdlannotation
Module mdlannotation provides the definition of the class MDLAnnotation
class mdl.mdlannotation.MDLAnnotation(aPath='', aOperands=None)
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information on a MDL annotation node as defined in a .sbs file
- Members:
- mPath (string): path of the graph definition this instance refers to.
- mOperands (list of
MDLOperands, optional): list of parameters available on this node
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
getValue()
Get the value of this annotation
| Returns: | The value of this annotation if defined, as a string or a list of string, None otherwise |
|---|
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
setValue()
Set the value of this annotation
| Parameters: | aValue (str or list of str) – The value to set |
|---|
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
