User Guide Cancel

mdlcommon | Substance 3D Automation ToolKit

Search
Substance 3D Automation Toolkit

Substance 3D Automation Toolkit

Open app
  1. Substance 3D home
  2. Home
  3. Command Line Tools
    1. Command Line overview
    2. sbsbaker
      1. sbsbaker overview
      2. sbsbaker command line options
      3. sbsbaker Example Command Lines
    3. sbscooker
      1. sbscooker overview
      2. sbscooker command line options
      3. sbscooker pattern variables
    4. sbsmtools
      1. sbsmtools overview
      2. sbsmtools command line options
    5. sbsmutator
      1. sbsmutator overview
      2. sbsmutator command line options
      3. sbsmutator Example Command Lines
    6. sbsrender
      1. sbsrender overview
      2. sbsrender base parameters and pattern variables
      3. sbsrender command line options
      4. sbsrender example command lines
    7. sbsupdater
      1. sbsupdater overview
      2. sbsupdater command line options
  4. Pysbs - Python API
    1. Pysbs - Python API overview
    2. Getting started
    3. General topics
      1. Basic manipulation
      2. Substance creation
      3. Substances modification
      4. Dependencies management
      5. PySbs batchtools module
      6. metadata manipulation
      7. SAT demos
      8. Edit sbsar with SBSARManager
      9. Spot Colors
      10. Thumbnail creation with SAT
    4. Examples
      1. demohelloworld
      2. demos
      3. demos_batchtools
      4. script_update_with_sbsupdater
    5. API Content
      1. API Content overview
      2. Substance definitions
        1. Common interfaces
          1. basegraph
          2. package
          3. sbsarobject
          4. sbsobject
        2. compnode
          1. compnode overview
          2. common
          3. compimplementation
          4. paramgraph
        3. context projectmgr
        4. graph
          1. graph overview
          2. function
          3. inputparameters
          4. output
        5. mdl
          1. mdlannotation
          2. mdlcommon
          3. mdldictionaries
          4. mdlenum
          5. mdlgraph
          6. mdllibclasses
          7. mdlmanager
          8. mdlnode
          9. mdlnodeimpl
          10. mdloperand
          11. mdlsbsbridge
        6. modelgraphindex
          1. modelannotationnames
          2. modelgraph
          3. modelgraphgenerator
          4. modelgraphimplementation
          5. modelnodenames
          6. modeloperand
          7. modulegraphindex
          8. moduleannotation
          9. moduleconnection
          10. modulegraph
          11. modulegraphgenerator
          12. modulegraphimplementation
          13. modulegraphlibrary
          14. modulegraphregister
          15. modulenode
          16. modulenodeimplementation
          17. modulenodeinstance
          18. moduleoperand
          19. moduleoutputbridging
          20. moduleparaminput
        7. params
          1. params overview
          2. dynamicvalue
          3. paramnode
        8. projectmgrdoc
        9. sbsarchive
          1. sbsarchive overview
          2. sbsarenum
          3. sbsargraph
          4. sbsargui
          5. sbsarguiwidgets
          6. sbsarmanager
        10. sbscommon
          1. connections
          2. gui
          3. nodes
          4. values
        11. sbspreset
        12. sbsproject
        13. substance
          1. substance overview
          2. content
          3. resource
      3. Libraries
        1. sbsenum
        2. sbslibrary
          1. sbslibrary overview
          2. sbsdictionaries
          3. sbsfilters
          4. sbsfunctions
          5. sbsfxmapnodes
          6. sbslibclasses
          7. sbswidgets
        3. sbsbakerslibrary
          1. sbsbakerslibrary overview
          2. sbsbakersdef
          3. sbsbakersdefaultprops
          4. sbsbakersdictionaries
          5. sbsbakersenum
          6. sbsbakingconverter
          7. sbsbakingconverterparam
          8. sbsbakingparameters
          9. sbsdialogstate
          10. sbsscenedata
        4. Helpers
          1. sbscleaner
          2. sbsexporter
          3. sbsgenerator
          4. sbsparser
          5. sbswriter
          6. qtclasses
            1. qtclasses overview
            2. qtvariantreader
            3. qtvariantwriter
          7. psdparser
          8. sbsimpactmanager
          9. batchtools
          10. autograph
            1. ag_functions
            2. ag_layout
            3. ag_types
          11. info_mesh_parser
          12. sbsbaker_info_handlers
          13. sbsrender_render_handlers
          14. output_handlers
          15. spotcolorinfo_handler
          16. thumbnail
          17. batchtools overview
        5. Execution context
          1. context
          2. functions
        6. API Change log
  5. Samples
    1. Samples overview
    2. Texturing Template Demo
    3. Batch Tools Demo
    4. Variations
    5. Texture Mat
    6. Pixel Processor Ray tracer
  6. Setup and Getting Started
    1. Setup and Getting Started overview
    2. Compatibility
    3. Frequently asked Questions
    4. Known issues
    5. SAT Cookbook
    6. Use Pysbs in different python interpreter (maya, sd, blender...)
  7. Integrations
    1. Substance Maya toolset
      1. Substance Maya Toolset overview
      2. Installing
      3. Launching
      4. Baking
        1. Baking overview
        2. Export parameters
        3. Baker parameters
        4. Mesh setup
        5. Using a template
      5. Changelog
  8. Changelog overview

