sbsbakersdictionaries module

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

• Dictionaries:

  • __dict_BakingStructureTags: dictionary relative to BakingStructureTagEnum:

    __dict_BakingStructureTags = {
        sbsbakersenum.BakingStructureTagEnum.BAKING                         : 'baking',
        sbsbakersenum.BakingStructureTagEnum.RESOURCE_MODEL                 : 'bakingresourcemodel',
        sbsbakersenum.BakingStructureTagEnum.RESOURCE_DEFAULT_VALUES_MODEL  : 'bakingresourcedefaultvaluesmodel',
        sbsbakersenum.BakingStructureTagEnum.RESOURCE_MESHES_MODEL          : 'bakingresourcemeshesmodel',
        sbsbakersenum.BakingStructureTagEnum.RESOURCE_OUTPUT_MODEL          : 'bakingresourceoutputmodel',
        sbsbakersenum.BakingStructureTagEnum.CONVERTERS                     : 'converters',
        sbsbakersenum.BakingStructureTagEnum.FIRST                          : 'first',
        sbsbakersenum.BakingStructureTagEnum.FORMAT                         : 'format',
        sbsbakersenum.BakingStructureTagEnum.GUI_PROPERTIES                 : 'guiProperties',
        sbsbakersenum.BakingStructureTagEnum.IDENTIFIER                     : 'identifier',
        sbsbakersenum.BakingStructureTagEnum.IS_SELECTED                    : 'isselected',
        sbsbakersenum.BakingStructureTagEnum.IS_OVERRIDEN                   : 'isOverriden',
        sbsbakersenum.BakingStructureTagEnum.MESH_CONVERTER_ID              : 'converterid',
        sbsbakersenum.BakingStructureTagEnum.PROPERTIES                     : 'properties',
        sbsbakersenum.BakingStructureTagEnum.SCENE_SELECTION_MODE           : 'objectSelectionMode',    #To be confirmed
        sbsbakersenum.BakingStructureTagEnum.SECOND                         : 'second',
        sbsbakersenum.BakingStructureTagEnum.SELECTIONS                     : 'selections',
        sbsbakersenum.BakingStructureTagEnum.SUBMESH_COLORS                 : 'colors',
        sbsbakersenum.BakingStructureTagEnum.SUBMESH_COLOR                  : 'color',
    }
    

  • __dict_BakerOutputFormats: dictionary relative to BakerOutputFormatEnum:

    __dict_BakerOutputFormats = {
        sbsbakersenum.BakerOutputFormatEnum.PSD       : 'Adobe Photoshop (*.psd)',
        sbsbakersenum.BakerOutputFormatEnum.DDS       : 'DirectDraw Surface (*.dds)',
        sbsbakersenum.BakerOutputFormatEnum.WEBP      : 'Google WebP image format (*.webp)',
        sbsbakersenum.BakerOutputFormatEnum.HDR       : 'High Dynamic Range Image (*.hdr)',
        sbsbakersenum.BakerOutputFormatEnum.EXR       : 'ILM OpenEXR (*.exr)',
        sbsbakersenum.BakerOutputFormatEnum.JPEG      : 'JPEG - JFIF Compliant (*.jpg *.jif *.jpeg *.jpe)',
        sbsbakersenum.BakerOutputFormatEnum.JPEG_XR   : 'JPEG XR image format (*.jxr *.wdp *.hdp)',
        sbsbakersenum.BakerOutputFormatEnum.JPEG_2000 : 'JPEG-2000 File format (*.jp2)',
        sbsbakersenum.BakerOutputFormatEnum.PNG       : 'Portable Network Graphics (*.png)',
        sbsbakersenum.BakerOutputFormatEnum.SVG       : 'SVG (*.svg)',
        sbsbakersenum.BakerOutputFormatEnum.TIF       : 'Tagged Image File Format (*.tif *.tiff)',
        sbsbakersenum.BakerOutputFormatEnum.TGA       : 'Truevision Targa (*.tga *.targa)',
        sbsbakersenum.BakerOutputFormatEnum.ICO       : 'Windows Icon (*.ico)',
        sbsbakersenum.BakerOutputFormatEnum.BMP       : 'Windows or OS/2 Bitmap (*.bmp)',
        sbsbakersenum.BakerOutputFormatEnum.WAP       : 'Wireless Bitmap (*.wap *.wbmp *.wbm)'
    }
    

  • __dict_ConverterParameters: dictionary relative to ConverterParamEnum:

    __dict_ConverterParameters = {
        sbsbakersenum.ConverterParamEnum.ADDITIONAL__INVERT_GREEN                           : 'Additional.InvertGreen',
        sbsbakersenum.ConverterParamEnum.ADDITIONAL__NORMAL_MAP                             : 'Additional.NormalMap',
        sbsbakersenum.ConverterParamEnum.ADDITIONAL__NORMAL_WORLD_SPACE                     : 'Additional.NormalWorldSpace',
        sbsbakersenum.ConverterParamEnum.COMMON__APPLY_DIFFUSION                            : 'Common.ApplyDiffusion',
        sbsbakersenum.ConverterParamEnum.COMMON__DILATION_WIDTH                             : 'Common.DilationWidth',
        sbsbakersenum.ConverterParamEnum.COMMON__UV_TILE                                    : 'Common.UVTile',
        sbsbakersenum.ConverterParamEnum.COMMON__UVSET                                      : 'Common.UVSet',
        sbsbakersenum.ConverterParamEnum.CURVATURE__CURVATURE_MULTIPLIER                    : 'Curvature.CurvMult',
        sbsbakersenum.ConverterParamEnum.CURVATURE__ENABLE_SEAMS                            : 'Curvature.EnableSeams',
        sbsbakersenum.ConverterParamEnum.CURVATURE__PER_VERTEX                              : 'Curvature.PerVertex',
        sbsbakersenum.ConverterParamEnum.CURVATURE__SEAMS_POWER                             : 'Curvature.SeamsPower',
        sbsbakersenum.ConverterParamEnum.DETAIL__FILTER_METHOD                              : 'Detail.FilterMethod',
        sbsbakersenum.ConverterParamEnum.DETAIL__IGNORE_BACKFACE                            : 'Detail.IgnoreBackface',
        sbsbakersenum.ConverterParamEnum.DETAIL__INVERT_SKEW_CORRECTION                     : 'Detail.InvertSkewCorrection',
        sbsbakersenum.ConverterParamEnum.DETAIL__LOW_AS_HIGH                                : 'Detail.LowAsHigh',
        sbsbakersenum.ConverterParamEnum.DETAIL__MAX_DEPTH                                  : 'Detail.MaxDepth',
        sbsbakersenum.ConverterParamEnum.DETAIL__MAX_HEIGHT                                 : 'Detail.MaxHeight',
        sbsbakersenum.ConverterParamEnum.DETAIL__RELATIVE_SCALE                             : 'Detail.RelativeScale',
        sbsbakersenum.ConverterParamEnum.DETAIL__SKEW_CORRECTION                            : 'Detail.SkewCorrection',
        sbsbakersenum.ConverterParamEnum.DETAIL__SKEW_MAP                                   : 'Detail.SkewMap',
        sbsbakersenum.ConverterParamEnum.DETAIL__SMOOTH_NORMALS                             : 'Detail.SmoothNormals',
        sbsbakersenum.ConverterParamEnum.DETAIL__SUB_SAMPLING                               : 'Detail.SubSampling',
        sbsbakersenum.ConverterParamEnum.DETAIL__USE_CAGE                                   : 'Detail.UseCage',
        sbsbakersenum.ConverterParamEnum.DETAIL_AO__ATTENUATION                             : 'Detail.AO.Attenuation',
        sbsbakersenum.ConverterParamEnum.DETAIL_COLOR__COLOR_GENERATOR                      : 'Detail.Color.ColorGenerator',
        sbsbakersenum.ConverterParamEnum.DETAIL_COLOR__COLOR_SOURCE                         : 'Detail.Color.ColorSource',
        sbsbakersenum.ConverterParamEnum.DETAIL_CURVATURE__INTENSITY                        : 'Detail.Curvature.Intensity',
        sbsbakersenum.ConverterParamEnum.DETAIL_CURVATURE__MAXIMIZE_RANGE                   : 'Detail.Curvature.MaximizeRange',
        sbsbakersenum.ConverterParamEnum.DETAIL_CURVATURE__SOFT_SATURATE                    : 'Detail.Curvature.SoftSaturate',
        sbsbakersenum.ConverterParamEnum.DETAIL_DISTANCE__MAXIMIZE_RANGE                    : 'Detail.Distance.MaximizeRange',
        sbsbakersenum.ConverterParamEnum.DETAIL_NORMAL_COMMON__INVERT_GREEN                 : 'Detail.NormalCommon.InvertGreen',
        sbsbakersenum.ConverterParamEnum.DETAIL_NORMAL_COMMON__RESULT_TYPE                  : 'Detail.NormalCommon.ResultType',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__DISTRIBUTION              : 'Detail.SecondaryCommon.Distribution',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__FILTER_METHOD             : 'Detail.SecondaryCommon.FilterMethodSecondary',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__IGNORE_BACKFACE_SECONDARY : 'Detail.SecondaryCommon.IgnoreBackfaceSecondary',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__MAX_DISTANCE              : 'Detail.SecondaryCommon.MaxDistance',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__MIN_DISTANCE              : 'Detail.SecondaryCommon.MinDistance',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__NB_SECONDARY              : 'Detail.SecondaryCommon.NbSecondary',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__RELATIVE_SCALE            : 'Detail.SecondaryCommon.MaxDistanceRelativeScale',
        sbsbakersenum.ConverterParamEnum.DETAIL_SECONDARY_COMMON__SPREAD                    : 'Detail.SecondaryCommon.Spread',
        sbsbakersenum.ConverterParamEnum.DETAIL_TEXTURE__FILTERING_MODE                     : 'Detail.Texture.FilteringMode',
        sbsbakersenum.ConverterParamEnum.DETAIL_TEXTURE__HIGH_POLY_UV_SET                   : 'Detail.Texture.HighPolyUVSet',
        sbsbakersenum.ConverterParamEnum.DETAIL_TEXTURE__IS_NORMAL_MAP                      : 'Detail.Texture.IsNormalMap',
        sbsbakersenum.ConverterParamEnum.DETAIL_TEXTURE__TEXTURE_FILE                       : 'Detail.Texture.TextureFileName',
        sbsbakersenum.ConverterParamEnum.NORMAL_WORLD_SPACE__BAKE_TYPE                      : 'NWS.BakeType',
        sbsbakersenum.ConverterParamEnum.POSITION__AXIS                                     : 'Position.Axis',
        sbsbakersenum.ConverterParamEnum.POSITION__MODE                                     : 'Position.Mode',
        sbsbakersenum.ConverterParamEnum.POSITION__NORMALIZATION                            : 'Position.Normalization',
        sbsbakersenum.ConverterParamEnum.POSITION__NORMALIZATION_SCALE                      : 'Position.NormalizationScale',
        sbsbakersenum.ConverterParamEnum.SEAO__DISTANCE_FADE                                : 'SeAO.DistanceFade',
        sbsbakersenum.ConverterParamEnum.SEAO__ERROR_BIAS                                   : 'SeAO.ErrorBias',
        sbsbakersenum.ConverterParamEnum.SEAO__INVERT_NORMALS                               : 'SeAO.InvertNormals',
        sbsbakersenum.ConverterParamEnum.SEAO__QUALITY                                      : 'SeAO.Quality',
        sbsbakersenum.ConverterParamEnum.SEAO__USE_NEIGHBORS                                : 'SeAO.UseNeighbors',
        sbsbakersenum.ConverterParamEnum.UV2SVG__COLOR_MODE                                 : 'UV2Svg.ColorMode',
        sbsbakersenum.ConverterParamEnum.UV2SVG__PADDING                                    : 'UV2Svg.Padding',
        sbsbakersenum.ConverterParamEnum.WORLD_DIRECTION__CONST_DIRECTION                   : 'WorldDirection.ConstDirection',
        sbsbakersenum.ConverterParamEnum.WORLD_DIRECTION__DIRECTION_MAP                     : 'WorldDirection.DirectionMap',
        sbsbakersenum.ConverterParamEnum.WORLD_DIRECTION__X                                 : 'WorldDirection.X',
        sbsbakersenum.ConverterParamEnum.WORLD_DIRECTION__Y                                 : 'WorldDirection.Y',
        sbsbakersenum.ConverterParamEnum.WORLD_DIRECTION__Z                                 : 'WorldDirection.Z',
        sbsbakersenum.ConverterParamEnum.DEFAULT__APPLY_DIFFUSION                           : 'applyDiffusion',
        sbsbakersenum.ConverterParamEnum.DEFAULT__AVERAGE_NORMALS                           : 'averageNormals',
        sbsbakersenum.ConverterParamEnum.DEFAULT__DILATION_WIDTH                            : 'dilationWidth',
        sbsbakersenum.ConverterParamEnum.DEFAULT__FORMAT                                    : 'format',
        sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_HEIGHT                             : 'outputSize/width',
        sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_WIDTH                              : 'outputSize/height',
        sbsbakersenum.ConverterParamEnum.DEFAULT__SUB_SAMPLING                              : 'subsampling',
        sbsbakersenum.ConverterParamEnum.DEFAULT__UV_TILE                                   : 'uvTiles',
        sbsbakersenum.ConverterParamEnum.DEFAULT__UVSET                                     : 'uvSet',
        sbsbakersenum.ConverterParamEnum.MESH__CAGE_PATH                                    : 'cagepath',
        sbsbakersenum.ConverterParamEnum.MESH__DISTANCE_WITH                                : 'distanceWith',
        sbsbakersenum.ConverterParamEnum.MESH__HIGH_DEF_MESHES                              : 'meshes',
        sbsbakersenum.ConverterParamEnum.MESH__HIGH_DEF_MESHES_MESH                         : 'mesh',
        sbsbakersenum.ConverterParamEnum.MESH__IGNORE_BACKFACE                              : 'ignoreBackface',
        sbsbakersenum.ConverterParamEnum.MESH__INVERT_SKEW_CORRECTION                       : 'invertSkew',
        sbsbakersenum.ConverterParamEnum.MESH__MATCH_METHOD                                 : 'matchBy',
        sbsbakersenum.ConverterParamEnum.MESH__MAX_FRONTAL_DISTANCE                         : 'frontal',
        sbsbakersenum.ConverterParamEnum.MESH__MAX_REAR_DISTANCE                            : 'rear',
        sbsbakersenum.ConverterParamEnum.MESH__RELATIVE_TO_BB                               : 'relativeToBb',
        sbsbakersenum.ConverterParamEnum.MESH__SKEW_PATH                                    : 'skewpath',
        sbsbakersenum.ConverterParamEnum.MESH__USE_CAGE                                     : 'useCage',
        sbsbakersenum.ConverterParamEnum.MESH__USE_LOW_AS_HIGH_POLY                         : 'useLowAsHighPoly',
        sbsbakersenum.ConverterParamEnum.MESH__USE_SKEW                                     : 'useSkew',
        sbsbakersenum.ConverterParamEnum.OUTPUT__FOLDER                                     : 'folder',
        sbsbakersenum.ConverterParamEnum.OUTPUT__IN_SUBFOLDER                               : 'placeIntoSpecificFolder',
        sbsbakersenum.ConverterParamEnum.OUTPUT__RESOURCE_METHOD                            : 'resourceMethod',
        sbsbakersenum.ConverterParamEnum.OUTPUT__RESOURCE_NAME                              : 'nameScheme'
    }
    

  • __dict_CommonToDefault: dictionary that relates specific baker options to global options relative to ConverterParamEnum:

    __dict_CommonToDefault = {
        sbsbakersenum.ConverterParamEnum.DEFAULT__FORMAT         : sbsbakersenum.ConverterParamEnum.DEFAULT__FORMAT,
        sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_HEIGHT  : sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_HEIGHT,
        sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_WIDTH   : sbsbakersenum.ConverterParamEnum.DEFAULT__OUTPUT_WIDTH,
        sbsbakersenum.ConverterParamEnum.COMMON__UV_TILE         : sbsbakersenum.ConverterParamEnum.DEFAULT__UV_TILE,
        sbsbakersenum.ConverterParamEnum.COMMON__UVSET           : sbsbakersenum.ConverterParamEnum.DEFAULT__UVSET,
        sbsbakersenum.ConverterParamEnum.COMMON__APPLY_DIFFUSION : sbsbakersenum.ConverterParamEnum.DEFAULT__APPLY_DIFFUSION,
        sbsbakersenum.ConverterParamEnum.COMMON__DILATION_WIDTH  : sbsbakersenum.ConverterParamEnum.DEFAULT__DILATION_WIDTH,
        sbsbakersenum.ConverterParamEnum.DETAIL__SMOOTH_NORMALS  : sbsbakersenum.ConverterParamEnum.DEFAULT__AVERAGE_NORMALS,
        sbsbakersenum.ConverterParamEnum.DETAIL__SUB_SAMPLING    : sbsbakersenum.ConverterParamEnum.DEFAULT__SUB_SAMPLING,
    }
    

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)

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)

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)

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)

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)

Get the given baker property name

Parameters:

aConverterParam (ConverterParamEnum) – converter property identifier

Returns:

the converter parameter as a string

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