Documentation for Substance Automation Toolkit is now included in the SAT package. You can access the documentation by opening html-doc.zip inside your downloaded SAT package.
sbsbakingconverterparam
Module sbsbakingconverterparam provides the definition of the BakingConverterParam object.
class pysbs.sbsbakers.sbsbakingconverterparam.BakingParam(aIdentifier, aQtVariant)
Bases: object
This class provide the common interface for BakingConverterParam and BakingGlobalParam
- Members
- mIdentifier (
ConverterParamEnum): identifier of the property - mQtVariant (
QtVariant): value of the property (type + value)
- mIdentifier (
getType()
Get the type of the QtVariant object
| Returns: | The type of the QtVariant object, as a QtVariantTypeEnum |
|---|
getValue()
Get the value of the QtVariant object
| Returns: | The value of the QtVariant object |
|---|
getValueStr()
Get the value of the QtVariant object converted into a string
| Returns: | The value of the QtVariant object as a string |
|---|
setValue(aValue)
Set the value of the QtVariant object
| Parameters: | aValue (any type compatible with the type of the QtVariant object) – The value to set |
|---|
isAResourceParam()
Return True if this BakingConverterParam is a resource parameter (e.g. Normal map, Texture file, Direction file, Cage file) with a type STRING.
| Returns: | True if it is a resource parameter, False otherwise |
|---|
fromSBSTree(aOptionPrefix, aSBSTree)
Read options from aSBSTree
| Parameters: |
|
|---|---|
| Returns: | True if success, False otherwise |
toSBSOptionList(aOptionPrefix)
Convert this property into a list of SBSOption.
| Parameters: | aOptionPrefix (str) – the option prefix |
|---|---|
| Returns: | a list of SBSOption allowing to fully declare this parameter |
class pysbs.sbsbakers.sbsbakingconverterparam.BakingConverterParam(aIdentifier, aQtVariant)
Bases: pysbs.sbsbakers.sbsbakingconverterparam.BakingParam
This class provide the definition of a BakingConverterParam
- Members
- mIdentifier (
ConverterParamEnum): identifier of the property - mQtVariant (
QtVariant): value of the property (type + value)
- mIdentifier (
toSBSOptionList(aOptionPrefix)
Convert this property into a tree of options.
| Parameters: | aOptionPrefix (str) – the option prefix |
|---|---|
| Returns: | a list of SBSOption allowing to fully declare this parameter |
class pysbs.sbsbakers.sbsbakingconverterparam.BakingGlobalParam(aIdentifier, aQtVariant)
Bases: pysbs.sbsbakers.sbsbakingconverterparam.BakingParam
This class provide the definition of a property of a Global Baking parameter
- Members
- mIdentifier (
ConverterParamEnum): identifier of the property - mQtVariant (
QtVariant): value of the property (type + value)
- mIdentifier (
fromSBSTree(aTree)
Initialize the baking settings from the given tree.
| Parameters: | aTree (tree of options of SBSTree) – the tree of options |
|---|---|
| Returns: | True if success, False otherwise |
toSBSOptionList(aOptionPrefix)
Convert this property into am options tree.
| Parameters: | aOptionPrefix (str) – the option prefix |
|---|---|
| Returns: | a list of SBSOption allowing to fully declare this parameter |
