User Guide Cancel

sbsbakersenum | 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

sbsbakersenum

Module sbsbakersenum provides all the enumeration used by the bakers in Substance Designer.

class pysbs.sbsbakers.sbsbakersenum.BakerEnum

Bases: object

Enumeration of the available bakers of a Scene resource in Substance Designer

AMBIENT_OCCLUSION             = 0 
AMBIENT_OCCLUSION_FROM_MESH   = 1 
BENT_NORMALS_FROM_MESH        = 2 
COLOR_MAP_FROM_MESH           = 3 
CONVERT_UV_TO_SVG             = 4 
CURVATURE                     = 5 
CURVATURE_MAP_FROM_MESH       = 6 
HEIGHT_MAP_FROM_MESH          = 7 
NORMAL_MAP_FROM_MESH          = 8 
OPACITY_MASK_FROM_MESH        = 9 
POSITION                      = 10 
POSITION_MAP_FROM_MESH        = 11 
THICKNESS_MAP_FROM_MESH       = 12 
TRANSFERRED_TEXTURE_FROM_MESH = 13 
WORLD_SPACE_DIRECTION         = 14 
WORLD_SPACE_NORMALS           = 15
class pysbs.sbsbakers.sbsbakersenum.BakingStructureTagEnum

Bases: object

Enumeration of the properties available on a Converter

BAKING                        = 0 
RESOURCE_MODEL                = 1 
RESOURCE_DEFAULT_VALUES_MODEL = 2 
RESOURCE_MESHES_MODEL         = 3 
RESOURCE_OUTPUT_MODEL         = 4 
CONVERTERS                    = 5 
FIRST                         = 6 
FORMAT                        = 7 
GUI_PROPERTIES                = 8 
IDENTIFIER                    = 9 
IS_OVERRIDEN                  = 10 
IS_SELECTED                   = 11 
MESH_CONVERTER_ID             = 12 
PROPERTIES                    = 13 
SCENE_SELECTION_MODE          = 14 
SECOND                        = 15 
SELECTIONS                    = 16 
SUBMESH_COLORS                = 17 
SUBMESH_COLOR                 = 18
class pysbs.sbsbakers.sbsbakersenum.ConverterParamEnum

Bases: object

Enumeration of the properties available on a Converter

