Module sbsarguiwidget aims to define SBSARObjects that are relative to the GUI widget as saved in a .sbsar file: - SBSARGuiWidget
- SBSARGuiAngle
- SBSARGuiComboBox
- SBSARGuiComboBoxItem
- SBSARGuiSlider
- SBSARGuiImage
- SBSARUsage
class sbsarchive.sbsarguiwidgets.SBSARGuiAngle(aMin='', aMax='', aClamp=None, aStep=None, aUnit=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiAngle(aMin='', aMax='', aClamp=None, aStep=None, aUnit=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiAngle(aMin='', aMax='', aClamp=None, aStep=None, aUnit=None)
Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget
Class that contains information on the GUI slider widget of an input parameter as defined in a .sbsar file
- Members:
- mMin (str): Minimum value
- mMax (str): Maximum value
- mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
- mStep (str, optional): Defines step value for the widget.
- mUnit (str, optional): Unit of the angle (‘degrees’,’radians’,’turns’)
convertValueToBool(aValue)
convertValueToBool(aValue)
convertValueToBool(aValue)
Converts the given value to a boolean, if the conversion is possible.
Parameters: | aValue (str) – The value to convert |
Returns: | a boolean if the conversion is possible, the given aValue as is otherwise |
Returns: | the clamp as a boolean if defined for this widget, None otherwise |
Returns: | the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. |
Returns: | the list of all labels defined for this widget, in the right order, as a list of strings. |
Returns: | the maximum value as a string if defined for this widget, None otherwise |
Returns: | the minimum value as a string if defined for this widget, None otherwise |
Returns: | the step as a string if defined for this widget, None otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiButton(aLabel0='', aLabel1='')
class sbsarchive.sbsarguiwidgets.SBSARGuiButton(aLabel0='', aLabel1='')
class sbsarchive.sbsarguiwidgets.SBSARGuiButton(aLabel0='', aLabel1='')
Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget
Class that contains information on the GUI button widget of an input parameter as defined in a .sbsar file
convertValueToBool(aValue)
convertValueToBool(aValue)
convertValueToBool(aValue)
Converts the given value to a boolean, if the conversion is possible.
Parameters: | aValue (str) – The value to convert |
Returns: | a boolean if the conversion is possible, the given aValue as is otherwise |
Returns: | the clamp as a boolean if defined for this widget, None otherwise |
Returns: | the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. |
Returns: | the list of all labels defined for this widget, in the right order, as a list of strings. |
Returns: | the maximum value as a string if defined for this widget, None otherwise |
Returns: | the minimum value as a string if defined for this widget, None otherwise |
Returns: | the step as a string if defined for this widget, None otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBox(aComboBoxItems=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBox(aComboBoxItems=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBox(aComboBoxItems=None)
Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget
Class that contains information on the GUI combo box widget of an input parameter as defined in a .sbsar file
- Members:
-
convertValueToBool(aValue)
convertValueToBool(aValue)
convertValueToBool(aValue)
Converts the given value to a boolean, if the conversion is possible.
Parameters: | aValue (str) – The value to convert |
Returns: | a boolean if the conversion is possible, the given aValue as is otherwise |
Returns: | the clamp as a boolean if defined for this widget, None otherwise |
Returns: | the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. |
Returns: | the list of all labels defined for this widget, in the right order, as a list of strings. |
Returns: | the maximum value as a string if defined for this widget, None otherwise |
Returns: | the minimum value as a string if defined for this widget, None otherwise |
Returns: | the step as a string if defined for this widget, None otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBoxItem(aValue='', aText='')
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBoxItem(aValue='', aText='')
class sbsarchive.sbsarguiwidgets.SBSARGuiComboBoxItem(aValue='', aText='')
Bases: pysbs.common_interfaces.sbsarobject.SBSARObject
Class that contains information on the GUI combo box widget of an input parameter as defined in a .sbsar file
- Members:
- mValue (str): Drop down value (integer)
- mText (str): Associated label
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiImage(aColorType='', aUsages=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiImage(aColorType='', aUsages=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiImage(aColorType='', aUsages=None)
Bases: pysbs.common_interfaces.sbsarobject.SBSARObject
Class that contains information on the GUI image widget of an input as defined in a .sbsar file
- Members:
- mColorType (str): Color mode, ‘color’ or ‘grayscale’
- mUsages (list of
SBSARUsage
): usages of this input image (‘’ in the .sbsar file)
Get the usages of this param input
Returns: | the list of SBSARUsage defined on this image input |
Check if the given usage is defined on this image input
Parameters: | aUsage (str or UsageEnum ) – The usage to look for |
Returns: | True if the given usage is defined on this param input, False otherwise |
Check if the image is in color
Returns: | True if this is a color image, False otherwise |
Check if the image is in grayscale
Returns: | True if this is a grayscale image, False otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiSlider(aMin='', aMax='', aStep='', aClamp='off', aLabel0='X', aLabel1='Y', aLabel2='Z', aLabel3='W', aSuffix=None, aValueScale=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiSlider(aMin='', aMax='', aStep='', aClamp='off', aLabel0='X', aLabel1='Y', aLabel2='Z', aLabel3='W', aSuffix=None, aValueScale=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiSlider(aMin='', aMax='', aStep='', aClamp='off', aLabel0='X', aLabel1='Y', aLabel2='Z', aLabel3='W', aSuffix=None, aValueScale=None)
Bases: sbsarchive.sbsarguiwidgets.SBSARGuiWidget
Class that contains information on the GUI angle widget of an input parameter as defined in a .sbsar file
- Members:
- mMin (str): Minimum value
- mMax (str): Maximum value
- mStep (str): Defines step value for the slider.
- mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
- mLabel0 (str, optional): First value label
- mLabel1 (str, optional): Second value label
- mLabel2 (str, optional): Third value label
- mLabel3 (str, optional): Fourth value label
- mSuffix (str, optional): Suffix
- mValueScale (str, optional): Value scale
convertValueToBool(aValue)
convertValueToBool(aValue)
convertValueToBool(aValue)
Converts the given value to a boolean, if the conversion is possible.
Parameters: | aValue (str) – The value to convert |
Returns: | a boolean if the conversion is possible, the given aValue as is otherwise |
Returns: | the clamp as a boolean if defined for this widget, None otherwise |
Returns: | the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. |
Returns: | the list of all labels defined for this widget, in the right order, as a list of strings. |
Returns: | the maximum value as a string if defined for this widget, None otherwise |
Returns: | the minimum value as a string if defined for this widget, None otherwise |
Returns: | the step as a string if defined for this widget, None otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARGuiWidget(aMin=None, aMax=None, aStep=None, aClamp=None, aComboBoxItems=None, aLabel0=None, aLabel1=None, aLabel2=None, aLabel3=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiWidget(aMin=None, aMax=None, aStep=None, aClamp=None, aComboBoxItems=None, aLabel0=None, aLabel1=None, aLabel2=None, aLabel3=None)
class sbsarchive.sbsarguiwidgets.SBSARGuiWidget(aMin=None, aMax=None, aStep=None, aClamp=None, aComboBoxItems=None, aLabel0=None, aLabel1=None, aLabel2=None, aLabel3=None)
Bases: pysbs.common_interfaces.sbsarobject.SBSARObject
Class that contains information on a GUI widget of an input parameter as defined in a .sbsar file. Base class for SBSARGuiAngle
, SBSARGuiColor
, SBSARGuiSlider
- Members:
- mMin (str): Minimum value
- mMax (str): Maximum value
- mStep (str): Defines step value for the slider.
- mClamp (str, optional): Defines if the values are clamped to [min,max] range or not (‘on’,’off’). Default to off.
- mLabel0 (str, optional): First value label
- mLabel1 (str, optional): Second value label
- mLabel2 (str, optional): Third value label
- mLabel3 (str, optional): Fourth value label
convertValueToBool(aValue)
convertValueToBool(aValue)
convertValueToBool(aValue)
Converts the given value to a boolean, if the conversion is possible.
Parameters: | aValue (str) – The value to convert |
Returns: | a boolean if the conversion is possible, the given aValue as is otherwise |
Returns: | the clamp as a boolean if defined for this widget, None otherwise |
Returns: | the map{value(int):label(str)} corresponding to the drop down definition if defined in this widget, None otherwise. |
Returns: | the list of all labels defined for this widget, in the right order, as a list of strings. |
Returns: | the maximum value as a string if defined for this widget, None otherwise |
Returns: | the minimum value as a string if defined for this widget, None otherwise |
Returns: | the step as a string if defined for this widget, None otherwise |
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |
class sbsarchive.sbsarguiwidgets.SBSARUsage(aName='', aComponents='', aColorSpace=None)
class sbsarchive.sbsarguiwidgets.SBSARUsage(aName='', aComponents='', aColorSpace=None)
class sbsarchive.sbsarguiwidgets.SBSARUsage(aName='', aComponents='', aColorSpace=None)
Bases: pysbs.common_interfaces.sbsarobject.SBSARObject
Class that contains information on the channels of an input or output texture as defined in a .sbsar file
- Members:
- mName (str): Drop down value (integer)
- mComponents (str, optional): Color components. Default to ‘RGBA’
- mColorSpace (str, optional): Color space for the channel
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
Parameters: | - aContext (
Context ) – execution context - aDirAbsPath (str) – the absolute directory containing the current parsed package (.sbs file)
- aSBSParser (
SBSParser ) – the substance parser - aXmlNode (
xml.etree.ElementTree ) – the xml node to parse |