sbslibrary module
Content included in sbslibrary module:
- sbsdictionaries module: Dictionaries of all strings used in the libraries
getAttribute()getColorSpace()getColorSpaceEnum()getCompNodeInput()getCompNodeInputEnum()getCompNodeOutput()getCompNodeOutputEnum()getCompNodeParam()getCompNodeParamEnum()getComponents()getCurveName()getCurveTypeEnum()getFunctionGetType()getFunctionInput()getFunctionInputEnum()getFunctionOutput()getFunctionOutputEnum()getGUIObjectTypeEnum()getGUIObjectTypeName()getResourceTypeEnum()getResourceTypeName()getSubstanceGraphTemplatePath()getSubstanceGraphType()getSubstanceMaterialModel()getUsage()getWidgetName()getWidgetOptionName()getWidgetTypeEnum()
- sbslibclasses module: Classes used by the library
CompNodeInputCompNodeOutputCompNodeParamCompNodeDefCompNodeDef.addBaseParameters()CompNodeDef.getAllInputIdentifiers()CompNodeDef.getAllInputLabels()CompNodeDef.getAllInputs()CompNodeDef.getAllOutputIdentifiers()CompNodeDef.getAllOutputs()CompNodeDef.getAllParameterIdentifiers()CompNodeDef.getAllParameters()CompNodeDef.getFirstInputOfType()CompNodeDef.getFirstOutputOfType()CompNodeDef.getIdentifier()CompNodeDef.getInput()CompNodeDef.getOutput()CompNodeDef.getParameter()CompNodeDef.isBaseParameter()CompNodeDef.isVariant()CompNodeDef.setInputs()CompNodeDef.setOutputs()
FunctionInputFunctionOutputFunctionParamFunctionDefFunctionDef.getAllInputIdentifiers()FunctionDef.getAllInputLabels()FunctionDef.getAllInputs()FunctionDef.getAllOutputIdentifiers()FunctionDef.getAllOutputs()FunctionDef.getAllParameterIdentifiers()FunctionDef.getAllParameters()FunctionDef.getFirstInputOfType()FunctionDef.getFirstOutputOfType()FunctionDef.getIdentifier()FunctionDef.getInput()FunctionDef.getInputType()FunctionDef.getOutput()FunctionDef.getParameter()FunctionDef.setInputs()FunctionDef.setOutputs()
FxMapNodeDefFxMapNodeDef.getAllInputIdentifiers()FxMapNodeDef.getAllInputLabels()FxMapNodeDef.getAllInputs()FxMapNodeDef.getAllOutputIdentifiers()FxMapNodeDef.getAllOutputs()FxMapNodeDef.getAllParameterIdentifiers()FxMapNodeDef.getAllParameters()FxMapNodeDef.getFirstInputOfType()FxMapNodeDef.getFirstOutputOfType()FxMapNodeDef.getIdentifier()FxMapNodeDef.getInput()FxMapNodeDef.getOutput()FxMapNodeDef.getParameter()FxMapNodeDef.isBaseParameter()FxMapNodeDef.isVariant()FxMapNodeDef.setInputs()FxMapNodeDef.setOutputs()
GradientKeyCurveKeyCurveDefinitionWidgetOptionInputParamWidget
- sbsfilters module (not exposed): Filters definition
- sbsfunctions module (not exposed): Functions definition
- sbsfxmapnodes module (not exposed): FxMap nodes definition
- sbswidgets module (not exposed): GUI Widgets definition
Module sbslibrary provides the libraries of Filters, Functions, FxMap nodes and Widgets that are defined in the
modules sbsfilters, sbsfunctions, sbsfxmapnodes and sbswidgets.
- Libraries:
__library_Filters: the library of Filters, identified by
FilterEnum:__library_Filters = { sbsenum.FilterEnum.BITMAP : sbsfilters.filter_BITMAP , sbsenum.FilterEnum.BLEND : sbsfilters.filter_BLEND , sbsenum.FilterEnum.BLUR : sbsfilters.filter_BLUR , sbsenum.FilterEnum.COMPINSTANCE : sbsfilters.filter_COMPINSTANCE , sbsenum.FilterEnum.CURVE : sbsfilters.filter_CURVE , sbsenum.FilterEnum.DIRECTIONALMOTIONBLUR : sbsfilters.filter_DIRECTIONALMOTIONBLUR , sbsenum.FilterEnum.DIRECTIONALWARP : sbsfilters.filter_DIRECTIONALWARP , sbsenum.FilterEnum.DISTANCE : sbsfilters.filter_DISTANCE , sbsenum.FilterEnum.DYNAMICGRADIENT : sbsfilters.filter_DYNAMICGRADIENT , sbsenum.FilterEnum.EMBOSS : sbsfilters.filter_EMBOSS , sbsenum.FilterEnum.FXMAPS : sbsfilters.filter_FXMAPS , sbsenum.FilterEnum.GRADIENT : sbsfilters.filter_GRADIENT , sbsenum.FilterEnum.GRAYSCALECONVERSION : sbsfilters.filter_GRAYSCALECONVERSION , sbsenum.FilterEnum.HSL : sbsfilters.filter_HSL , sbsenum.FilterEnum.LEVELS : sbsfilters.filter_LEVELS , sbsenum.FilterEnum.NORMAL : sbsfilters.filter_NORMAL , sbsenum.FilterEnum.PIXEL_PROCESSOR : sbsfilters.filter_PIXEL_PROCESSOR , sbsenum.FilterEnum.SHARPEN : sbsfilters.filter_SHARPEN , sbsenum.FilterEnum.SHUFFLE : sbsfilters.filter_SHUFFLE , sbsenum.FilterEnum.SVG : sbsfilters.filter_SVG , sbsenum.FilterEnum.TEXT : sbsfilters.filter_TEXT , sbsenum.FilterEnum.TRANSFORMATION : sbsfilters.filter_TRANSFORMATION , sbsenum.FilterEnum.UNIFORM : sbsfilters.filter_UNIFORM , sbsenum.FilterEnum.WARP : sbsfilters.filter_WARP , sbsenum.FilterEnum.VALUE_PROCESSOR : sbsfilters.filter_VALUE_PROCESSOR , sbsenum.FilterEnum.PASSTHROUGH : sbsfilters.filter_PASSTHROUGH , }__library_FxMapNodes: the library of FxMap node, identified by
FxMapNodeEnum:__library_FxMapNodes = { sbsenum.FxMapNodeEnum.ITERATE : sbsfxmapnodes.fxmap_ITERATE , sbsenum.FxMapNodeEnum.QUADRANT : sbsfxmapnodes.fxmap_QUADRANT , sbsenum.FxMapNodeEnum.SWITCH : sbsfxmapnodes.fxmap_SWITCH, sbsenum.FxMapNodeEnum.PASSTHROUGH : sbsfxmapnodes.fxmap_PASSTHROUGH }__library_Functions: the library of Function node, identified by
FunctionEnum:__library_Functions = { sbsenum.FunctionEnum.SEQUENCE : sbsfunctions.function_SEQUENCE , sbsenum.FunctionEnum.IF_ELSE : sbsfunctions.function_IF_ELSE , sbsenum.FunctionEnum.SET : sbsfunctions.function_SET , sbsenum.FunctionEnum.GET_BOOL : sbsfunctions.function_GET_BOOL , sbsenum.FunctionEnum.GET_INTEGER1 : sbsfunctions.function_GET_INTEGER1 , sbsenum.FunctionEnum.GET_INTEGER2 : sbsfunctions.function_GET_INTEGER2 , sbsenum.FunctionEnum.GET_INTEGER3 : sbsfunctions.function_GET_INTEGER3 , sbsenum.FunctionEnum.GET_INTEGER4 : sbsfunctions.function_GET_INTEGER4 , sbsenum.FunctionEnum.GET_FLOAT1 : sbsfunctions.function_GET_FLOAT1 , sbsenum.FunctionEnum.GET_FLOAT2 : sbsfunctions.function_GET_FLOAT2 , sbsenum.FunctionEnum.GET_FLOAT3 : sbsfunctions.function_GET_FLOAT3 , sbsenum.FunctionEnum.GET_FLOAT4 : sbsfunctions.function_GET_FLOAT4 , sbsenum.FunctionEnum.GET_STRING : sbsfunctions.function_GET_STRING , sbsenum.FunctionEnum.CONST_BOOL : sbsfunctions.function_CONST_BOOL , sbsenum.FunctionEnum.CONST_INT : sbsfunctions.function_CONST_INT , sbsenum.FunctionEnum.CONST_INT2 : sbsfunctions.function_CONST_INT2 , sbsenum.FunctionEnum.CONST_INT3 : sbsfunctions.function_CONST_INT3 , sbsenum.FunctionEnum.CONST_INT4 : sbsfunctions.function_CONST_INT4 , sbsenum.FunctionEnum.CONST_FLOAT : sbsfunctions.function_CONST_FLOAT , sbsenum.FunctionEnum.CONST_FLOAT2 : sbsfunctions.function_CONST_FLOAT2 , sbsenum.FunctionEnum.CONST_FLOAT3 : sbsfunctions.function_CONST_FLOAT3 , sbsenum.FunctionEnum.CONST_FLOAT4 : sbsfunctions.function_CONST_FLOAT4 , sbsenum.FunctionEnum.CONST_STRING : sbsfunctions.function_CONST_STRING , sbsenum.FunctionEnum.INSTANCE : sbsfunctions.function_INSTANCE , sbsenum.FunctionEnum.VECTOR2 : sbsfunctions.function_VECTOR2 , sbsenum.FunctionEnum.VECTOR3 : sbsfunctions.function_VECTOR3 , sbsenum.FunctionEnum.VECTOR4 : sbsfunctions.function_VECTOR4 , sbsenum.FunctionEnum.SWIZZLE1 : sbsfunctions.function_SWIZZLE1 , sbsenum.FunctionEnum.SWIZZLE2 : sbsfunctions.function_SWIZZLE2 , sbsenum.FunctionEnum.SWIZZLE3 : sbsfunctions.function_SWIZZLE3 , sbsenum.FunctionEnum.SWIZZLE4 : sbsfunctions.function_SWIZZLE4 , sbsenum.FunctionEnum.VECTOR_INT2 : sbsfunctions.function_VECTOR_INT2 , sbsenum.FunctionEnum.VECTOR_INT3 : sbsfunctions.function_VECTOR_INT3 , sbsenum.FunctionEnum.VECTOR_INT4 : sbsfunctions.function_VECTOR_INT4 , sbsenum.FunctionEnum.SWIZZLE_INT1 : sbsfunctions.function_SWIZZLE_INT1 , sbsenum.FunctionEnum.SWIZZLE_INT2 : sbsfunctions.function_SWIZZLE_INT2 , sbsenum.FunctionEnum.SWIZZLE_INT3 : sbsfunctions.function_SWIZZLE_INT3 , sbsenum.FunctionEnum.SWIZZLE_INT4 : sbsfunctions.function_SWIZZLE_INT4 , sbsenum.FunctionEnum.TO_INT : sbsfunctions.function_TO_INT , sbsenum.FunctionEnum.TO_INT2 : sbsfunctions.function_TO_INT2 , sbsenum.FunctionEnum.TO_INT3 : sbsfunctions.function_TO_INT3 , sbsenum.FunctionEnum.TO_INT4 : sbsfunctions.function_TO_INT4 , sbsenum.FunctionEnum.TO_FLOAT : sbsfunctions.function_TO_FLOAT , sbsenum.FunctionEnum.TO_FLOAT2 : sbsfunctions.function_TO_FLOAT2 , sbsenum.FunctionEnum.TO_FLOAT3 : sbsfunctions.function_TO_FLOAT3 , sbsenum.FunctionEnum.TO_FLOAT4 : sbsfunctions.function_TO_FLOAT4 , sbsenum.FunctionEnum.ADD : sbsfunctions.function_ADD , sbsenum.FunctionEnum.SUB : sbsfunctions.function_SUB , sbsenum.FunctionEnum.MUL : sbsfunctions.function_MUL , sbsenum.FunctionEnum.MUL_SCALAR : sbsfunctions.function_MUL_SCALAR , sbsenum.FunctionEnum.DIV : sbsfunctions.function_DIV , sbsenum.FunctionEnum.NEG : sbsfunctions.function_NEG , sbsenum.FunctionEnum.MOD : sbsfunctions.function_MOD , sbsenum.FunctionEnum.DOT : sbsfunctions.function_DOT , sbsenum.FunctionEnum.CROSS : sbsfunctions.function_CROSS , sbsenum.FunctionEnum.AND : sbsfunctions.function_AND , sbsenum.FunctionEnum.OR : sbsfunctions.function_OR , sbsenum.FunctionEnum.NOT : sbsfunctions.function_NOT , sbsenum.FunctionEnum.EQ : sbsfunctions.function_EQ , sbsenum.FunctionEnum.NOT_EQ : sbsfunctions.function_NOT_EQ , sbsenum.FunctionEnum.GREATER : sbsfunctions.function_GREATER , sbsenum.FunctionEnum.GREATER_EQUAL : sbsfunctions.function_GREATER_EQUAL , sbsenum.FunctionEnum.LOWER : sbsfunctions.function_LOWER , sbsenum.FunctionEnum.LOWER_EQUAL : sbsfunctions.function_LOWER_EQUAL , sbsenum.FunctionEnum.ABS : sbsfunctions.function_ABS , sbsenum.FunctionEnum.FLOOR : sbsfunctions.function_FLOOR , sbsenum.FunctionEnum.CEIL : sbsfunctions.function_CEIL , sbsenum.FunctionEnum.COS : sbsfunctions.function_COS , sbsenum.FunctionEnum.SIN : sbsfunctions.function_SIN , sbsenum.FunctionEnum.SQRT : sbsfunctions.function_SQRT , sbsenum.FunctionEnum.LOG : sbsfunctions.function_LOG , sbsenum.FunctionEnum.LOG2 : sbsfunctions.function_LOG2 , sbsenum.FunctionEnum.EXP : sbsfunctions.function_EXP , sbsenum.FunctionEnum.POW2 : sbsfunctions.function_POW2 , sbsenum.FunctionEnum.TAN : sbsfunctions.function_TAN , sbsenum.FunctionEnum.ATAN2 : sbsfunctions.function_ATAN2 , sbsenum.FunctionEnum.CARTESIAN : sbsfunctions.function_CARTESIAN , sbsenum.FunctionEnum.LERP : sbsfunctions.function_LERP , sbsenum.FunctionEnum.MIN : sbsfunctions.function_MIN , sbsenum.FunctionEnum.MAX : sbsfunctions.function_MAX , sbsenum.FunctionEnum.RAND : sbsfunctions.function_RAND , sbsenum.FunctionEnum.SAMPLE_LUM : sbsfunctions.function_SAMPLE_LUM , sbsenum.FunctionEnum.SAMPLE_COL : sbsfunctions.function_SAMPLE_COL , sbsenum.FunctionEnum.PASSTHROUGH : sbsfunctions.function_PASSTHROUGH , sbsenum.FunctionEnum.POW : sbsfunctions.function_POW , sbsenum.FunctionEnum.WHILE : sbsfunctions.function_WHILE , }__library_Widgets: the library of GUI widgets, identified by
WidgetEnum:__library_Widgets = { sbsenum.WidgetEnum.BUTTON_BOOL : sbswidgets.widget_Button_Bool , sbsenum.WidgetEnum.SLIDER_INT1 : sbswidgets.widget_Slider_Int1 , sbsenum.WidgetEnum.SLIDER_INT2 : sbswidgets.widget_Slider_Int2 , sbsenum.WidgetEnum.SLIDER_INT3 : sbswidgets.widget_Slider_Int3 , sbsenum.WidgetEnum.SLIDER_INT4 : sbswidgets.widget_Slider_Int4 , sbsenum.WidgetEnum.SLIDER_FLOAT1 : sbswidgets.widget_Slider_Float1 , sbsenum.WidgetEnum.SLIDER_FLOAT2 : sbswidgets.widget_Slider_Float2 , sbsenum.WidgetEnum.SLIDER_FLOAT3 : sbswidgets.widget_Slider_Float3 , sbsenum.WidgetEnum.SLIDER_FLOAT4 : sbswidgets.widget_Slider_Float4 , sbsenum.WidgetEnum.DROPDOWN_INT1 : sbswidgets.widget_DropDown_Int1 , sbsenum.WidgetEnum.SIZE_POW2_INT2 : sbswidgets.widget_Size_Pow2_Int2 , sbsenum.WidgetEnum.ANGLE_FLOAT1 : sbswidgets.widget_Angle_Float1 , sbsenum.WidgetEnum.COLOR_FLOAT1 : sbswidgets.widget_Color_Float1 , sbsenum.WidgetEnum.COLOR_FLOAT3 : sbswidgets.widget_Color_Float3 , sbsenum.WidgetEnum.COLOR_FLOAT4 : sbswidgets.widget_Color_Float4 , sbsenum.WidgetEnum.MATRIX_INVERSE_FLOAT4 : sbswidgets.widget_Matrix_Inverse_Float4, sbsenum.WidgetEnum.MATRIX_FORWARD_FLOAT4 : sbswidgets.widget_Matrix_Forward_Float4, sbsenum.WidgetEnum.TEXT_STRING : sbswidgets.widget_Text_String , sbsenum.WidgetEnum.POSITION_FLOAT2 : sbswidgets.widget_Position_Float2 , sbsenum.WidgetEnum.OFFSET_FLOAT2 : sbswidgets.widget_Offset_Float2 , sbsenum.WidgetEnum.ENUM_BUTTONS : sbswidgets.widget_Enum_Buttons , sbsenum.WidgetEnum.FUNCTION_BUTTON_FLOAT1 : sbswidgets.widget_FunctionButton_Float1, sbsenum.WidgetEnum.FUNCTION_BUTTON_FLOAT2 : sbswidgets.widget_FunctionButton_Float2, sbsenum.WidgetEnum.FUNCTION_BUTTON_FLOAT3 : sbswidgets.widget_FunctionButton_Float3, sbsenum.WidgetEnum.FUNCTION_BUTTON_FLOAT4 : sbswidgets.widget_FunctionButton_Float4, sbsenum.WidgetEnum.FUNCTION_BUTTON_INT1 : sbswidgets.widget_FunctionButton_Int1 , sbsenum.WidgetEnum.FUNCTION_BUTTON_INT2 : sbswidgets.widget_FunctionButton_Int2 , sbsenum.WidgetEnum.FUNCTION_BUTTON_INT3 : sbswidgets.widget_FunctionButton_Int3 , sbsenum.WidgetEnum.FUNCTION_BUTTON_INT4 : sbswidgets.widget_FunctionButton_Int4 , sbsenum.WidgetEnum.FUNCTION_BUTTON_BOOL : sbswidgets.widget_FunctionButton_Bool , sbsenum.WidgetEnum.FUNCTION_BUTTON_STRING : sbswidgets.widget_FunctionButton_String, }
- sbslibrary.sbslibrary.__convertToEnum(aKey, aGetEnumFunction)
- sbslibrary.sbslibrary.getAllWidgetFunctionButtonByType()
Get a map of all the functionbutton widgets by their param type
- sbslibrary.sbslibrary.getAngleWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getButtonWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getColorWidgetByType(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)
Get the given widget
- sbslibrary.sbslibrary.getEnumButtonsWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getFilterDefinition(aFilter)
Get the definition of the given filter (inputs, outputs, parameters)
- Parameters:
aFilter (
FilterEnumor str) – filter identifier- Returns:
a
CompNodeDefobject 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 (
FunctionEnumor str) – function identifier- Returns:
a
FunctionDefobject 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 (
FxMapNodeEnumor str) – FxMap node identifier- Returns:
a
CompNodeDefobject 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
CompNodeDefobject if found, None otherwise
- sbslibrary.sbslibrary.getIterationParamInput()
Get the description of the ‘iteration’ parameter
- Returns:
the
CompNodeParamdescribing this parameter
- sbslibrary.sbslibrary.getOffsetWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getOutputBridgeDefinition()
Get the definition of an output bridge node (inputs, outputs, parameters)
- Returns:
a
CompNodeDefobject if found, None otherwise
- sbslibrary.sbslibrary.getPositionWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getSliderWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getTransformationForwardWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getTransformationInverseWidgetByType(aType)
Get the given widget
- sbslibrary.sbslibrary.getWidgetByType(aType)
Get the given widget