ADDITIONAL__INVERT_GREEN                           = 0 
ADDITIONAL__NORMAL_MAP                             = 1 
ADDITIONAL__NORMAL_WORLD_SPACE                     = 2 
COMMON__APPLY_DIFFUSION                            = 3 
COMMON__DILATION_WIDTH                             = 4 
COMMON__UV_TILE                                    = 5 
COMMON__UVSET                                      = 6 
CURVATURE__CURVATURE_MULTIPLIER                    = 7 
CURVATURE__ENABLE_SEAMS                            = 8 
CURVATURE__PER_VERTEX                              = 9 
CURVATURE__SEAMS_POWER                             = 10 
DEFAULT__APPLY_DIFFUSION                           = 11 
DEFAULT__AVERAGE_NORMALS                           = 12 
DEFAULT__DILATION_WIDTH                            = 13 
DEFAULT__FORMAT                                    = 14 
DEFAULT__OUTPUT_HEIGHT                             = 15 
DEFAULT__OUTPUT_WIDTH                              = 16 
DEFAULT__SUB_SAMPLING                              = 17 
DEFAULT__UV_TILE                                   = 18 
DEFAULT__UVSET                                     = 19 
DETAIL__FILTER_METHOD                              = 20 
DETAIL__IGNORE_BACKFACE                            = 21 
DETAIL__INVERT_SKEW_CORRECTION                     = 22 
DETAIL__LOW_AS_HIGH                                = 23 
DETAIL__MAX_DEPTH                                  = 24 
DETAIL__MAX_HEIGHT                                 = 25 
DETAIL__RELATIVE_SCALE                             = 26 
DETAIL__SKEW_CORRECTION                            = 27 
DETAIL__SKEW_MAP                                   = 28 
DETAIL__SMOOTH_NORMALS                             = 29 
DETAIL__SUB_SAMPLING                               = 30 
DETAIL__USE_CAGE                                   = 31 
DETAIL_AO__ATTENUATION                             = 32 
DETAIL_COLOR__COLOR_GENERATOR                      = 33 
DETAIL_COLOR__COLOR_SOURCE                         = 34 
DETAIL_CURVATURE__INTENSITY                        = 35 
DETAIL_CURVATURE__MAXIMIZE_RANGE                   = 36 
DETAIL_CURVATURE__SOFT_SATURATE                    = 37 
DETAIL_DISTANCE__MAXIMIZE_RANGE                    = 38 
DETAIL_NORMAL_COMMON__INVERT_GREEN                 = 39 
DETAIL_NORMAL_COMMON__RESULT_TYPE                  = 40 
DETAIL_SECONDARY_COMMON__DISTRIBUTION              = 41 
DETAIL_SECONDARY_COMMON__FILTER_METHOD             = 42 
DETAIL_SECONDARY_COMMON__IGNORE_BACKFACE_SECONDARY = 43 
DETAIL_SECONDARY_COMMON__MAX_DISTANCE              = 44 
DETAIL_SECONDARY_COMMON__MIN_DISTANCE              = 45 
DETAIL_SECONDARY_COMMON__NB_SECONDARY              = 46 
DETAIL_SECONDARY_COMMON__RELATIVE_SCALE            = 47 
DETAIL_SECONDARY_COMMON__SPREAD                    = 48 
DETAIL_TEXTURE__FILTERING_MODE                     = 49 
DETAIL_TEXTURE__HIGH_POLY_UV_SET                   = 50 
DETAIL_TEXTURE__IS_NORMAL_MAP                      = 51 
DETAIL_TEXTURE__TEXTURE_FILE                       = 52 
MESH__CAGE_PATH                                    = 53 
MESH__DISTANCE_WITH                                = 54 
MESH__HIGH_DEF_MESHES                              = 55 
MESH__HIGH_DEF_MESHES_MESH                         = 56 
MESH__IGNORE_BACKFACE                              = 57 
MESH__INVERT_SKEW_CORRECTION                       = 58 
MESH__MATCH_METHOD                                 = 59 
MESH__MAX_FRONTAL_DISTANCE                         = 60 
MESH__MAX_REAR_DISTANCE                            = 61 
MESH__RELATIVE_TO_BB                               = 62 
MESH__SKEW_PATH                                    = 63 
MESH__USE_CAGE                                     = 64 
MESH__USE_LOW_AS_HIGH_POLY                         = 65 
MESH__USE_SKEW                                     = 66 
NORMAL_WORLD_SPACE__BAKE_TYPE                      = 67 
OUTPUT__FOLDER                                     = 68 
OUTPUT__IN_SUBFOLDER                               = 69 
OUTPUT__RESOURCE_METHOD                            = 70 
OUTPUT__RESOURCE_NAME                              = 71 
POSITION__AXIS                                     = 72 
POSITION__MODE                                     = 73 
POSITION__NORMALIZATION                            = 74 
POSITION__NORMALIZATION_SCALE                      = 75 
SEAO__DISTANCE_FADE                                = 76 
SEAO__ERROR_BIAS                                   = 77 
SEAO__INVERT_NORMALS                               = 78 
SEAO__QUALITY                                      = 79 
SEAO__USE_NEIGHBORS                                = 80 
UV2SVG__COLOR_MODE                                 = 81 
UV2SVG__PADDING                                    = 82 
WORLD_DIRECTION__CONST_DIRECTION                   = 83 
WORLD_DIRECTION__DIRECTION_MAP                     = 84 
WORLD_DIRECTION__X                                 = 85 
WORLD_DIRECTION__Y                                 = 86 
WORLD_DIRECTION__Z                                 = 87
class pysbs.sbsbakers.sbsbakersenum.SceneSelectionModeEnum

Bases: object

Enumeration of the scene resource selection mode option

SUB_MESH = 0 
MATERIAL = 1
class pysbs.sbsbakers.sbsbakersenum.BakerAOAttenuationEnum

Bases: object

Enumeration of the Attenuation option in the Ambient Occlusion From Mesh Baker

NONE   = 0 
SMOOTH = 1 
LINEAR = 2
class pysbs.sbsbakers.sbsbakersenum.BakerAOQualityEnum

Bases: object

Enumeration of the Quality option in the Ambient Occlusion Baker

LOW      = 0 
MEDIUM   = 1 
HIGH     = 2 
VERYHIGH = 3
class pysbs.sbsbakers.sbsbakersenum.BakerBakingTypeEnum

Bases: object

Enumeration of the Baking Type option in the World Space Normals Baker

NORMAL   = 0 
TANGENT  = 1 
BINORMAL = 2
class pysbs.sbsbakers.sbsbakersenum.BakerColorGeneratorEnum

Bases: object

Enumeration of the Color Generator option in the Color Map Baker

RANDOM    = 0 
HUE_SHIFT = 1 
GREYSCALE = 2
class pysbs.sbsbakers.sbsbakersenum.BakerColorModeEnum

