User Guide Cancel

sbsdictionaries | Substance 3D Automation ToolKit

sbsdictionaries

Module sbsdictionaries provides the dictionaries to have the mapping between the enumerations in sbsenum and the corresponding string identifier used by Substance Designer.

pysbs.sbslibrary.sbsdictionaries.getAttribute(aAttribute)
pysbs.sbslibrary.sbsdictionaries.getAttribute(aAttribute)
pysbs.sbslibrary.sbsdictionaries.getAttribute(aAttribute)

Get the given attribute name

Parameters: aAttribute (AttributesEnum) – attribute identifier
Returns: the attribute as a string
pysbs.sbslibrary.sbsdictionaries.getColorSpace(aColorSpace))
pysbs.sbslibrary.sbsdictionaries.getColorSpace(aColorSpace))
pysbs.sbslibrary.sbsdictionaries.getColorSpace(aColorSpace))

Get the given color space name

Parameters: aColorSpace (ColorSpacesEnum) – color space identifier
Returns: the color space as a string
pysbs.sbslibrary.sbsdictionaries.getColorSpaceEnum(aColorSpaceName)
pysbs.sbslibrary.sbsdictionaries.getColorSpaceEnum(aColorSpaceName)
pysbs.sbslibrary.sbsdictionaries.getColorSpaceEnum(aColorSpaceName)

Get the enum value of the given parameter

Parameters: aColorSpaceName (str) – parameter identifier
Returns: the parameter as a ColorSpacesEnum if found, None otherwise
pysbs.sbslibrary.sbsdictionaries.getCompNodeInput(aInput)
pysbs.sbslibrary.sbsdictionaries.getCompNodeInput(aInput)
pysbs.sbslibrary.sbsdictionaries.getCompNodeInput(aInput)

Get the given compositing node input name

