Last updated on
May 24, 2023
- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
mdldictionaries
Module mdldictionaries provides the dictionaries that give the mapping between the enumerations in mdlenum
and the corresponding string identifier used by Substance Designer.
mdl.mdldictionaries.getAnnotationEnum(aAnnotationPath)
Get the enum value of the given annotation
Parameters: | aAnnotationPath (str) – mdl path of the annotation to get |
---|---|
Returns: | the annotation as a MDLAnnotationEnum |
mdl.mdldictionaries.getAnnotationPath(aAnnotation)
Get the given annotation path
Parameters: | aAnnotation (MDLAnnotationEnum ) – attribute identifier |
---|---|
Returns: | the annotation path as a string |
mdl.mdldictionaries.getMDLGraphTemplatePath(aTemplateEnum)
Get the path of the given MDL Graph template
Parameters: | aTemplateEnum (MDLGraphTemplateEnum ) – MDL template |
---|---|
Returns: | the path to the template as a string |
mdl.mdldictionaries.getMDLPredefTypePath(aType)
Get the mdl path of the given predefined mdl type
Parameters: | aType (MDLPredefTypes ) – type identifier |
---|---|
Returns: | the kind of type as a string |
mdl.mdldictionaries.getMDLTypeDefKind(aType)
Get the name of the given mdl type kind
Parameters: | aType (MDLTypeDefKindEnum ) – type identifier |
---|---|
Returns: | the kind of type as a string |
mdl.mdldictionaries.getMDLTypeDefKindEnum(aTypeName)
Get the enum value of the given mdl type kind name
Parameters: | aTypeName (str) – kind of type name |
---|---|
Returns: | the curve type as a ResourceTypeEnum |