mdlcommon

Module mdlcommon provides the definition of common interfaces for MDLObjects:

 class mdl.mdlcommon.MDLImplWithOperands(aOperands=None)

Bases: mdl.mdlcommon.MDLNodeImpl

This class allows to gather the parameter management for classes MDLImplConstant, MDLImplMDLInstance and MDLImplMDLGraphInstance

Members:
 classify(aOther)

Compare the path of the two instances to classify them.

Parameters:aOther (MDLNodeImpl) – The filter to compare to.
Returns:1 if itself is considered greater than the other node, -1 for the opposite. 0 in case of equality. 
 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. 
 getDefinition()

Get the definition of the node (Inputs, Outputs, Parameters)

Returns:a MDLNodeDef object 
 getDisplayName()
Returns:the display name of this node as a string 
 getInputDefinition(self, aInputIdentifier=None)

Get the input definition corresponding to the given identifier.

Parameters:aInputIdentifier (str, optional) – The identifier to get. If let None, the first input will be returned
Returns:the input definition as a MDLNodeDefInput if found, None otherwise 
 getOperand(aOperandName)

Get the operand with the given name

Returns:a MDLOperand object if found, None otherwise 
 getOperands()

Get the list of operands objects

Returns:a list of MDLOperand 
 getOutputType(aOutputIdentifier=None)

Get the output type of this node given the output identifier.

Parameters:aOutputIdentifier (str, optional) – The output identifier to look for. If None, the first output will be considered
Returns:The node output type as a string (color or float) if found, None otherwise 
 getParameter(aParameter=None)

Get the parameter with the given name among the parameters available on the node. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str, optional) – Parameter identifier
Returns:The parameter if found (MDLParameter or MDLOperand), None otherwise 
 getParameterValue(aParameter=None)

Find a parameter with the given name among the parameters available on the node and return its value. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str, optional) – Parameter identifier
Returns:The parameter value if found (string or MDLOperand, None otherwise 
 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 
 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 
 resetParameter(aParameter = None)

Reset the given parameter to its default value. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str) – identifier of the parameter to reset
Returns:True if succeed, False otherwise
Raise:api_exceptions.SBSLibraryError 
 setParameterValue(aParameter, aParamValue)

Set the value of the given parameter to the given value, if compatible with this node.

Parameters:
  • aParameter (str) – identifier of the parameter to set
  • aParamValue (any parameter type) – value of the parameter
Returns:

True if succeed, False otherwise
Raise:

api_exceptions.SBSLibraryError

 
 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 
 class mdl.mdlcommon.MDLNodeImpl

Bases: pysbs.common_interfaces.sbsobject.SBSObject

This abstract class allows to provide a common interface for all MDL node implementation kind.

 classify(aOther)

Compare the path of the two instances to classify them.

