sbsdictionaries module

Module sbsdictionaries provides the dictionaries to have the mapping between the enumerations in sbsenum and the corresponding string identifier used by Substance Designer.

  • Dictionaries:
    • __dict_Attributes: dictionary relative to AttributesEnum:

      __dict_Attributes = {
          sbsenum.AttributesEnum.Category      : 'category'     ,
          sbsenum.AttributesEnum.Label         : 'label'        ,
          sbsenum.AttributesEnum.Author        : 'author'       ,
          sbsenum.AttributesEnum.AuthorURL     : 'authorURL'    ,
          sbsenum.AttributesEnum.Tags          : 'tags'         ,
          sbsenum.AttributesEnum.Description   : 'description'  ,
          sbsenum.AttributesEnum.UserTags      : 'usertags'     ,
          sbsenum.AttributesEnum.Icon          : 'icon'         ,
          sbsenum.AttributesEnum.HideInLibrary : 'hideInLibrary',
          sbsenum.AttributesEnum.PhysicalSize  : 'physicalSize' ,
          sbsenum.AttributesEnum.MaterialModel : 'materialModel',
      }
      
    • __dict_CommonUsageComponents: dictionary relative to ComponentsEnum:

      __dict_CommonUsageComponents = {
          sbsenum.ComponentsEnum.RGBA : 'RGBA',
          sbsenum.ComponentsEnum.RGB  : 'RGB' ,
          sbsenum.ComponentsEnum.R    : 'R'   ,
          sbsenum.ComponentsEnum.G    : 'G'   ,
          sbsenum.ComponentsEnum.B    : 'B'   ,
          sbsenum.ComponentsEnum.A    : 'A'   ,
          sbsenum.ComponentsEnum.RG   : 'RG'  
      }
      
    • __dict_CommonUsages: dictionary relative to UsageEnum:

      __dict_CommonUsages = {
          sbsenum.UsageEnum.DIFFUSE                             : 'diffuse'                ,
          sbsenum.UsageEnum.BASECOLOR                           : 'baseColor'              ,
          sbsenum.UsageEnum.OPACITY                             : 'opacity'                ,
          sbsenum.UsageEnum.EMISSIVE                            : 'emissive'               ,
          sbsenum.UsageEnum.AMBIENT                             : 'ambient'                ,
          sbsenum.UsageEnum.AMBIENT_OCCLUSION                   : 'ambientOcclusion'       ,
          sbsenum.UsageEnum.MASK                                : 'mask'                   ,
          sbsenum.UsageEnum.NORMAL                              : 'normal'                 ,
          sbsenum.UsageEnum.BUMP                                : 'bump'                   ,
          sbsenum.UsageEnum.HEIGHT                              : 'height'                 ,
          sbsenum.UsageEnum.DISPLACEMENT                        : 'displacement'           ,
          sbsenum.UsageEnum.SPECULAR                            : 'specular'               ,
          sbsenum.UsageEnum.SPECULAR_LEVEL                      : 'specularLevel'          ,
          sbsenum.UsageEnum.SPECULAR_COLOR                      : 'specularColor'          ,
          sbsenum.UsageEnum.GLOSSINESS                          : 'glossiness'             ,
          sbsenum.UsageEnum.ROUGHNESS                           : 'roughness'              ,
          sbsenum.UsageEnum.ANISOTROPY_LEVEL                    : 'anisotropyLevel'        ,
          sbsenum.UsageEnum.ANISOTROPY_ANGLE                    : 'anisotropyAngle'        ,
          sbsenum.UsageEnum.TRANSMISSIVE                        : 'transmissive'           ,
          sbsenum.UsageEnum.REFLECTION                          : 'reflection'             ,
          sbsenum.UsageEnum.REFRACTION                          : 'refraction'             ,
          sbsenum.UsageEnum.COAT_WEIGHT                         : 'coatWeight'             ,
          sbsenum.UsageEnum.COAT_SPECULAR_LEVEL                 : 'coatSpecularLevel'      ,
          sbsenum.UsageEnum.COAT_COLOR                          : 'coatColor'              ,
          sbsenum.UsageEnum.COAT_ROUGHNESS                      : 'coatRoughness'          ,
          sbsenum.UsageEnum.COAT_NORMAL                         : 'coatNormal'             ,
          sbsenum.UsageEnum.ENVIRONMENT                         : 'environment'            ,
          sbsenum.UsageEnum.IOR                                 : 'IOR'                    ,
          sbsenum.UsageEnum.SCATTERING                          : 'scattering'             ,
          sbsenum.UsageEnum.SCATTERING0                         : 'scattering0'            ,
          sbsenum.UsageEnum.SCATTERING1                         : 'scattering1'            ,
          sbsenum.UsageEnum.SCATTERING2                         : 'scattering2'            ,
          sbsenum.UsageEnum.SCATTERING3                         : 'scattering3'            ,
          sbsenum.UsageEnum.ANY                                 : 'any'                    ,
          sbsenum.UsageEnum.METALLIC                            : 'metallic'               ,
          sbsenum.UsageEnum.PANORAMA                            : 'panorama'               ,
          sbsenum.UsageEnum.PHYSICALSIZE                        : 'physicalSize'           ,
          sbsenum.UsageEnum.EMISSIVE_INTENSITY                  : 'emissiveIntensity'      ,
          sbsenum.UsageEnum.HEIGHT_SCALE                        : 'heightScale'            ,
          sbsenum.UsageEnum.HEIGHT_LEVEL                        : 'heightLevel'            ,
          sbsenum.UsageEnum.SPECULAR_EDGE_COLOR                 : 'specularEdgeColor'      ,
          sbsenum.UsageEnum.COAT_OPACITY                        : 'coatOpacity'            ,
          sbsenum.UsageEnum.COAT_IOR                            : 'coatIOR'                ,
          sbsenum.UsageEnum.DISPERSION                          : 'dispersion'             ,
          sbsenum.UsageEnum.TRANSLUCENCY                        : 'translucency'           ,
          sbsenum.UsageEnum.ABSORPTION_COLOR                    : 'absorptionColor'        ,
          sbsenum.UsageEnum.ABSORPTION_DISTANCE                 : 'absorptionDistance'     ,
          sbsenum.UsageEnum.SCATTERING_COLOR                    : 'scatteringColor'        ,
          sbsenum.UsageEnum.SCATTERING_DISTANCE                 : 'scatteringDistance'     ,
          sbsenum.UsageEnum.SCATTERING_DISTANCE_SCALE           : 'scatteringDistanceScale',
          sbsenum.UsageEnum.SCATTERING_REDSHIFT                 : 'scatteringRedShift'     ,
          sbsenum.UsageEnum.SCATTERING_RAYLEIGH                 : 'scatteringRayleigh'     ,
          sbsenum.UsageEnum.SHEEN_OPACITY                       : 'sheenOpacity'           ,
          sbsenum.UsageEnum.SHEEN_COLOR                         : 'sheenColor'             ,
          sbsenum.UsageEnum.SHEEN_ROUGHNESS                     : 'sheenRoughness'         ,
          # Inherited from the 3DView
          sbsenum.UsageEnum.BLUENOISE_MASK                      : 'bluenoisemask',
          sbsenum.UsageEnum.DETAIL_NORMAL                       : 'detailNormal' ,
          # New usages for OpenPBR 1.2
          # (see Wiki page: https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=3DI&title=OpenPBR+integration+in+Substance+Ecosystem)
          sbsenum.UsageEnum.BASE_DIFFUSE_ROUGHNESS              : 'baseDiffuseRoughness'            ,
          sbsenum.UsageEnum.METALNESS                           : 'metalness'                       ,
          sbsenum.UsageEnum.BASE_WEIGHT                         : 'baseWeight'                      ,
          sbsenum.UsageEnum.SPECULAR_WEIGHT                     : 'specularWeight'                  ,
          sbsenum.UsageEnum.SPECULAR_ROUGHNESS                  : 'specularRoughness'               ,
          sbsenum.UsageEnum.SPECULAR_ROUGHNESS_ANISOTROPY       : 'specularRoughnessAnisotropy'     ,
          sbsenum.UsageEnum.SPECULAR_IOR                        : 'specularIOR'                     ,
          sbsenum.UsageEnum.TRANSMISSION_WEIGHT                 : 'transmissionWeight'              ,
          sbsenum.UsageEnum.TRANSMISSION_COLOR                  : 'transmissionColor'               ,
          sbsenum.UsageEnum.TRANSMISSION_DEPTH                  : 'transmissionDepth'               ,
          sbsenum.UsageEnum.TRANSMISSION_SCATTER                : 'transmissionScatter'             ,
          sbsenum.UsageEnum.TRANSMISSION_SCATTER_ANISOTROPY     : 'transmissionScatterAnisotropy'   ,
          sbsenum.UsageEnum.TRANSMISSION_DISPERSION_SCALE       : 'transmissionDispersionScale'     ,
          sbsenum.UsageEnum.TRANSMISSION_DISPERSION_ABBE_NUMBER : 'transmissionDispersionAbbeNumber',
          sbsenum.UsageEnum.SUBSURFACE_WEIGHT                   : 'subsurfaceWeight'                ,
          sbsenum.UsageEnum.SUBSURFACE_COLOR                    : 'subsurfaceColor'                 ,
          sbsenum.UsageEnum.SUBSURFACE_RADIUS                   : 'subsurfaceRadius'                ,
          sbsenum.UsageEnum.SUBSURFACE_RADIUS_SCALE             : 'subsurfaceRadiusScale'           ,
          sbsenum.UsageEnum.SUBSURFACE_SCATTER_ANISOTROPY       : 'subsurfaceScatterAnisotropy'     ,
          sbsenum.UsageEnum.COAT_ROUGHNESS_ANISOTROPY           : 'coatRoughnessAnisotropy'         ,
          sbsenum.UsageEnum.COAT_DARKENING                      : 'coatDarkening'                   ,
          sbsenum.UsageEnum.FUZZ_WEIGHT                         : 'fuzzWeight'                      ,
          sbsenum.UsageEnum.FUZZ_COLOR                          : 'fuzzColor'                       ,
          sbsenum.UsageEnum.FUZZ_ROUGHNESS                      : 'fuzzRoughness'                   ,
          sbsenum.UsageEnum.EMISSION_WEIGHT                     : 'emissionWeight'                  ,
          sbsenum.UsageEnum.EMISSION_LUMINANCE                  : 'emissionLuminance'               ,
          sbsenum.UsageEnum.EMISSION_COLOR                      : 'emissionColor'                   ,
          sbsenum.UsageEnum.THIN_FILM_WEIGHT                    : 'thinFilmWeight'                  ,
          sbsenum.UsageEnum.THIN_FILM_THICKNESS                 : 'thinFilmThickness'               ,
          sbsenum.UsageEnum.THIN_FILM_IOR                       : 'thinFilmIOR'                     ,
          sbsenum.UsageEnum.THIN_WALLED                         : 'thinWalled'                      ,
          sbsenum.UsageEnum.TANGENT                             : 'tangent'                         ,
          sbsenum.UsageEnum.COAT_TANGENT                        : 'coatTangent'                     ,
      }
      
    • __dict_CompNodeInputs: dictionary relative to InputEnum:

      __dict_CompNodeInputs = {
          sbsenum.InputEnum.BACKGROUND        : 'background'      ,
          sbsenum.InputEnum.DESTINATION       : 'destination'     ,
          sbsenum.InputEnum.INPUT             : 'input'           ,
          sbsenum.InputEnum.INPUT1            : 'input1'          ,
          sbsenum.InputEnum.INPUT2            : 'input2'          ,
          sbsenum.InputEnum.INPUT_GRADIENT    : 'inputgradient'   ,
          sbsenum.InputEnum.INPUT_INTENSITY   : 'inputintensity'  ,
          sbsenum.InputEnum.INPUT_NODE_OUTPUT : 'inputNodeOutput' ,
          sbsenum.InputEnum.INPUT_PATTERN     : 'inputpattern'    ,
          sbsenum.InputEnum.MASK              : 'mask'            ,
          sbsenum.InputEnum.OPACITY           : 'opacity'         ,
          sbsenum.InputEnum.SOURCE            : 'source'
      }
      
    • __dict_CompNodeOutputs: dictionary relative to OutputEnum:

      __dict_CompNodeOutputs = {
          sbsenum.OutputEnum.OUTPUT  : 'output'   ,
          sbsenum.OutputEnum.OUTPUT0 : 'output0'  ,
          sbsenum.OutputEnum.OUTPUT1 : 'output1'  ,
          sbsenum.OutputEnum.OUTPUT2 : 'output2'  ,
          sbsenum.OutputEnum.OUTPUT3 : 'output3'  ,
          sbsenum.OutputEnum.OUTPUTN : 'outputn'  ,
      }
      
    • __dict_CompNodeParameters: dictionary relative to CompNodeParamEnum:

      __dict_CompNodeParameters = {
          sbsenum.CompNodeParamEnum.OUTPUT_FORMAT         : 'format'              ,
          sbsenum.CompNodeParamEnum.OUTPUT_SIZE           : 'outputsize'          ,
          sbsenum.CompNodeParamEnum.PIXEL_SIZE            : 'pixelsize'           ,
          sbsenum.CompNodeParamEnum.PIXEL_RATIO           : 'pixelratio'          ,
          sbsenum.CompNodeParamEnum.QUALITY               : 'quality'             ,
          sbsenum.CompNodeParamEnum.RANDOM_SEED           : 'randomseed'          ,
          sbsenum.CompNodeParamEnum.TILING_MODE           : 'tiling'              ,
          sbsenum.CompNodeParamEnum.ITERATION             : 'iteration'           ,
          sbsenum.CompNodeParamEnum.ALPHA_BLENDING        : 'colorblending'       ,
          sbsenum.CompNodeParamEnum.BACKGROUND            : 'background'          ,
          sbsenum.CompNodeParamEnum.BACKGROUND_VALUE      : 'mattelevel'          ,
          sbsenum.CompNodeParamEnum.BITMAP_RESOURCE_PATH  : 'bitmapresourcepath'  ,
          sbsenum.CompNodeParamEnum.BITMAP_RESIZE_METHOD  : 'resizemethod'        ,
          sbsenum.CompNodeParamEnum.BLENDING_MODE         : 'blendingmode'        ,
          sbsenum.CompNodeParamEnum.BLUR_ANGLE            : 'mblurangle'          ,
          sbsenum.CompNodeParamEnum.CHANNEL_ALPHA         : 'channelalpha'        ,
          sbsenum.CompNodeParamEnum.CHANNEL_BLUE          : 'channelgreen'        ,
          sbsenum.CompNodeParamEnum.CHANNEL_GREEN         : 'channelblue'         ,
          sbsenum.CompNodeParamEnum.CHANNEL_RED           : 'channelred'          ,
          sbsenum.CompNodeParamEnum.CHANNELS_WEIGHTS      : 'channelsweights'     ,
          sbsenum.CompNodeParamEnum.CLAMP_IN_TERM         : 'clampinterm'         ,
          sbsenum.CompNodeParamEnum.COLOR_MODE            : 'colorswitch'         ,
          sbsenum.CompNodeParamEnum.COMBINE_DISTANCE      : 'combinedistance'     ,
          sbsenum.CompNodeParamEnum.CROPPING_AREA         : 'maskrectangle'       ,
          sbsenum.CompNodeParamEnum.FILTERING             : 'filtering'           ,
          sbsenum.CompNodeParamEnum.FLATTEN_ALPHA         : 'alphamult'           ,
          sbsenum.CompNodeParamEnum.GRADIENT_ADDRESSING   : 'addressingrepeat'    ,
          sbsenum.CompNodeParamEnum.GRADIENT_ORIENTATION  : 'uvselector'          ,
          sbsenum.CompNodeParamEnum.GRADIENT_POSITION     : 'coordinate'          ,
          sbsenum.CompNodeParamEnum.HIGHLIGHT_COLOR       : 'highlightcolor'      ,
          sbsenum.CompNodeParamEnum.HUE                   : 'hue'                 ,
          sbsenum.CompNodeParamEnum.INTENSITY             : 'intensity'           ,
          sbsenum.CompNodeParamEnum.NORMAL_FORMAT         : 'inversedy'           ,
          sbsenum.CompNodeParamEnum.LEVEL_IN_HIGH         : 'levelinhigh'         ,
          sbsenum.CompNodeParamEnum.LEVEL_IN_LOW          : 'levelinlow'          ,
          sbsenum.CompNodeParamEnum.LEVEL_IN_MID          : 'levelinmid'          ,
          sbsenum.CompNodeParamEnum.LEVEL_OUT_HIGH        : 'levelouthigh'        ,
          sbsenum.CompNodeParamEnum.LEVEL_OUT_LOW         : 'leveloutlow'         ,
          sbsenum.CompNodeParamEnum.LIGHT_ANGLE           : 'lightangle'          ,
          sbsenum.CompNodeParamEnum.LIGHTNESS             : 'luminosity'          ,
          sbsenum.CompNodeParamEnum.MIPMAP_LEVEL          : 'manualmiplevel'      ,
          sbsenum.CompNodeParamEnum.MATTE_COLOR           : 'mattecolor'          ,
          sbsenum.CompNodeParamEnum.MAX_DISTANCE          : 'distance'            ,
          sbsenum.CompNodeParamEnum.MIPMAP_MODE           : 'mipmapmode'          ,
          sbsenum.CompNodeParamEnum.OPACITY               : 'opacitymult'         ,
          sbsenum.CompNodeParamEnum.OFFSET                : 'offset'              ,
          sbsenum.CompNodeParamEnum.OUTPUT_COLOR          : 'outputcolor'         ,
          sbsenum.CompNodeParamEnum.PER_PIXEL             : 'perpixel'            ,
          sbsenum.CompNodeParamEnum.FUNCTION              : 'function'            ,
          sbsenum.CompNodeParamEnum.RENDER_REGION         : 'renderroi'           ,
          sbsenum.CompNodeParamEnum.ROUGHNESS             : 'hurst'               ,
          sbsenum.CompNodeParamEnum.SATURATION            : 'saturation'          ,
          sbsenum.CompNodeParamEnum.SHADOW_COLOR          : 'shadowcolor'         ,
          sbsenum.CompNodeParamEnum.SVG_RESOURCE_PATH     : 'vectorresourcepath'  ,
          sbsenum.CompNodeParamEnum.TEXT                  : 'text'                ,
          sbsenum.CompNodeParamEnum.TEXT_ALIGN            : 'alignment'           ,
          sbsenum.CompNodeParamEnum.TEXT_FONT             : 'fontdata'            ,
          sbsenum.CompNodeParamEnum.TEXT_FONT_SIZE        : 'fontsize'            ,
          sbsenum.CompNodeParamEnum.TEXT_FONT_COLOR       : 'frontcolor'          ,
          sbsenum.CompNodeParamEnum.TEXT_POSITION         : 'position'            ,
          sbsenum.CompNodeParamEnum.TILING_REGION         : 'tilingroi'           ,
          sbsenum.CompNodeParamEnum.TRANSFORM_MATRIX      : 'matrix22'            ,
          sbsenum.CompNodeParamEnum.WARP_ANGLE            : 'warpangle'           ,
          sbsenum.CompNodeParamEnum.NORMAL_ALPHA_CHANNEL  : 'input2alpha'         ,
          sbsenum.CompNodeParamEnum.FX_BLENDING_MODE      : 'blendingmode'        ,
          sbsenum.CompNodeParamEnum.FX_BRANCH_OFFSET      : 'branchoffset'        ,
          sbsenum.CompNodeParamEnum.FX_COLOR_LUM          : 'opacity'             ,
          sbsenum.CompNodeParamEnum.FX_IMAGE_ALPHA_PREMUL : 'imagepremul'         ,
          sbsenum.CompNodeParamEnum.FX_IMAGE_FILTERING    : 'imagefiltering'      ,
          sbsenum.CompNodeParamEnum.FX_IMAGE_INDEX        : 'imageindex'          ,
          sbsenum.CompNodeParamEnum.FX_ITERATIONS         : 'numberadded'         ,
          sbsenum.CompNodeParamEnum.FX_PATTERN_OFFSET     : 'frameoffset'         ,
          sbsenum.CompNodeParamEnum.FX_PATTERN_ROTATION   : 'patternrotation'     ,
          sbsenum.CompNodeParamEnum.FX_PATTERN_SIZE       : 'patternsize'         ,
          sbsenum.CompNodeParamEnum.FX_PATTERN_TYPE       : 'patterntype'         ,
          sbsenum.CompNodeParamEnum.FX_PATTERN_VARIATION  : 'patternsuppl'        ,
          sbsenum.CompNodeParamEnum.FX_RANDOM_INHERITED   : 'randominherited'     ,
          sbsenum.CompNodeParamEnum.FX_RANDOM_SEED        : 'randomseed'          ,
          sbsenum.CompNodeParamEnum.FX_SELECTOR           : 'switch'
      }
      
    • __dict_CurveTypes: dictionary relative to CurveTypeEnum:

      __dict_CurveTypes = {
          sbsenum.CurveTypeEnum.LUMINANCE : 'curveluminance',
          sbsenum.CurveTypeEnum.RED       : 'curvered',
          sbsenum.CurveTypeEnum.GREEN     : 'curvegreen',
          sbsenum.CurveTypeEnum.BLUE      : 'curveblue',
          sbsenum.CurveTypeEnum.ALPHA     : 'curvealpha',
      }
      
    • __dict_FunctionInputs: dictionary relative to FunctionInputEnum:

      __dict_FunctionInputs = {
          sbsenum.FunctionInputEnum.A               : 'a'              ,
          sbsenum.FunctionInputEnum.B               : 'b'              ,
          sbsenum.FunctionInputEnum.COMPONENTS_IN   : 'componentsin'   ,
          sbsenum.FunctionInputEnum.COMPONENTS_LAST : 'componentslast' ,
          sbsenum.FunctionInputEnum.CONDITION       : 'condition'      ,
          sbsenum.FunctionInputEnum.ELSE_PATH       : 'elsepath'       ,
          sbsenum.FunctionInputEnum.ENTRIES         : 'entries'        ,
          sbsenum.FunctionInputEnum.IF_PATH         : 'ifpath'         ,
          sbsenum.FunctionInputEnum.LOOP            : 'loop'           ,
          sbsenum.FunctionInputEnum.POS             : 'pos'            ,
          sbsenum.FunctionInputEnum.RHO             : 'rho'            ,
          sbsenum.FunctionInputEnum.SCALAR          : 'scalar'         ,
          sbsenum.FunctionInputEnum.SEQUENCE_IN     : 'seqin'          ,
          sbsenum.FunctionInputEnum.SEQUENCE_LAST   : 'seqlast'        ,
          sbsenum.FunctionInputEnum.THETA           : 'theta'          ,
          sbsenum.FunctionInputEnum.VALUE           : 'value'          ,
          sbsenum.FunctionInputEnum.VECTOR          : 'vector'         ,
          sbsenum.FunctionInputEnum.X               : 'x'              ,
          sbsenum.FunctionInputEnum.INPUT           : 'input'          ,
          sbsenum.FunctionInputEnum.INIT            : 'init'           ,
          sbsenum.FunctionInputEnum.COND            : 'cond'
      }
      
    • __dict_GUIObjectTypes: dictionary relative to GUIObjectTypeEnum:

      __dict_GUIObjectTypes = {
          sbsenum.GUIObjectTypeEnum.COMMENT : 'COMMENT',
          sbsenum.GUIObjectTypeEnum.PIN     : 'PIN'
      }
      
    • __dict_ResourceTypes: dictionary relative to ResourceTypeEnum:

      __dict_ResourceTypes = {
          sbsenum.ResourceTypeEnum.NONE           : ''                ,
          sbsenum.ResourceTypeEnum.FONT           : 'font'            ,
          sbsenum.ResourceTypeEnum.SVG            : 'svg'             ,
          sbsenum.ResourceTypeEnum.BITMAP         : 'bitmap'          ,
          sbsenum.ResourceTypeEnum.M_BSDF         : 'bsdfmeasurement' ,
          sbsenum.ResourceTypeEnum.LIGHT_PROFILE  : 'lightprofile'    ,
          sbsenum.ResourceTypeEnum.SCENE          : 'scene'           ,
      }
      
    • __dict_WidgetTypes: dictionary relative to WidgetTypeEnum:

      __dict_WidgetTypes = {
          sbsenum.WidgetTypeEnum.BUTTON                 : 'buttons'          ,
          sbsenum.WidgetTypeEnum.SLIDER                 : 'slider'           ,
          sbsenum.WidgetTypeEnum.DROP_DOWN_LIST         : 'dropdownlist'     ,
          sbsenum.WidgetTypeEnum.SIZE_POW_2             : 'sizepow2'         ,
          sbsenum.WidgetTypeEnum.ANGLE                  : 'angle'            ,
          sbsenum.WidgetTypeEnum.COLOR                  : 'color'            ,
          sbsenum.WidgetTypeEnum.TEXT                   : 'text'             ,
          sbsenum.WidgetTypeEnum.TRANSFORMATION_INVERSE : 'transformation'   ,
          sbsenum.WidgetTypeEnum.TRANSFORMATION_FORWARD : 'straighttransform',
          sbsenum.WidgetTypeEnum.POSITION               : 'position'         ,
          sbsenum.WidgetTypeEnum.OFFSET                 : 'reverseposition'  ,
          sbsenum.WidgetTypeEnum.ENUMBUTTONS            : 'enumbuttons'      ,
          sbsenum.WidgetTypeEnum.FUNCTIONBUTTON         : 'functionbutton'
      }
      
    • __dict_WidgetOptions: dictionary relative to WidgetOptionEnum:

      __dict_WidgetOptions = {
          sbsenum.WidgetOptionEnum.BOOL_EDITOR_TYPE     : 'booleditortype'       ,
          sbsenum.WidgetOptionEnum.CLAMP                : 'clamp'                ,
          sbsenum.WidgetOptionEnum.DEFAULT              : 'default'              ,
          sbsenum.WidgetOptionEnum.LABEL0               : 'label0'               ,
          sbsenum.WidgetOptionEnum.LABEL1               : 'label1'               ,
          sbsenum.WidgetOptionEnum.LABEL2               : 'label2'               ,
          sbsenum.WidgetOptionEnum.LABEL3               : 'label3'               ,
          sbsenum.WidgetOptionEnum.MAX                  : 'max'                  ,
          sbsenum.WidgetOptionEnum.MIN                  : 'min'                  ,
          sbsenum.WidgetOptionEnum.PARAMETERS           : 'parameters'           ,
          sbsenum.WidgetOptionEnum.STEP                 : 'step'                 ,
          sbsenum.WidgetOptionEnum.VALUE_INTERPRETATION : 'valueInterpretation'
      }
      
    • __dict_SubstanceGraphTemplate: dictionary relative to GraphTemplateEnum:

      __dict_SubstanceGraphTemplate = {
          sbsenum.GraphTemplateEnum.EMPTY                              : 'sbs://../templates/09_01_empty.sbs/empty'                                                  ,
          sbsenum.GraphTemplateEnum.PBR_METALLIC_ROUGHNESS             : 'sbs://../templates/01_01_pbr_metallic_roughness.sbs/metallic_roughness'                ,
          sbsenum.GraphTemplateEnum.PBR_SPECULAR_GLOSSINESS            : 'sbs://../templates/01_02_pbr_specular_glossiness.sbs/specular_glossiness'              ,
          sbsenum.GraphTemplateEnum.STANDARD                           : 'sbs://../templates/02_01_blinn.sbs/blinn'                                            ,
          sbsenum.GraphTemplateEnum.SCAN_PBR_METALLIC_ROUGHNESS        : 'sbs://../templates/10_01_scan_pbr_metallic_roughness.sbs/scan_metallic_roughness'      ,
          sbsenum.GraphTemplateEnum.SCAN_PBR_SPECULAR_GLOSSINESS       : 'sbs://../templates/10_02_scan_pbr_specular_glossiness.sbs/scan_specular_glossiness'    ,
          sbsenum.GraphTemplateEnum.AXF_2_PBR_METALLIC_ROUGHNESS       : 'sbs://../templates/08_01_axf_to_pbr_metallic_roughness.sbs/axf_to_metallic_roughness'  ,
          sbsenum.GraphTemplateEnum.AXF_2_PBR_SPECULAR_GLOSSINESS      : 'sbs://../templates/08_02_axf_to_pbr_specular_glossiness.sbs/axf_to_specular_glossiness',
          sbsenum.GraphTemplateEnum.STUDIO_PANORAMA                    : 'sbs://../templates/06_01_studio_panorama.sbs/studio_panorama'                              ,
          sbsenum.GraphTemplateEnum.PAINTER_FILTER_GENERIC             : 'sbs://../templates/07_01_substance_painter.sbs/sp_filter_generic'                          ,
          sbsenum.GraphTemplateEnum.PAINTER_FILTER_SPECIFIC            : 'sbs://../templates/07_01_substance_painter.sbs/sp_filter_specific'                         ,
          sbsenum.GraphTemplateEnum.PAINTER_FILTER_SPECIFIC_MORE_MAPS  : 'sbs://../templates/07_01_substance_painter.sbs/sp_filter_channel_additional_maps'          ,
          sbsenum.GraphTemplateEnum.PAINTER_GENERATOR_MORE_MAPS        : 'sbs://../templates/07_01_substance_painter.sbs/sp_generator_additional_maps',
          sbsenum.GraphTemplateEnum.SAMPLER_FILTER                     : 'sbs://../templates/07_02_substance_sampler.sbs/sampler_filter'
      }
      