Bases: object

Enumeration of the Color Mode option in the Converter UV to SVG Baker

RANDOM      = 0 
HUE_SHIFT   = 1 
GREYSCALE   = 2 
UNIFORM     = 3 
MATERIAL_ID = 4
class pysbs.sbsbakers.sbsbakersenum.BakerColorSourceEnum

Bases: object

Enumeration of the Color Source option in the Color Map Baker

VERTEX_COLOR         = 0 
MATERIAL_COLOR       = 1 
MESH_ID              = 2 
POLYGROUP_SUBMESH_ID = 3
class pysbs.sbsbakers.sbsbakersenum.BakerCurvatureAlgoEnum

Bases: object

Enumeration of the Algorithm option in the Curvature Baker

PER_PIXEL  = 0 
PER_VERTEX = 1
class pysbs.sbsbakers.sbsbakersenum.BakerDistributionEnum

Bases: object

Enumeration of the Distribution option in the Bakers

UNIFORM  = 0 
COSINE   = 1
class pysbs.sbsbakers.sbsbakersenum.BakerFilteringModeEnum

Bases: object

Enumeration of the Filtering mode option in the Bakers

NEAREST  = 0 
BILINEAR = 1
class pysbs.sbsbakers.sbsbakersenum.BakerFromMeshDistanceWithEnum

Bases: object

Enumeration of the ‘Set distance with’ option in the Mesh options

VALUES    = 0 
CAGE      = 1
class pysbs.sbsbakers.sbsbakersenum.BakerFromMeshMatchEnum

Bases: object

Enumeration of the Match method option in the ‘from mesh’ Bakers (Used for Match and SelfOcclusion)

ALWAYS       = 0 
BY_MESH_NAME = 1
class pysbs.sbsbakers.sbsbakersenum.BakerFromMeshSubSamplingEnum

Bases: object

Enumeration of the Antialiasing option in the ‘from mesh’ Bakers

NONE            = 0 
SUBSAMPLING_2x2 = 1 
SUBSAMPLING_4x4 = 2 
SUBSAMPLING_8x8 = 3
class pysbs.sbsbakers.sbsbakersenum.BakerInputDirectionEnum

Bases: object

Enumeration of the Input Direction option in the World Space Direction Baker

FROM_TEXTURE        = 0 
FROM_UNIFORM_VECTOR = 1
class pysbs.sbsbakers.sbsbakersenum.BakerMapTypeEnum

Bases: object

Enumeration of the Map type option in the Bakers

WORLD_SPACE   = 0 
TANGENT_SPACE = 1
class pysbs.sbsbakers.sbsbakersenum.BakerNormalOrientationEnum

Bases: object

Enumeration of the normal format for the Bakers

OPENGL  = 0 
DIRECTX = 1
class pysbs.sbsbakers.sbsbakersenum.BakerOutputFormatEnum

Bases: object

Enumeration of the output Format option of the Bakers

PSD       = 0 
DDS       = 1 
WEBP      = 2 
HDR       = 3 
EXR       = 4 
JPEG      = 5 
JPEG_XR   = 6 
JPEG_2000 = 7 
PNG       = 8 
SVG       = 9 
TIF       = 10 
TGA       = 11 
ICO       = 12 
BMP       = 13 
WAP       = 14
class pysbs.sbsbakers.sbsbakersenum.BakerPositionAxisEnum

Bases: object

Enumeration of the Axis option in the Position Bakers

AXIS_X = 0 
AXIS_Y = 1 
AXIS_Z = 2
class pysbs.sbsbakers.sbsbakersenum.BakerPositionModeEnum

Bases: object

Enumeration of the Mode option in the Position Bakers

ALL_AXIS = 0 
ONE_AXIS = 1
class pysbs.sbsbakers.sbsbakersenum.BakerPositionNormalizationEnum

Bases: object

Enumeration of the Normalization option in the Position Bakers

BBOX    = 0 
BSPHERE = 1
class pysbs.sbsbakers.sbsbakersenum.BakerResourceMethodEnum

Bases: object

Enumeration of the Resource method option in the Bakers

EMBEDDED = 0 
LINKED   = 1
class pysbs.sbsbakers.sbsbakersenum.BakerUVSetEnum

Bases: object

Enumeration of the UV set option in the Bakers

UV_0 = 0 
UV_1 = 1 
UV_2 = 2 
UV_3 = 3 
UV_4 = 4 
UV_5 = 5 
UV_6 = 6 
UV_7 = 7

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