User Guide Cancel

sbsargui | Substance 3D Automation ToolKit

  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

sbsargui

Module sbsargui aims to define SBSARObjects that are relative to the GUI as saved in a .sbsar file, mostly SBSARInputGui, SBSAROutputGui and SBSARGuiGroup.

 class sbsarchive.sbsargui.SBSARGuiGroup(aIdentifier='', aLabel='', aDescription=None, aDefaultState=None, aOrder=None)  

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

Class that contains information on a GUI group as defined in a .sbsar file

Members:
  • mIdentifier (str): Unique identifier of the group of parameter.
  • mLabel (str): Label of the group of parameter.
  • mDescription (str, optional): Description
  • mDefaultState (str, optional): Default state (‘folded’,’unfolded’).
  • mOrder (str, optional): Group order
 parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)  

Parse recursively the given xml node to retrieve the content of the SBSObject.

Parameters:
  • aContext (Context) – execution context
  • aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
  • aSBSParser (SBSParser) – the substance parser
  • aXmlNode (xml.etree.ElementTree) – the xml node to parse
 class sbsarchive.sbsargui.SBSARInputGui(aWidget='', aLabel='', aDescription=None, aGroup=None, aOrder=None, aState=None, aVisibleIf=None, aGuiAngle=None, aGuiComboBox=None, aGuiImage=None, aGuiSlider=None, aShowas=None)  

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

Class that contains information on the GUI widget of an input as defined in a .sbsar file

Members:
  • mWidget (str): Kind of widget associated to this input parameter.
  • mLabel (str): Label of the input (unique).
  • mDescription (str, optional): Description.
  • mGroup (str, optional): Group of parameters.
  • mState (str, optional): State of the input (‘visible’,’hidden’,’disabled’).
  • mOrder (str, optional): Input order.
  • mVisibleIf (str, optional): Conditional visibility definition.
  • mGuiAngle (SBSARGuiAngle, optional): Angle widget definition, if the widget is of kind ‘angle’
  • mGuiComboBox (SBSARGuiComboBox, optional): ComboBox widget definition, if the widget is of kind ‘combobox’
  • mGuiImage (SBSARGuiImage, optional): Image widget definition, if the widget is of kind ‘image’
  • mGuiSlider (SBSARGuiSlider, optional): Slider widget definition, if the widget is of kind ‘slider’
  • mShowas (str, optional): defines whether the input is should be shown as a pin or tweakable
 aTweakIdentifier = 'tweak'  
 getAttribute(aAttributeIdentifier)  

Get the given attribute value

Parameters:aAttributeIdentifier (AttributesEnum) – the attribute identifier
Returns:the attribute value if defined, None otherwise
 getClamp()  
Returns:the clamp as a boolean if defined for this parameter, None if not defined
 getDropDownList()  
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined for this parameter, None otherwise.
 getGroup()  

Get the GUI group identifier containing this input

Returns:The GUI group as a string if defined, None otherwise
 getLabelFalse()  

Returns the label for the false option if it’s valid for this input

Returns:str with the label if it’s a button, otherwise None
 getLabelTrue()  

Returns the label for the true option if it’s valid for this input

Returns:str with the label if it’s a button, otherwise None
 getLabels()  
Returns:the list of all labels defined for this parameter, in the right order, as a list of strings. None if not defined
 getMaxValue()  
Returns:the maximum parameter value in the type of the parameter (int or float), None if not defined
 getMinValue()  
Returns:the minimum parameter value in the type of the parameter (int or float), None if not defined
 getStep()  
Returns:the step value (in the type of the parameter) of the widget for this parameter, None if not defined
 getUsages()  

Get the usages of this param input

Returns:the list of SBSARUsage defined on this image input
 getWidget()  

Get the GuiWidget object defined on this parameters. This will return None for a Button widget, a Transformation widget or a Color widget.

Returns:The widget as a SBSARObject if defined, None otherwise
 hasUsage(aUsage)  

Check if the given usage is defined on this image input

Parameters:aUsage (str or UsageEnum) – The usage to look for
Returns:True if the given usage is defined on this param input, False otherwise
 isAButton()  

Check if this input is a parameter with a toggle button widget.

Returns:True if this is an input parameter with a toggle button widget, False otherwise
 isAColor()  

Check if this input is a parameter with a color widget.

Returns:True if this is an input parameter with a color widget, False otherwise
 isAComboBox()  

Check if this input is a parameter with a combo box widget.

Returns:True if this is an input parameter with a combo box widget, False otherwise
 isASlider()  

Check if this input is a parameter with a slider widget.

Returns:True if this is an input parameter with a slider widget, False otherwise
 isAnAngle()  

Check if this input is a parameter with an angle widget.

Returns:True if this is an input parameter with an angle widget, False otherwise
 isAnInputImage()  

Check if this input is of kind image.

Returns:True if this is an input image, False otherwise
 isAnInputParameter()  

Check if this input is a parameter.

Returns:True if this is an input parameter, False otherwise
 parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)  

Parse recursively the given xml node to retrieve the content of the SBSObject.

Parameters:
  • aContext (Context) – execution context
  • aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
  • aSBSParser (SBSParser) – the substance parser
  • aXmlNode (xml.etree.ElementTree) – the xml node to parse
 sAngleWidget = 'angle'  
 sButtonWidget = 'togglebutton'  
 sCheckBoxWidget = 'checkbox'  
 sColorWidget = 'color'  
 sComboBoxWidget = 'combobox'  
 sDefaultWidget = 'default'  
 sImageWidget = 'image'  
 sNormalFormatIdentifier = '$normalformat'  
 sOutputSizeIdentifier = '$outputsize'  
 sPinIdentifier = 'pin'  
 sPointWidget = 'point'  
 sRandomSeedIdentifier = '$randomseed'  
 sRectWidget = 'rect'  
 sSliderWidget = 'slider'  
 sSpinboxWidget = 'spinbox'  
 sTimeIdentifier = '$time'  
 class sbsarchive.sbsargui.SBSAROutputGui(aLabel='', aDescription=None, aGroup=None, aVisibleIf=None, aUsages=None)  

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

Class that contains information on the GUI widget of an input as defined in a .sbsar file

Members:
  • mLabel (str): Label of the input (unique).
  • mDescription (str, optional): Description.
  • mGroup (str, optional): Group of parameters.
  • mVisibleIf (str, optional): Conditional visibility definition.
  • mUsages (list of SBSARUsage, optional): Usages of this output (‘’ is the .sbsar file)
 getAttribute(aAttributeIdentifier)  

Get the given attribute value

Parameters:aAttributeIdentifier (AttributesEnum) – the attribute identifier
Returns:the attribute value if defined, None otherwise
 getUsages()  

Get the usages of this param output

Returns:the list of SBSARUsage defined on this output
 hasUsage(aUsage)  

Check if the given usage is defined on this output

Parameters:aUsage (str or UsageEnum) – The usage to look for
Returns:True if the given usage is defined on this output, False otherwise
 parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)  

Parse recursively the given xml node to retrieve the content of the SBSObject.

Parameters:
  • aContext (Context) – execution context
  • aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
  • aSBSParser (SBSParser) – the substance parser
  • aXmlNode (xml.etree.ElementTree) – the xml node to parse

Get help faster and easier

New user?