User Guide Cancel

sbsdictionaries | Substance 3D Automation ToolKit

Search
Substance 3D Automation Toolkit

Substance 3D Automation Toolkit

Open app
  1. Substance 3D home
  2. Home
  3. Command Line Tools
    1. Command Line overview
    2. sbsbaker
      1. sbsbaker overview
      2. sbsbaker command line options
      3. sbsbaker Example Command Lines
    3. sbscooker
      1. sbscooker overview
      2. sbscooker command line options
      3. sbscooker pattern variables
    4. sbsmtools
      1. sbsmtools overview
      2. sbsmtools command line options
    5. sbsmutator
      1. sbsmutator overview
      2. sbsmutator command line options
      3. sbsmutator Example Command Lines
    6. sbsrender
      1. sbsrender overview
      2. sbsrender base parameters and pattern variables
      3. sbsrender command line options
      4. sbsrender example command lines
    7. sbsupdater
      1. sbsupdater overview
      2. sbsupdater command line options
  4. Pysbs - Python API
    1. Pysbs - Python API overview
    2. Getting started
    3. General topics
      1. Basic manipulation
      2. Substance creation
      3. Substances modification
      4. Dependencies management
      5. PySbs batchtools module
      6. metadata manipulation
      7. SAT demos
      8. Edit sbsar with SBSARManager
      9. Spot Colors
      10. Thumbnail creation with SAT
    4. Examples
      1. demohelloworld
      2. demos
      3. demos_batchtools
      4. script_update_with_sbsupdater
    5. API Content
      1. API Content overview
      2. Substance definitions
        1. Common interfaces
          1. basegraph
          2. package
          3. sbsarobject
          4. sbsobject
        2. compnode
          1. compnode overview
          2. common
          3. compimplementation
          4. paramgraph
        3. context projectmgr
        4. graph
          1. graph overview
          2. function
          3. inputparameters
          4. output
        5. mdl
          1. mdlannotation
          2. mdlcommon
          3. mdldictionaries
          4. mdlenum
          5. mdlgraph
          6. mdllibclasses
          7. mdlmanager
          8. mdlnode
          9. mdlnodeimpl
          10. mdloperand
          11. mdlsbsbridge
        6. modelgraphindex
          1. modelannotationnames
          2. modelgraph
          3. modelgraphgenerator
          4. modelgraphimplementation
          5. modelnodenames
          6. modeloperand
          7. modulegraphindex
          8. moduleannotation
          9. moduleconnection
          10. modulegraph
          11. modulegraphgenerator
          12. modulegraphimplementation
          13. modulegraphlibrary
          14. modulegraphregister
          15. modulenode
          16. modulenodeimplementation
          17. modulenodeinstance
          18. moduleoperand
          19. moduleoutputbridging
          20. moduleparaminput
        7. params
          1. params overview
          2. dynamicvalue
          3. paramnode
        8. projectmgrdoc
        9. sbsarchive
          1. sbsarchive overview
          2. sbsarenum
          3. sbsargraph
          4. sbsargui
          5. sbsarguiwidgets
          6. sbsarmanager
        10. sbscommon
          1. connections
          2. gui
          3. nodes
          4. values
        11. sbspreset
        12. sbsproject
        13. substance
          1. substance overview
          2. content
          3. resource
      3. Libraries
        1. sbsenum
        2. sbslibrary
          1. sbslibrary overview
          2. sbsdictionaries
          3. sbsfilters
          4. sbsfunctions
          5. sbsfxmapnodes
          6. sbslibclasses
          7. sbswidgets
        3. sbsbakerslibrary
          1. sbsbakerslibrary overview
          2. sbsbakersdef
          3. sbsbakersdefaultprops
          4. sbsbakersdictionaries
          5. sbsbakersenum
          6. sbsbakingconverter
          7. sbsbakingconverterparam
          8. sbsbakingparameters
          9. sbsdialogstate
          10. sbsscenedata
        4. Helpers
          1. sbscleaner
          2. sbsexporter
          3. sbsgenerator
          4. sbsparser
          5. sbswriter
          6. qtclasses
            1. qtclasses overview
            2. qtvariantreader
            3. qtvariantwriter
          7. psdparser
          8. sbsimpactmanager
          9. batchtools
          10. autograph
            1. ag_functions
            2. ag_layout
            3. ag_types
          11. info_mesh_parser
          12. sbsbaker_info_handlers
          13. sbsrender_render_handlers
          14. output_handlers
          15. spotcolorinfo_handler
          16. thumbnail
          17. batchtools overview
        5. Execution context
          1. context
          2. functions
        6. API Change log
  5. Samples
    1. Samples overview
    2. Texturing Template Demo
    3. Batch Tools Demo
    4. Variations
    5. Texture Mat
    6. Pixel Processor Ray tracer
  6. Setup and Getting Started
    1. Setup and Getting Started overview
    2. Compatibility
    3. Frequently asked Questions
    4. Known issues
    5. SAT Cookbook
    6. Use Pysbs in different python interpreter (maya, sd, blender...)
  7. Integrations
    1. Substance Maya toolset
      1. Substance Maya Toolset overview
      2. Installing
      3. Launching
      4. Baking
        1. Baking overview
        2. Export parameters
        3. Baker parameters
        4. Mesh setup
        5. Using a template
      5. Changelog
  8. Changelog overview

sbsdictionaries

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

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 – Substance Graph type
Returns: the graph type value 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

Get help faster and easier

New user?

Quick links

View all your plans Manage your plans
View quick links
Hide quick links

Legal Notices    |    Online Privacy Policy