User Guide Cancel

mdldictionaries | Substance 3D Automation ToolKit

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)
mdl.mdldictionaries.getAnnotationEnum(aAnnotationPath)
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)
mdl.mdldictionaries.getAnnotationPath(aAnnotation)
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)
mdl.mdldictionaries.getMDLGraphTemplatePath(aTemplateEnum)
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)
mdl.mdldictionaries.getMDLPredefTypePath(aType)
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)
mdl.mdldictionaries.getMDLTypeDefKind(aType)
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)
mdl.mdldictionaries.getMDLTypeDefKindEnum(aTypeName)
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

Get help faster and easier

New user?