Substance 3D home
Home
Command Line Tools
1. Command Line overview
2. sbsbaker
3. sbscooker
4. sbsmtools
  1. sbsmtools overview
  2. sbsmtools command line options
5. sbsmutator
6. sbsrender
7. sbsupdater
  1. sbsupdater overview
  2. sbsupdater command line options
Pysbs - Python API
1. Pysbs - Python API overview
2. Getting started
3. General topics
4. Examples
5. API Content
  1. API Content overview
  2. Substance definitions
    1. Common interfaces
    2. compnode
    3. context projectmgr
    4. graph
    5. mdl
    6. modelgraphindex
    7. params
    8. projectmgrdoc
    9. sbsarchive
    10. sbscommon
      1. connections
      2. gui
      3. nodes
      4. values
    11. sbspreset
    12. sbsproject
    13. substance
  3. Libraries
    1. sbsenum
    2. sbslibrary
    3. sbsbakerslibrary
    4. Helpers
      1. sbscleaner
      2. sbsexporter
      3. sbsgenerator
      4. sbsparser
      5. sbswriter
      6. qtclasses
        
        qtclasses overview
        
        qtvariantreader
        
        qtvariantwriter
      7. psdparser
      8. sbsimpactmanager
      9. batchtools
      10. autograph
        
        ag_functions
        
        ag_layout
        
        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
Samples
Setup and Getting Started
Integrations
1. Substance Maya toolset
  1. Substance Maya Toolset overview
  2. Installing
  3. Launching
  4. Baking
  5. Changelog
Changelog overview

demohelloworld

Module demohelloworld provides a very simple example of usage of the Pysbs, without using argument file.

demohelloworld.demoHelloWorld(aDestFileAbsPath)

Create a substance with a very simple material definition: uniform colors for BaseColor, Roughness and Metallic, and save it to ‘sample/resultDemoHelloWorld.sbs’

Parameters:	aDestFileAbsPath (str) – The absolute path of the resulting SBS file
Returns:	Nothing

Here is the code of function demoHelloWorld:

aContext = context.Context() 
#aContext.getUrlAliasMgr().setAliasAbsPath(aAliasName = 'myAlias', aAbsPath = 'myAliasAbsolutePath') 
 
startPos = [48, 48, 0] 
xOffset  = [192, 0, 0] 
yOffset  = [0, 192, 0] 
 
try: 
    # Create a new SBSDocument from scratch, with a graph named 'SimpleMaterial' 
    sbsDoc = sbsgenerator.createSBSDocument(aContext, 
                            aFileAbsPath = aDestFileAbsPath, 
                            aGraphIdentifier = 'SimpleMaterial') 
 
    # Get the graph 'SimpleMaterial' 
    aGraph = sbsDoc.getSBSGraph(aGraphIdentifier = 'SimpleMaterial') 
 
    # Create three Uniform color nodes, for BaseColor, Roughness and Metallic 
    baseColor = aGraph.createCompFilterNode(aFilter = sbsenum.FilterEnum.UNIFORM, 
                        aParameters = {sbsenum.CompNodeParamEnum.OUTPUT_COLOR: [1, 0, 0, 1]}, 
                        aGUIPos     = startPos) 
 
    roughness = aGraph.createCompFilterNode(aFilter = sbsenum.FilterEnum.UNIFORM, 
                        aParameters = {sbsenum.CompNodeParamEnum.COLOR_MODE: sbsenum.ColorModeEnum.GRAYSCALE, 
                                       sbsenum.CompNodeParamEnum.OUTPUT_COLOR: 0.3}, 
                        aGUIPos     = baseColor.getOffsetPosition(yOffset)) 
 
    metallic = aGraph.createCompFilterNode(aFilter = sbsenum.FilterEnum.UNIFORM, 
                        aParameters = {sbsenum.CompNodeParamEnum.COLOR_MODE: sbsenum.ColorModeEnum.GRAYSCALE, 
                                       sbsenum.CompNodeParamEnum.OUTPUT_COLOR: 0.6}, 
                        aGUIPos     = roughness.getOffsetPosition(yOffset)) 
 
    # Create three Output nodes, for BaseColor, Roughness and Metallic 
    outBaseColor = aGraph.createOutputNode(aIdentifier = 'BaseColor', 
                        aGUIPos = baseColor.getOffsetPosition(xOffset), 
                        aUsages = {sbsenum.UsageEnum.BASECOLOR: {sbsenum.UsageDataEnum.COMPONENTS:sbsenum.ComponentsEnum.RGBA}}) 
 
    outRoughness = aGraph.createOutputNode(aIdentifier = 'Roughness', 
                        aGUIPos = roughness.getOffsetPosition(xOffset), 
                        aUsages = {sbsenum.UsageEnum.ROUGHNESS: {sbsenum.UsageDataEnum.COMPONENTS:sbsenum.ComponentsEnum.RGBA}}) 
 
    outMetallic = aGraph.createOutputNode(aIdentifier = 'Metallic', 
                        aGUIPos = metallic.getOffsetPosition(xOffset), 
                        aUsages = {sbsenum.UsageEnum.METALLIC: {sbsenum.UsageDataEnum.COMPONENTS:sbsenum.ComponentsEnum.RGBA}}) 
 
    # Connect the Uniform color nodes to their respective Output node 
    # (no need to precise aLeftNodeOutput and aRightNodeInput here as there is no ambiguity) 
    aGraph.connectNodes(aLeftNode = baseColor, aRightNode = outBaseColor) 
    aGraph.connectNodes(aLeftNode = roughness, aRightNode = outRoughness) 
    aGraph.connectNodes(aLeftNode = metallic,  aRightNode = outMetallic) 
 
    # Write back the document structure into the destination .sbs file 
    sbsDoc.writeDoc() 
    log.info("=> Resulting substance saved at %s", aDestFileAbsPath) 
    return True 
 
except BaseException as error: 
    log.error("!!! [demoHelloWorld] Failed to create the new package") 
    raise error

demohelloworld.main()

Get help faster and easier

New user?

demohelloworld | Substance 3D Automation ToolKit

demohelloworld

Get help faster and easier

Ask the Community

Contact Us