User Guide Cancel

sbsbakingconverterparam | Substance 3D Automation ToolKit

sbsbakingconverterparam

Module sbsbakingconverterparam provides the definition of the BakingConverterParam object.

class pysbs.sbsbakers.sbsbakingconverterparam.BakingParam(aIdentifier, aQtVariant)
class pysbs.sbsbakers.sbsbakingconverterparam.BakingParam(aIdentifier, aQtVariant)
 class pysbs.sbsbakers.sbsbakingconverterparam.BakingParam(aIdentifier, aQtVariant)  

Bases: object

This class provide the common interface for BakingConverterParam and BakingGlobalParam

Members
getType()
getType()
 getType()  

Get the type of the QtVariant object

Returns:The type of the QtVariant object, as a QtVariantTypeEnum
getValue()
getValue()
 getValue()  

Get the value of the QtVariant object

Returns:The value of the QtVariant object
getValueStr()
getValueStr()
 getValueStr()  

Get the value of the QtVariant object converted into a string

Returns:The value of the QtVariant object as a string
setValue(aValue)
setValue(aValue)
 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()
isAResourceParam()
 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)
fromSBSTree(aOptionPrefix, aSBSTree)
 fromSBSTree(aOptionPrefix, aSBSTree)  

Read options from aSBSTree

Parameters:
  • aOptionPrefix (str) – the option prefix
  • aSBSTree (SBSTree) – the tree of options
Returns:

True if success, False otherwise

toSBSOptionList(aOptionPrefix)
toSBSOptionList(aOptionPrefix)
 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)
class pysbs.sbsbakers.sbsbakingconverterparam.BakingConverterParam(aIdentifier, aQtVariant)
 class pysbs.sbsbakers.sbsbakingconverterparam.BakingConverterParam(aIdentifier, aQtVariant)  

Bases: pysbs.sbsbakers.sbsbakingconverterparam.BakingParam

This class provide the definition of a BakingConverterParam

Members
toSBSOptionList(aOptionPrefix)
toSBSOptionList(aOptionPrefix)
 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)
class pysbs.sbsbakers.sbsbakingconverterparam.BakingGlobalParam(aIdentifier, aQtVariant)
 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
fromSBSTree(aTree)
fromSBSTree(aTree)
 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)
toSBSOptionList(aOptionPrefix)
 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

Get help faster and easier

New user?