Parameters: aInput (InputEnum) – input identifier
Returns: the input as a string
pysbs.sbslibrary.sbsdictionaries.getCompNodeInputEnum(aInputName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeInputEnum(aInputName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeInputEnum(aInputName)

Get the enum value of the given input

Parameters: aInputName (str) – input identifier
Returns: the input as a InputEnum
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutput(aOutput)
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutput(aOutput)
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutput(aOutput)

Get the given compositing node output name

Parameters: aOutput (OutputEnum) – output identifier
Returns: the output as a string
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutputEnum(aOutputName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutputEnum(aOutputName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeOutputEnum(aOutputName)

Get the enum value of the given output

Parameters: aOutputName (str) – output identifier
Returns: the output as a OutputEnum
pysbs.sbslibrary.sbsdictionaries.getCompNodeParam(aParameter)
pysbs.sbslibrary.sbsdictionaries.getCompNodeParam(aParameter)
pysbs.sbslibrary.sbsdictionaries.getCompNodeParam(aParameter)

Get the given compositing node parameter name

Parameters: aParameter (CompNodeParamEnum) – parameter identifier
Returns: the parameter as a string
pysbs.sbslibrary.sbsdictionaries.getCompNodeParamEnum(aParameterName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeParamEnum(aParameterName)
pysbs.sbslibrary.sbsdictionaries.getCompNodeParamEnum(aParameterName)

Get the enum value of the given parameter

Parameters: aParameterName (str) – parameter identifier
Returns: the parameter as a CompNodeParamEnum if found, None otherwise
pysbs.sbslibrary.sbsdictionaries.getComponents(aComponents)
pysbs.sbslibrary.sbsdictionaries.getComponents(aComponents)
pysbs.sbslibrary.sbsdictionaries.getComponents(aComponents)

Get the given components name

Parameters: aComponents (ComponentsEnum) – components identifier
Returns: the components as a string
pysbs.sbslibrary.sbsdictionaries.getCurveName(aCurveType)
pysbs.sbslibrary.sbsdictionaries.getCurveName(aCurveType)
pysbs.sbslibrary.sbsdictionaries.getCurveName(aCurveType)

Get the given curve type name

Parameters: aCurveType (CurveTypeEnum) – curve type identifier
Returns: the curve type as a string
pysbs.sbslibrary.sbsdictionaries.getCurveTypeEnum(aCurveName)
pysbs.sbslibrary.sbsdictionaries.getCurveTypeEnum(aCurveName)
pysbs.sbslibrary.sbsdictionaries.getCurveTypeEnum(aCurveName)

Get the enum value of the given curve name

Parameters: aCurveName (str) – curve name
Returns: the curve type as a CurveTypeEnum
pysbs.sbslibrary.sbsdictionaries.getFunctionGetType(aType)
pysbs.sbslibrary.sbsdictionaries.getFunctionGetType(aType)
pysbs.sbslibrary.sbsdictionaries.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
pysbs.sbslibrary.sbsdictionaries.getFunctionInput(aInput)
pysbs.sbslibrary.sbsdictionaries.getFunctionInput(aInput)
pysbs.sbslibrary.sbsdictionaries.getFunctionInput(aInput)

Get the given function node input name

Parameters: aInput (FunctionInputEnum) – input identifier
Returns: the input as a string
pysbs.sbslibrary.sbsdictionaries.getFunctionInputEnum(aInputName)
pysbs.sbslibrary.sbsdictionaries.getFunctionInputEnum(aInputName)
pysbs.sbslibrary.sbsdictionaries.getFunctionInputEnum(aInputName)

Get the enum value of the given function input

Parameters: aInputName (str) – input identifier
Returns: the input as a FunctionInputEnum
pysbs.sbslibrary.sbsdictionaries.getFunctionOutput(aOutput)
pysbs.sbslibrary.sbsdictionaries.getFunctionOutput(aOutput)
pysbs.sbslibrary.sbsdictionaries.getFunctionOutput(aOutput)

Get the given function node output name

Parameters: aOutput (OutputEnum) – output identifier
Returns: the input as a string
pysbs.sbslibrary.sbsdictionaries.getFunctionOutputEnum(aOutputName)
pysbs.sbslibrary.sbsdictionaries.getFunctionOutputEnum(aOutputName)
pysbs.sbslibrary.sbsdictionaries.getFunctionOutputEnum(aOutputName)

Get the enum value of the given function output

Parameters: aOutputName (str) – output identifier
Returns: the input as a OutputEnum
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeEnum(aGUIObjectTypeName)
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeEnum(aGUIObjectTypeName)
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeEnum(aGUIObjectTypeName)

Get the enum value of the given curve name

Parameters: aGUIObjectTypeName (str) – GUI object type name
Returns: the curve type as a GUIObjectTypeEnum
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeName(aGUIObjectType)
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeName(aGUIObjectType)
pysbs.sbslibrary.sbsdictionaries.getGUIObjectTypeName(aGUIObjectType)

Get the given GUI object type name

Parameters: aGUIObjectType (GUIObjectTypeEnum) – GUI object type identifier
Returns: the GUI object type as a string
pysbs.sbslibrary.sbsdictionaries.getResourceTypeEnum(aResourceName)
pysbs.sbslibrary.sbsdictionaries.getResourceTypeEnum(aResourceName)
pysbs.sbslibrary.sbsdictionaries.getResourceTypeEnum(aResourceName)

Get the enum value of the given resource name

Parameters: aResourceName (str) – resource name
Returns: the curve type as a ResourceTypeEnum
pysbs.sbslibrary.sbsdictionaries.getResourceTypeName(aResourceType)
pysbs.sbslibrary.sbsdictionaries.getResourceTypeName(aResourceType)
pysbs.sbslibrary.sbsdictionaries.getResourceTypeName(aResourceType)

Get the given resource type name

Parameters: aResourceType (ResourceTypeEnum) – resource type identifier
Returns: the curve type as a string
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphTemplatePath(aTemplateEnum)
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphTemplatePath(aTemplateEnum)
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphTemplatePath(aTemplateEnum)

Get the path of the given Substance Graph template

Parameters: aTemplateEnum (GraphTemplateEnum) – Substance Graph template
Returns: the path to the template as a string
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphType(aTypeEnum)
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphType(aTypeEnum)
pysbs.sbslibrary.sbsdictionaries.getSubstanceGraphType(aTypeEnum)

Get the type value of the given Substance Graph type

Parameters: aTypeEnum – Substance Graph type
Returns: the graph type value as str
pysbs.sbslibrary.sbsdictionaries.getUsage(aUsage)
pysbs.sbslibrary.sbsdictionaries.getUsage(aUsage)
pysbs.sbslibrary.sbsdictionaries.getUsage(aUsage)

Get the given usage name

Parameters: aUsage (UsageEnum) – usage identifier
Returns: the usage as a string
pysbs.sbslibrary.sbsdictionaries.getWidgetName(aWidgetType)
pysbs.sbslibrary.sbsdictionaries.getWidgetName(aWidgetType)
pysbs.sbslibrary.sbsdictionaries.getWidgetName(aWidgetType)

Get the given widget type name

Parameters: aWidgetType (WidgetTypeEnum) – widget type identifier
Returns: the widget type as a string
pysbs.sbslibrary.sbsdictionaries.getWidgetOptionName(aWidgetOption)
pysbs.sbslibrary.sbsdictionaries.getWidgetOptionName(aWidgetOption)
pysbs.sbslibrary.sbsdictionaries.getWidgetOptionName(aWidgetOption)

Get the given widget option name

Parameters: aWidgetOption (WidgetOptionEnum) – widget option identifier
Returns: the widget option as a string
pysbs.sbslibrary.sbsdictionaries.getWidgetTypeEnum(aWidgetName)
pysbs.sbslibrary.sbsdictionaries.getWidgetTypeEnum(aWidgetName)
pysbs.sbslibrary.sbsdictionaries.getWidgetTypeEnum(aWidgetName)

Get the enum value of the given widget name

Parameters: aWidgetName (str) – widget name
Returns: the widget type as a WidgetTypeEnum

Get help faster and easier

New user?