- 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
params
Content included in params module:
- Module params aims to define SBSObjects that are relative to the Function nodes, mostly:
This module contains also the definition of the parameters (SBSParameter), which are useful for the SBSParamNode and the SBSCompNode.
class params.params.SBSParamSpotColorInfo(aSpotColorBookId='', aSpotColorId='')
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information on a SpotColor as defined in a .sbs file. It allows to define a spotcolor book id and a spotcolor color id
- Members:
- mSpotColorBookId (str): Id of the SpotColor book
- mSpotColorId (str): Id of the color from the spotcolor book id
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getInfo(aProjectMgr=None)
get color spot info
| Parameters: | aProjectMgr – a ProjectMgr can be needed if ACE config is setup |
|---|---|
| Returns: | list of SpotColorInfoStruct |
getInfoAsDict(aProjectMgr=None)
get color spot info as dict
| Parameters: | aProjectMgr – a ProjectMgr can be needed if ACE config is setup |
|---|---|
| Returns: | list of dict |
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
class params.params.SBSParamValue(aConstantValue=None, aDynamicValue=None, aTagName='')
Bases: pysbs.sbscommon.values.SBSConstantValue
Class that contains information on a parameter value as defined in a .sbs file. A parameter can have a constant value with a specific type, or a value defined dynamically by a function.
- Members:
- mConstantValue (
SBSConstantValue): simple constant definition of the parameter. - mDynamicValue (
SBSDynamicValue): dynamic definition of the parameter. - mTagName (str): tag name in the .sbs file, which provides the information of the parameter type.
- mConstantValue (
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getConstantValue()
Get the constant value of this param value
| Returns: | the constant value as a SBSConstantValue if it exists, None otherwise |
|---|
getDynamicValue()
Get the dynamic value of this param value
| Returns: | the dynamic value as a SBSDynamicValue if it exists, None otherwise |
|---|
getType()
Get the type of this constant value
| Returns: | The type as a ParamTypeEnum if success, None otherwise |
|---|
getTypedConstantValue()
Get the constant value of this parameter, typed according to the type of this parameter
| Returns: | The constant parameter value appropriately typed according to the parameter type, None otherwise. |
|---|
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
getValue()
Get the value of this parameter
| Returns: | The parameter value, as a string if it is a constant value, or as a SBSDynamicValue if it is a dynamic value |
|---|
isConstant(self)
| Returns: | True if this parameter has a constant definition |
|---|
isDynamic(self)
| Returns: | True if this parameter is handled by a dynamic value |
|---|
static isValidValue(aType, aValue)
setConstantValue(aType, aValue, aInt1 = False) Set the constant value to the given value, and set the tagname accordingly to the type of the value.
| Parameters: |
|
|---|
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
setConstantValue(aType, aValue, aInt1 = False)
Set the constant value of this param value to the given value and type. Remove the dynamic value if it exists.
| Parameters: |
|
|---|
setDynamicValue(aDynValue)
Set the dynamic value of this param value to the given value. Remove the constant value if it exists.
| Parameters: | aDynValue (SBSDynamicValue) – value to set |
|---|
updateConstantValue(aValue)
Update the value.
| Parameters: | aValue (str) – the value to set |
|---|
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
class params.params.SBSParameter(aName='', aRelativeTo=None, aParamValue=None, aSpotColorInfo=None)
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information of a parameter as defined in a .sbs file. This class is used to define the parameters of a compositing node, a function node or even a graph.
- Members:
- mName (str): name of the parameter to define.
- mRelativeTo (str, optional): parameter inheritance definition, among the list defined in
ParamInheritanceEnum. - mParamValue (
SBSParamValue): definition of the parameter (constant value or dynamic function)
createEmptyDynamicValue()
Init a dynamic value for this parameter. Remove the previous constant value or dynamic value if defined.
| Returns: | the new empty SBSDynamicValue |
|---|
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getConstantValue()
Get the constant value of this parameter
| Returns: | the constant value as a SBSConstantValue if it exists, None otherwise |
|---|
getDynamicValue()
Get the dynamic value of this parameter
| Returns: | the dynamic value as a SBSDynamicValue if it exists, None otherwise |
|---|
getSpotColorInfo()
getSpotColoInfo() get SBSParamSpotColorInfo that handle spot color info
| Returns: | SBSParamSpotColorInfo |
|---|
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
setDynamicValue(aDynamicValue)
Set the dynamic value for this parameter. Remove the previous constant value or dynamic value if defined.
| Parameters: | aDynamicValue (SBSDynamicValue) – the dynamic value to affect |
|---|
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
class params.params.SBSParamsArray(aName='', aUID='', aParamsArrayCells=None)
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information on a paramsArray as defined in a .sbs file. It allows to define the gradient keys in a Gradient map filter.
- Members:
- mName (str): name (type) of the array.
- mUID (str): unique identifier of the array in the /paramsArray/ context.
- mParamsArrayCells (list of
SBSParamsArrayCell): list of cells, representing gradient keys.
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getUidIsUsed(aUID)
Parse the ParamsArrayCell list to find a SBSParamsArrayCell with the given uid
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if this uid is already used, False otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
class params.params.SBSParamsArrayCell(aUID='', aParameters=None)
Bases: pysbs.common_interfaces.sbsobject.SBSObject
Class that contains information on a paramsArrayCell as defined in a .sbs file. It allows to define a gradient key in a Gradient map filter.
- Members:
- mUID (str): unique identifier of the cell in the /paramsArrayCells/ context.
- mParameters (list of
SBSParameter): parameter list of the cell.
equals(other)
Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.
getUidIsUsed(aUID)
Check if the given uid is already used in the context of this SBSObject.
| Parameters: | aUID (str) – UID to check |
|---|---|
| Returns: | True if the uid is already used, False otherwise |
| Raise: | AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|