pysbs.sbslibrary.sbsdictionaries.getAttribute(aAttribute)

Get the given attribute name

Parameters:

aAttribute (AttributesEnum) – attribute identifier

Returns:

the attribute as a string

pysbs.sbslibrary.sbsdictionaries.getColorSpace(aColorSpace))

Get the given color space name

Parameters:

aColorSpace (ColorSpacesEnum) – color space identifier

Returns:

the color space as a string

pysbs.sbslibrary.sbsdictionaries.getColorSpaceEnum(aColorSpaceName)

Get the enum value of the given parameter

Parameters:

aColorSpaceName (str) – parameter identifier

Returns:

the parameter as a ColorSpacesEnum if found, None otherwise

pysbs.sbslibrary.sbsdictionaries.getCompNodeInput(aInput)

Get the given compositing node input name

Parameters:

aInput (InputEnum) – input identifier

Returns:

the input as a string

pysbs.sbslibrary.sbsdictionaries.getCompNodeInputEnum(aInputName)

Get the enum value of the given input

Parameters:

aInputName (str) – input identifier

Returns:

the input as a InputEnum

pysbs.sbslibrary.sbsdictionaries.getCompNodeOutput(aOutput)

Get the given compositing node output name

Parameters:

aOutput (OutputEnum) – output identifier

