User Guide Cancel

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

sbsbakingparameters

Module sbsbakingparameters aims to provide useful functions to read and modify the baking parameters of a Scene resource.

The baking parameters are saved as an encoded string in the .sbs file, this is why a specific module is required for them.

 class pysbs.sbsbakers.sbsbakingparameters.BakingParameters(aBakers=None, aSubMeshColors=None, aSubMeshSelections=None)

Bases: object

Class that contains information on the Baking Parameters of a Scene resource

Members:
 addBaker(aIdentifier)

Add a BakingConverter of the given kind

Parameters:aIdentifier (BakerEnum) – Identifier of the converter to create
Returns:The created BakingConverter object
Raise:SBSImpossibleActionError 
 addHighDefinitionMeshFromFile(aAbsFilePath)

Add the given absolute path to the list of High Definition Meshes for a ‘From Mesh’ converter. This modifies the parameter MESH__HIGH_DEF_MESHES of this converter.

Parameters:aAbsFilePath (str) – The absolute path to the resource
Returns:True if success, False otherwise
Raise:SBSImpossibleActionError 
 addHighDefinitionMeshFromResource(aResource)

Add the given resource in the list of High Definition Meshes for a ‘From Mesh’ converter. The resource must be already included in the package. This modifies the parameter MESH__HIGH_DEF_MESHES of this converter.

Parameters:aResource (SBSResource) – The resource to reference
Returns:True if success, False otherwise
Raise:SBSImpossibleActionError 
 computeUniqueIdentifier(aIdentifier, aSuffixId = 0)

Check if the given identifier is already used and generate a unique identifier if necessary

Parameters:
  • aIdentifier (str) – Identifier to check
  • aSuffixId (int) – Suffix ID
Returns:

A unique identifier, which is either the given one or a new one with a suffix: identifier [id]

 
 fromSBSTree(aSBSTree)

Get the content of the given SBSTree to set the Baking Parameters

Parameters:aSBSTree (SBSTree) – The tree of options ot baking parameters from
Returns:True if success 
 getBaker(aBaker)

Get the BakingConverter object with the given identifier (ex: ‘Ambient Occlusion’)

Parameters:aBaker (BakerEnum or str) – Identifier of the baker
Returns:The BakingConverter with this identifier if found, None otherwise 
 getNbBakers()

Get the number of BakingConverter defined

Returns:The number of BakingConverter as an integer 
 getParameter(aParameter)

Get the global parameter with the given identifier

Parameters:aParameter (ConverterParamEnum or str) – Identifier of the parameter to get
Returns:The parameter as a QtVariant if found, None otherwise 
 getParameterValue(aParameter)

Get the value of the parameter with the given identifier

Parameters:aParameter (ConverterParamEnum or str) – Identifier of the parameter to get
Returns:The parameter value in the type of the parameter if found, None otherwise 
 getSubMeshColor(aEntityId, aSubMeshId)

Get the SubMeshColor corresponding to the given (entityId, subMeshId)

Returns:The SubMeshColor object if found, None otherwise 
 getSubMeshColorHexa(aEntityId, aSubMeshId)

Get the hexadecimal color of the SubMeshColor corresponding to the given (entityId, subMeshId)

Parameters:
  • aEntityId (int) – Index of the entity that contains the submesh (start to 1)
  • aSubMeshId (int) – Index of the submesh part (start to 0)
Returns:

The hexadecimal color as a string if it exists, None otherwise

 
 getSubMeshSelection(aEntityId, aSubMeshId)

Get the SubMeshSelection corresponding to the given (entityId, subMeshId)

Returns:The SubMeshSelection object if found, None otherwise 
 isSubMeshSelected(aEntityId, aSubMeshId)

Check if the given (entityId, subMeshId) is selected

Parameters:
  • aEntityId (int) – Index of the entity that contains the submesh (start to 1)
  • aSubMeshId (int) – Index of the submesh part (start to 0)
Returns:

True if the given submesh index is selected, False otherwise

 
 moveDownBaker(aBaker)

Move down the given baker in the bakers list

Parameters:aBaker (BakingConverter or BakerEnum or str) – Baker to move down in the bakers list
Raise:SBSImpossibleActionError 
 moveUpBaker(aBaker)

Move up the given baker in the bakers list

Parameters:aBaker (BakingConverter or BakerEnum or str) – Baker to move up in the bakers list
Raise:SBSImpossibleActionError 
 removeBaker(aBaker)

Remove the given baker

Parameters:aBaker (BakingConverter or BakerEnum or str) – Baker to remove, as an object or an identifier
Returns:True if success, False otherwise
Raise:SBSImpossibleActionError 
 selectBaker(aBaker, aSelected=True)

Select the given baker

Parameters:
  • aBaker (BakingConverter or BakerEnum or str) – Baker to select, as an object or an identifier
  • aSelected (bool) – True to select the baker, False to deselect it
Raise:

SBSImpossibleActionError

 
 setFileParameterValueFromPath(aParameter, aAbsPath)

Set the file path value of the given parameter as the relative path of the given resource. Only parameters ‘MESH__CAGE_FILE’, ‘MESH__SKEW_MAP’, ‘NORMAL_MAP’, ‘TEXTURE_FILE’, ‘DIRECTION_FILE’ can be set by this function. An exception will be raised if the parameter is not appropriate.

Parameters:
  • aParameter (ConverterParamEnum or str) – Identifier of the parameter to set
  • aAbsPath (str) – The absolute path to the file resource
Returns:

True if success, False otherwise
Raise:

SBSImpossibleActionError

 
 setFileParameterValueFromResource(aParameter, aResource)

Set the file path value of the given parameter as the relative path of the given resource. Only parameters ‘MESH__CAGE_FILE’, ‘NORMAL_MAP’, ‘TEXTURE_FILE’, ‘DIRECTION_FILE’ can be set by this function. An exception will be raised if the resource is invalid or if the parameter is not appropriate.

Parameters:
Returns:

True if success, False otherwise
Raise:

SBSImpossibleActionError

 
 setParameterValue(aParameter, aParamValue)

Set the value of the given global parameter

Parameters:
  • aParameter (BakingGlobalParam) – The parameter to set
  • aParamValue (any type) – The value to set
Raise:

SBSImpossibleActionError

 
 setSubMeshColorHexa(aEntityId, aSubMeshId, aColor)

Set the given color to the SubMesh part of the given Id

Parameters:
  • aEntityId (int) – Index of the entity that contains the submesh (start to 1)
  • aSubMeshId (int) – Index of the submesh part (start to 0)
  • aColor (str) – The hexadecimal color
Returns:

Nothing
Raise:

SBSImpossibleActionError

 
 setSubMeshSelection(aEntityId, aSubMeshId, aSelected)

Set the given color to the SubMesh part of the given Id

Parameters:
  • aEntityId (int) – Index of the entity that contains the submesh (start to 1)
  • aSubMeshId (int) – Index of the submesh part (start to 0)
  • aSelected (bool) – True to select the SubMesh part, False to deselect it 
 toSBSOptionList()

Convert the object structure of the BakingParameters into a tree of SBSOptions, as it is saved in the .sbs file

Returns:A list of SBSOptions object with the content of the BakingParameters

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