- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Changelog overview
sbslibrary
Content included in sbslibrary module:
Module sbslibrary provides the libraries of Filters, Functions, FxMap nodes and Widgets that are defined in the modules sbsfilters
, sbsfunctions
, sbsfxmapnodes
and sbswidgets
.
sbslibrary.sbslibrary.__convertToEnum(aKey, aGetEnumFunction)
sbslibrary.sbslibrary.getAngleWidgetByType(aType)
getSliderWidgetByType(aType) Get the given widget
sbslibrary.sbslibrary.getButtonWidgetByType(aType)
getSliderWidgetByType(aType) Get the given widget
sbslibrary.sbslibrary.getColorWidgetByType(aType)
getSliderWidgetByType(aType) Get the given widget
sbslibrary.sbslibrary.getDefaultWidget(aWidget)
Get the given widget
Parameters: | aWidget (WidgetEnum ) – widget identifier |
---|---|
Returns: | the widget as a InputParamWidget |
sbslibrary.sbslibrary.getDropDownWidgetByType(aType)
getSliderWidgetByType(aType) Get the given widget
sbslibrary.sbslibrary.getFilterDefinition(aFilter)
Get the definition of the given filter (inputs, outputs, parameters)
Parameters: | aFilter (FilterEnum or str) – filter identifier |
---|---|
Returns: | a CompNodeDef object if found, None otherwise |
sbslibrary.sbslibrary.getFilterEnum(aFilterName)
Get the enum value of the given filter
Parameters: | aFilterName (str) – filter identifier |
---|---|
Returns: | the filter as a FilterEnum |
sbslibrary.sbslibrary.getFunctionDefinition(aFunction)
Get the definition of the given function (inputs, outputs, parameters)
Parameters: | aFunction (FunctionEnum or str) – function identifier |
---|---|
Returns: | a FunctionDef object if found, None otherwise |
sbslibrary.sbslibrary.getFunctionEnum(aFunctionName)
Get the enum value of the given function
Parameters: | aFunctionName (str) – function identifier |
---|---|
Returns: | the function as a FunctionEnum |
sbslibrary.sbslibrary.getFunctionGetType(aType)
Get the appropriate function GET_<> depending on the type of the input parameter
Parameters: | aType (ParamTypeEnum ) – the type of data to get |
---|---|
Returns: | the function GET_<> corresponding to the given type if succeed, None otherwise |
sbslibrary.sbslibrary.getFxMapNodeDefinition(aFxMapNode)
Get the definition of the given FxMap node (inputs, outputs, parameters)
Parameters: | aFxMapNode (FxMapNodeEnum or str) – FxMap node identifier |
---|---|
Returns: | a CompNodeDef object if found, None otherwise |
sbslibrary.sbslibrary.getFxMapNodeEnum(aFxMapNodeName)
Get the enum value of the given function
Parameters: | aFxMapNodeName (str) – FxMap node identifier |
---|---|
Returns: | the FxMap node as a FxMapNodeEnum |
sbslibrary.sbslibrary.getInputBridgeDefinition()
Get the definition of an input bridge node (inputs, outputs, parameters)
Returns: | a CompNodeDef object if found, None otherwise |
---|
sbslibrary.sbslibrary.getIterationParamInput()
Get the description of the ‘iteration’ parameter
Returns: | the CompNodeParam describing this parameter |
---|
sbslibrary.sbslibrary.getOutputBridgeDefinition()
Get the definition of an output bridge node (inputs, outputs, parameters)
Returns: | a CompNodeDef object if found, None otherwise |
---|
sbslibrary.sbslibrary.getSliderWidgetByType(aType)
Get the given widget
sbslibrary.sbslibrary.getWidgetByType(aType)
getSliderWidgetByType(aType) Get the given widget