Returns:

the output as a string

pysbs.sbslibrary.sbsdictionaries.getCompNodeOutputEnum(aOutputName)

Get the enum value of the given output

Parameters:

aOutputName (str) – output identifier

Returns:

the output as a OutputEnum

pysbs.sbslibrary.sbsdictionaries.getCompNodeParam(aParameter)

Get the given compositing node parameter name

Parameters:

aParameter (CompNodeParamEnum) – parameter identifier

Returns:

the parameter as a string

pysbs.sbslibrary.sbsdictionaries.getCompNodeParamEnum(aParameterName)

Get the enum value of the given parameter

Parameters:

aParameterName (str) – parameter identifier

Returns:

the parameter as a CompNodeParamEnum if found, None otherwise

pysbs.sbslibrary.sbsdictionaries.getComponents(aComponents)

Get the given components name

Parameters:

aComponents (ComponentsEnum) – components identifier

Returns:

the components as a string

pysbs.sbslibrary.sbsdictionaries.getCurveName(aCurveType)

Get the given curve type name

Parameters:

aCurveType (CurveTypeEnum) – curve type identifier

Returns:

the curve type as a string

pysbs.sbslibrary.sbsdictionaries.getCurveTypeEnum(aCurveName)

Get the enum value of the given curve name

Parameters:

aCurveName (str) – curve name

Returns:

the curve type as a CurveTypeEnum

pysbs.sbslibrary.sbsdictionaries.getFunctionGetType(aType)

Get the appropriate function GET_<> depending on the type of the input parameter

Parameters:

aType (ParamTypeEnum) – the type of data to get

Returns:

the function GET_<> corresponding to the given type if succeed, None otherwise

pysbs.sbslibrary.sbsdictionaries.getFunctionInput(aInput)

Get the given function node input name

Parameters:

aInput (FunctionInputEnum) – input identifier

Returns:

the input as a string

pysbs.sbslibrary.sbsdictionaries.getFunctionInputEnum(aInputName)

Get the enum value of the given function input

Parameters:

aInputName (str) – input identifier

Returns:

the input as a FunctionInputEnum

pysbs.sbslibrary.sbsdictionaries.getFunctionOutput(aOutput)

Get the given function node output name

Parameters:

aOutput (OutputEnum) – output identifier

Returns:

the input as a string

pysbs.sbslibrary.sbsdictionaries.getFunctionOutputEnum(aOutputName)

Get the enum value of the given function output

Parameters:

aOutputName (str) – output identifier

Returns:

the input as a OutputEnum

pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeEnum(aGUIObjectTypeName)

Get the enum value of the given curve name