Parameters:aOther (MDLNodeImpl) – The filter to compare to.
Returns:1 if itself is considered greater than the other node, -1 for the opposite. 0 in case of equality. 
 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. 
 getDefinition()

Get the definition of the node (Inputs, Outputs, Parameters)

Returns:a MDLNodeDef object 
 getDisplayName()
Returns:the display name of this node as a string 
 getInputDefinition(self, aInputIdentifier=None)

Get the input definition corresponding to the given identifier.

Parameters:aInputIdentifier (str, optional) – The identifier to get. If let None, the first input will be returned
Returns:the input definition as a MDLNodeDefInput if found, None otherwise 
 getOutputType(aOutputIdentifier=None)

Get the output type of this node given the output identifier.

Parameters:aOutputIdentifier (str, optional) – The output identifier to look for. If None, the first output will be considered
Returns:The node output type as a string (color or float) if found, None otherwise 
 getParameter(aParameter=None)

Get the parameter with the given name among the parameters available on the node. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str, optional) – Parameter identifier
Returns:The parameter if found (MDLParameter or MDLOperand), None otherwise 
 getParameterValue(aParameter=None)

Find a parameter with the given name among the parameters available on the node and return its value. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str, optional) – Parameter identifier
Returns:The parameter value if found (string or MDLOperand, None otherwise 
 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 
 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 
 resetParameter(aParameter = None)

Reset the given parameter to its default value. aParameter can be None in case of a Constant or Selector node, where there is only one parameter.

Parameters:aParameter (str) – identifier of the parameter to reset
Returns:True if succeed, False otherwise
Raise:api_exceptions.SBSLibraryError 
 setParameterValue(aParameter, aParamValue)

Set the value of the given parameter to the given value, if compatible with this node.

Parameters:
  • aParameter (str) – identifier of the parameter to set
  • aParamValue (any parameter type) – value of the parameter
Returns:

True if succeed, False otherwise
Raise:

api_exceptions.SBSLibraryError

 
 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 
 class mdl.mdlcommon.MDLObjectWithAnnotations(aAllowedAnnotations, aAnnotations)

Bases: object

This abstract class allows to provide a common interface for all MDL object with annotations.

 getAnnotation(aAnnotation)

Get the given annotation.

Parameters:aAnnotation (MDLAnnotationEnum or str) – The annotation to look for, as an enumeration or a mdl path
Returns:The annotation as a MDLAnnotation 
 getAnnotationValue(aAnnotation)

Get the value of the given annotation.

Parameters:aAnnotation (MDLAnnotationEnum or str) – The annotation to look for, as an enumeration or a mdl path
Returns:The annotation value as a string or list of string if found, None otherwise 
 getGroup()

Get the ‘in_group’ annotation value

Returns:The group/subgroup/subsubgroup value if found, None otherwise 
 getUsage()

Get the ‘sampler_usage’ annotation value

Returns:The ‘sampler_usage’ value if found, None otherwise 
 hasUsage(aUsage)

Check if the given usage is defined on this constant node

Parameters:aUsage (str or UsageEnum) – The usage to look for (can be an enum value or a custom string)
Returns:True if the given usage is defined on this param input, False otherwise 
 removeAnnotation(aAnnotation)

Remove the given annotation from the list of annotations

Parameters:aAnnotation (MDLAnnotationEnum or str) – The annotation to look for, as an enumeration or a mdl path 
 setAnnotation(aAnnotation, aAnnotationValue)

Set the given attribute

Parameters:
  • aAnnotation (MDLAnnotationEnum) – The annotation to set, as an enumeration or a mdl path
  • aAnnotationValue (str or list of str) – The value to set
Raise:

SBSImpossibleActionError

 
 setGroup(aGroup, aSubGroup=None, aSubSubGroup=None)

Set the ‘in_group’ annotation value with the given group and subgroups

Parameters:
  • aGroup (str) – The main group
  • aSubGroup (str, optional) – The sub-group
  • aSubSubGroup (str, optional) – The sub-sub-group 
 setUsage(aUsage)

Set the ‘sampler_usage’ annotation value with the given usage

Parameters:aUsage (str) – The usage to set

 Adobe

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy