User Guide Cancel

sbsbakersdictionaries | Substance 3D Automation ToolKit

sbsbakersdictionaries

Module sbsbakersdictionaries provides the dictionaries to have the mapping between the enumerations in sbsbakersenum and the corresponding string identifiers used by Substance Designer.

pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatEnum(aBakerOutputFormatName)
pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatEnum(aBakerOutputFormatName)
pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatEnum(aBakerOutputFormatName)

Get the enum value of the given baker output property

Parameters: aBakerOutputFormatName (str) – Output property name
Returns: the converter parameter as a ConverterParamEnum
pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatName(aBakerOutputFormat)
pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatName(aBakerOutputFormat)
pysbs.sbsbakers.sbsbakersdictionaries.getBakerOutputFormatName(aBakerOutputFormat)

Get the given baker output format name

Parameters: aBakerOutputFormat (BakerOutputFormatEnum) – baker output format identifier
Returns: the baker output format as a string
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagEnum(aBakingStructureTagName)
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagEnum(aBakingStructureTagName)
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagEnum(aBakingStructureTagName)

Get the enum value of the given baker attribute

Parameters: aBakingStructureTagName (str) – Name of the baking structure tag to find
Returns: the baking structure tag as a BakingStructureTagEnum
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagName(aBakingStructureTag)
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagName(aBakingStructureTag)
pysbs.sbsbakers.sbsbakersdictionaries.getBakingStructureTagName(aBakingStructureTag)

Get the name of the given baking structure tag

Parameters: aBakingStructureTag (BakingStructureTagEnum) – baking structure tag
Returns: the baker attribute as a string
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamEnum(aConverterParamName)
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamEnum(aConverterParamName)
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamEnum(aConverterParamName)

Get the enum value of the given converter property

Parameters: aConverterParamName (str) – Converter property name
Returns: the converter parameter as a ConverterParamEnum
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamName(aConverterParam)
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamName(aConverterParam)
pysbs.sbsbakers.sbsbakersdictionaries.getConverterParamName(aConverterParam)

Get the given baker property name

Parameters: aConverterParam (ConverterParamEnum) – converter property identifier
Returns: the converter parameter as a string
pysbs.sbsbakers.sbsbakersdictionaries.getDefaultFromCommon(aCommonProperty)
pysbs.sbsbakers.sbsbakersdictionaries.getDefaultFromCommon(aCommonProperty)
pysbs.sbsbakers.sbsbakersdictionaries.getDefaultFromCommon(aCommonProperty)

Get the corresponding default property from a common property

Parameters: aCommonProperty – The common property
Type: ConverterParamEnum
Returns: ConverterParamEnum the corresponding default property

Get help faster and easier

New user?