Parameters:

aGUIObjectTypeName (str) – GUI object type name

Returns:

the curve type as a GUIObjectTypeEnum

pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeName(aGUIObjectType)

Get the given GUI object type name

Parameters:

aGUIObjectType (GUIObjectTypeEnum) – GUI object type identifier

Returns:

the GUI object type as a string

pysbs.sbslibrary.sbsdictionaries.getResourceTypeEnum(aResourceName)

Get the enum value of the given resource name

Parameters:

aResourceName (str) – resource name

Returns:

the curve type as a ResourceTypeEnum

pysbs.sbslibrary.sbsdictionaries.getResourceTypeName(aResourceType)

Get the given resource type name

Parameters:

aResourceType (ResourceTypeEnum) – resource type identifier

Returns:

the curve type as a string

pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphTemplatePath(aTemplateEnum)

Get the path of the given Substance Graph template

Parameters:

aTemplateEnum (GraphTemplateEnum) – Substance Graph template

Returns:

the path to the template as a string

pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphType(aTypeEnum)

Get the type value of the given Substance Graph type

Parameters:

aTypeEnum (GraphTypeEnum) – Substance Graph type

Returns:

the graph type value as str

pysbs.sbslibrary.sbsdictionaries.getSubstanceMaterialModel(aMaterialModelEnum)

Get the value of the given Substance material model

Parameters:

aMaterialModelEnum (MaterialModelEnum) – Substance material model

Returns:

the material model as str

pysbs.sbslibrary.sbsdictionaries.getUsage(aUsage)

Get the given usage name

Parameters:

aUsage (UsageEnum) – usage identifier

Returns:

the usage as a string

pysbs.sbslibrary.sbsdictionaries.getWidgetName(aWidgetType)

Get the given widget type name

Parameters:

aWidgetType (WidgetTypeEnum) – widget type identifier

Returns:

the widget type as a string

pysbs.sbslibrary.sbsdictionaries.getWidgetOptionName(aWidgetOption)

Get the given widget option name

Parameters:

aWidgetOption (WidgetOptionEnum) – widget option identifier

Returns:

the widget option as a string

pysbs.sbslibrary.sbsdictionaries.getWidgetTypeEnum(aWidgetName)

Get the enum value of the given widget name

Parameters:

aWidgetName (str) – widget name

Returns:

the widget type as a WidgetTypeEnum