User Guide Cancel

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

sbsarguiwidgets

Module sbsarguiwidget aims to define SBSARObjects that are relative to the GUI widget as saved in a .sbsar file: - SBSARGuiWidget - SBSARGuiAngle - SBSARGuiComboBox - SBSARGuiComboBoxItem - SBSARGuiSlider - SBSARGuiImage - SBSARUsage

 class sbsarchive.sbsarguiwidgets.SBSARGuiAngle(aMin='', aMax='', aClamp=None, aStep=None, aUnit=None)

Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget

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

Members:
  • mMin (str): Minimum value
  • mMax (str): Maximum value
  • mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
  • mStep (str, optional): Defines step value for the widget.
  • mUnit (str, optional): Unit of the angle (‘degrees’,’radians’,’turns’) 
 convertValueToBool(aValue)

Converts the given value to a boolean, if the conversion is possible.

Parameters:aValue (str) – The value to convert
Returns:a boolean if the conversion is possible, the given aValue as is otherwise 
 getClamp()
Returns:the clamp as a boolean if defined for this widget, None otherwise 
 getDropDownList()
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. 
 getLabels()
Returns:the list of all labels defined for this widget, in the right order, as a list of strings. 
 getMaxValue()
Returns:the maximum value as a string if defined for this widget, None otherwise 
 getMinValue()
Returns:the minimum value as a string if defined for this widget, None otherwise 
 getStep()
Returns:the step as a string if defined for this widget, None 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 
 class sbsarchive.sbsarguiwidgets.SBSARGuiButton(aLabel0='', aLabel1='')

Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget

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

 convertValueToBool(aValue)

Converts the given value to a boolean, if the conversion is possible.

Parameters:aValue (str) – The value to convert
Returns:a boolean if the conversion is possible, the given aValue as is otherwise 
 getClamp()
Returns:the clamp as a boolean if defined for this widget, None otherwise 
 getDropDownList()
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. 
 getLabels()
Returns:the list of all labels defined for this widget, in the right order, as a list of strings. 
 getMaxValue()
Returns:the maximum value as a string if defined for this widget, None otherwise 
 getMinValue()
Returns:the minimum value as a string if defined for this widget, None otherwise 
 getStep()
Returns:the step as a string if defined for this widget, None 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 
 class sbsarchive.sbsarguiwidgets.SBSARGuiComboBox(aComboBoxItems=None)

Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget

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

Members:
 convertValueToBool(aValue)

Converts the given value to a boolean, if the conversion is possible.

Parameters:aValue (str) – The value to convert
Returns:a boolean if the conversion is possible, the given aValue as is otherwise 
 getClamp()
Returns:the clamp as a boolean if defined for this widget, None otherwise 
 getDropDownList()
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. 
 getLabels()
Returns:the list of all labels defined for this widget, in the right order, as a list of strings. 
 getMaxValue()
Returns:the maximum value as a string if defined for this widget, None otherwise 
 getMinValue()
Returns:the minimum value as a string if defined for this widget, None otherwise 
 getStep()
Returns:the step as a string if defined for this widget, None 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 
 class sbsarchive.sbsarguiwidgets.SBSARGuiComboBoxItem(aValue='', aText='')

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

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

Members:
  • mValue (str): Drop down value (integer)
  • mText (str): Associated label 
 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.sbsarguiwidgets.SBSARGuiImage(aColorType='', aUsages=None)

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

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

Members:
  • mColorType (str): Color mode, ‘color’ or ‘grayscale’
  • mUsages (list of SBSARUsage): usages of this input image (‘’ in the .sbsar file) 
 getUsages()

Get the usages of this param input

Returns:the list of SBSARUsage defined on this image input 
 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 
 isColor()

Check if the image is in color

Returns:True if this is a color image, False otherwise 
 isGrayscale()

Check if the image is in grayscale

Returns:True if this is a grayscale image, 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 
 class sbsarchive.sbsarguiwidgets.SBSARGuiSlider(aMin='', aMax='', aStep='', aClamp='off', aLabel0='X', aLabel1='Y', aLabel2='Z', aLabel3='W', aSuffix=None, aValueScale=None)

Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget

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

Members:
  • mMin (str): Minimum value
  • mMax (str): Maximum value
  • mStep (str): Defines step value for the slider.
  • mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
  • mLabel0 (str, optional): First value label
  • mLabel1 (str, optional): Second value label
  • mLabel2 (str, optional): Third value label
  • mLabel3 (str, optional): Fourth value label
  • mSuffix (str, optional): Suffix
  • mValueScale (str, optional): Value scale 
 convertValueToBool(aValue)

Converts the given value to a boolean, if the conversion is possible.

Parameters:aValue (str) – The value to convert
Returns:a boolean if the conversion is possible, the given aValue as is otherwise 
 getClamp()
Returns:the clamp as a boolean if defined for this widget, None otherwise 
 getDropDownList()
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. 
 getLabels()
Returns:the list of all labels defined for this widget, in the right order, as a list of strings. 
 getMaxValue()
Returns:the maximum value as a string if defined for this widget, None otherwise 
 getMinValue()
Returns:the minimum value as a string if defined for this widget, None otherwise 
 getStep()
Returns:the step as a string if defined for this widget, None 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 
 class sbsarchive.sbsarguiwidgets.SBSARGuiWidget(aMin=None, aMax=None, aStep=None, aClamp=None, aComboBoxItems=None, aLabel0=None, aLabel1=None, aLabel2=None, aLabel3=None)

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

Class that contains information on a GUI widget of an input parameter as defined in a .sbsar file. Base class for SBSARGuiAngle, SBSARGuiColor, SBSARGuiSlider

Members:
  • mMin (str): Minimum value
  • mMax (str): Maximum value
  • mStep (str): Defines step value for the slider.
  • mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
  • mLabel0 (str, optional): First value label
  • mLabel1 (str, optional): Second value label
  • mLabel2 (str, optional): Third value label
  • mLabel3 (str, optional): Fourth value label 
 convertValueToBool(aValue)

Converts the given value to a boolean, if the conversion is possible.

Parameters:aValue (str) – The value to convert
Returns:a boolean if the conversion is possible, the given aValue as is otherwise 
 getClamp()
Returns:the clamp as a boolean if defined for this widget, None otherwise 
 getDropDownList()
Returns:the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. 
 getLabels()
Returns:the list of all labels defined for this widget, in the right order, as a list of strings. 
 getMaxValue()
Returns:the maximum value as a string if defined for this widget, None otherwise 
 getMinValue()
Returns:the minimum value as a string if defined for this widget, None otherwise 
 getStep()
Returns:the step as a string if defined for this widget, None 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 
 class sbsarchive.sbsarguiwidgets.SBSARUsage(aName='', aComponents='', aColorSpace=None)

Bases: pysbs.common_interfaces.sbsarobject.SBSARObject

Class that contains information on the channels of an input or output texture as defined in a .sbsar file

Members:
  • mName (str): Drop down value (integer)
  • mComponents (str, optional): Color components. Default to ‘RGBA’
  • mColorSpace (str, optional): Color space for the channel 
 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?

Quick links

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

Legal Notices    |    Online Privacy Policy