User Guide Cancel

mdlannotation | Substance 3D Automation ToolKit

mdlannotation

Module mdlannotation provides the definition of the class MDLAnnotation

class mdl.mdlannotation.MDLAnnotation(aPath='', aOperands=None)
class mdl.mdlannotation.MDLAnnotation(aPath='', aOperands=None)
 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)
equals(other)
 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.

Parameters:other (SBSObject) – The SBSObject to compare to
Returns:True if the two SBSObject are similar according to their definition.
getUidIsUsed(aUID)
getUidIsUsed(aUID)
 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()
getValue()
 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(aContext, aDirAbsPath, aSBSParser, aXmlNode)
 parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)  

Parse recursively the given xml node to retrieve the content of the SBSObject.

Parameters:
  • aContext (Context) – execution context
  • aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
  • aSBSParser (SBSParser) – the substance parser
  • aXmlNode (xml.etree.ElementTree) – the xml node to parse
setValue()
setValue()
 setValue()  

Set the value of this annotation

Parameters:aValue (str or list of str) – The value to set
write(aSBSWriter, aXmlNode)
write(aSBSWriter, aXmlNode)
 write(aSBSWriter, aXmlNode)  

Write recursively the content of the SBSObject into the given xml node.

Parameters:
  • aSBSWriter (SBSWriter) – the substance writer
  • aXmlNode (xml.etree.ElementTree) – the xml node to fill

Get help faster and easier

New user?