params module

Content included in params module:

• dynamicvalue module: Function graph definition
  • SBSDynamicValue
    • SBSDynamicValue.connectNodes()
    • SBSDynamicValue.contains()
    • SBSDynamicValue.copy()
    • SBSDynamicValue.copyNode()
    • SBSDynamicValue.createComment()
    • SBSDynamicValue.createFrame()
    • SBSDynamicValue.createFrameAroundNodes()
    • SBSDynamicValue.createFunctionInstanceNode()
    • SBSDynamicValue.createFunctionInstanceNodeFromPath()
    • SBSDynamicValue.createFunctionNode()
    • SBSDynamicValue.createIterationOnNode()
    • SBSDynamicValue.createIterationOnPattern()
    • SBSDynamicValue.createNavigationPin()
    • SBSDynamicValue.deleteComment()
    • SBSDynamicValue.deleteFrame()
    • SBSDynamicValue.deleteNavigationPin()
    • SBSDynamicValue.deleteNode()
    • SBSDynamicValue.disconnectNodes()
    • SBSDynamicValue.duplicateNode()
    • SBSDynamicValue.equals()
    • SBSDynamicValue.getAllComments()
    • SBSDynamicValue.getAllDependencyUID()
    • SBSDynamicValue.getAllFrames()
    • SBSDynamicValue.getAllFunctionsOfKind()
    • SBSDynamicValue.getAllGUIObjects()
    • SBSDynamicValue.getAllNavigationPins()
    • SBSDynamicValue.getAllNodeInstancesOf()
    • SBSDynamicValue.getAllReferencesOnDependency()
    • SBSDynamicValue.getCommentsAssociatedToNode()
    • SBSDynamicValue.getConnectionsFromNode()
    • SBSDynamicValue.getConnectionsToNode()
    • SBSDynamicValue.getNode()
    • SBSDynamicValue.getNodeAssociatedToComment()
    • SBSDynamicValue.getNodeList()
    • SBSDynamicValue.getNodesConnectedFrom()
    • SBSDynamicValue.getNodesConnectedTo()
    • SBSDynamicValue.getNodesDockedTo()
    • SBSDynamicValue.getNodesInFrame()
    • SBSDynamicValue.getOutputNode()
    • SBSDynamicValue.getOutputType()
    • SBSDynamicValue.getRect()
    • SBSDynamicValue.getUidIsUsed()
    • SBSDynamicValue.getUsedParameters()
    • SBSDynamicValue.isAPathBetween()
    • SBSDynamicValue.moveConnectionOnPinInput()
    • SBSDynamicValue.moveConnectionsOnPinOutput()
    • SBSDynamicValue.parse()
    • SBSDynamicValue.reframeAroundNodes()
    • SBSDynamicValue.setOutputNode()
    • SBSDynamicValue.setToInputParam()
    • SBSDynamicValue.sortNodesAsDAG()
    • SBSDynamicValue.updateValueProcessorType()
    • SBSDynamicValue.write()
• paramnode module: Function node definition
  • SBSFuncData
    • SBSFuncData.equals()
    • SBSFuncData.getUidIsUsed()
    • SBSFuncData.getValue()
    • SBSFuncData.parse()
    • SBSFuncData.write()
  • SBSParamNode
    • SBSParamNode.changeDependencyUID()
    • SBSParamNode.changeInstancePath()
    • SBSParamNode.classify()
    • SBSParamNode.equals()
    • SBSParamNode.getConnectedNodesUID()
    • SBSParamNode.getConnectionOnPin()
    • SBSParamNode.getConnections()
    • SBSParamNode.getConnectionsFromNode()
    • SBSParamNode.getDefinition()
    • SBSParamNode.getDependencyUID()
    • SBSParamNode.getDisplayName()
    • SBSParamNode.getInputDefinition()
    • SBSParamNode.getOffsetPosition()
    • SBSParamNode.getOutputType()
    • SBSParamNode.getParameterValue()
    • SBSParamNode.getPosition()
    • SBSParamNode.getRect()
    • SBSParamNode.getReferenceAbsPath()
    • SBSParamNode.getReferenceInternalPath()
    • SBSParamNode.getUidIsUsed()
    • SBSParamNode.hasAReferenceOnDependency()
    • SBSParamNode.hasAReferenceOnInternalPath()
    • SBSParamNode.isAnInstance()
    • SBSParamNode.isConnectedTo()
    • SBSParamNode.isDocked()
    • SBSParamNode.parse()
    • SBSParamNode.removeConnectionOnPin()
    • SBSParamNode.removeConnectionsFrom()
    • SBSParamNode.resolveDependency()
    • SBSParamNode.setParameterValue()
    • SBSParamNode.setPosition()
    • SBSParamNode.setType()
    • SBSParamNode.unsetParameter()
    • SBSParamNode.write()

Module params aims to define SBSObjects that are relative to the Function nodes, mostly:

• SBSParamNode

• SBSParamValue

• SBSDynamicValue

This module contains also the definition of the parameters (SBSParameter), which are useful for the SBSParamNode and the SBSCompNode.

class params.params.SBSParamSpotColorInfo(aSpotColorBookId='', aSpotColorId='')

Bases: SBSObject

Class that contains information on a SpotColor as defined in a .sbs file. It allows to define a spotcolor book id and a spotcolor color id

Members:

• mSpotColorBookId (str): Id of the SpotColor book

• mSpotColorId (str): Id of the color from the spotcolor book id

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getInfo(aProjectMgr=None)

get color spot info

Parameters:

aProjectMgr – a ProjectMgr can be needed if ACE config is setup

Returns:

list of SpotColorInfoStruct

getInfoAsDict(aProjectMgr=None)

get color spot info as dict

Parameters:

aProjectMgr – a ProjectMgr can be needed if ACE config is setup

Returns:

list of dict

getUidIsUsed(aUID)

Check if the given uid is already used in the context of this SBSObject.

Parameters:

aUID (str) – UID to check

Returns:

True if the uid is already used, False otherwise

Raise:

AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject

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

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

• aSBSWriter (SBSWriter) – the substance writer

• aXmlNode (xml.etree.ElementTree) – the xml node to fill

class params.params.SBSParamValue(aConstantValue=None, aDynamicValue=None, aTagName='')

Bases: SBSConstantValue

Class that contains information on a parameter value as defined in a .sbs file. A parameter can have a constant value with a specific type, or a value defined dynamically by a function.

Members:

• mConstantValue (SBSConstantValue): simple constant definition of the parameter.

• mDynamicValue (SBSDynamicValue): dynamic definition of the parameter.

• mTagName (str): tag name in the .sbs file, which provides the information of the parameter type.

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getConstantValue()

Get the constant value of this param value

Returns:

the constant value as a SBSConstantValue if it exists, None otherwise

getDynamicValue()

Get the dynamic value of this param value

Returns:

the dynamic value as a SBSDynamicValue if it exists, None otherwise

getType()

Get the type of this constant value

Returns:

The type as a ParamTypeEnum if success, None otherwise

getTypedConstantValue()

Get the constant value of this parameter, typed according to the type of this parameter

Returns:

The constant parameter value appropriately typed according to the parameter type, None otherwise.

getUidIsUsed(aUID)

Check if the given uid is already used in the context of this SBSObject.

Parameters:

aUID (str) – UID to check

Returns:

True if the uid is already used, False otherwise

Raise:

AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject

getValue()

Get the value of this parameter

Returns:

The parameter value, as a string if it is a constant value, or as a SBSDynamicValue if it is a dynamic value

isConstant(self)

Returns:

True if this parameter has a constant definition

isDynamic(self)

Returns:

True if this parameter is handled by a dynamic value

static isValidValue(aType, aValue)

setConstantValue(aType, aValue, aInt1 = False) Set the constant value to the given value, and set the tagname accordingly to the type of the value.

Parameters:

• aType (ParamTypeEnum) – type of the value

• aValue (str) – the value to set

• aInt1 (bool) – True if the tag name must be ‘Int1’ instead of ‘Int32’ in the case of a value INTEGER1. Default to False

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

setConstantValue(aType, aValue, aInt1=False)

Set the constant value of this param value to the given value and type. Remove the dynamic value if it exists.

Parameters:

• aType (ParamTypeEnum) – type of the parameter

• aValue (str) – value to set

• aInt1 (bool) – True if the tag name must be ‘Int1’ instead of ‘Int32’ in the case of a value INTEGER1. Default to False

setDynamicValue(aDynValue)

Set the dynamic value of this param value to the given value. Remove the constant value if it exists.

Parameters:

aDynValue (SBSDynamicValue) – value to set

updateConstantValue(aValue)

Update the value.

Parameters:

aValue (str) – the value to set

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

• aSBSWriter (SBSWriter) – the substance writer

• aXmlNode (xml.etree.ElementTree) – the xml node to fill

class params.params.SBSParameter(aName='', aRelativeTo=None, aParamValue=None, aSpotColorInfo=None)

Bases: SBSObject

Class that contains information of a parameter as defined in a .sbs file. This class is used to define the parameters of a compositing node, a function node or even a graph.

Members:

• mName (str): name of the parameter to define.

• mRelativeTo (str, optional): parameter inheritance definition, among the list defined in ParamInheritanceEnum.

• mParamValue (SBSParamValue): definition of the parameter (constant value or dynamic function)

createEmptyDynamicValue()

Init a dynamic value for this parameter. Remove the previous constant value or dynamic value if defined.

Returns:

the new empty SBSDynamicValue

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getConstantValue()

Get the constant value of this parameter

Returns:

the constant value as a SBSConstantValue if it exists, None otherwise

getDynamicValue()

Get the dynamic value of this parameter

Returns:

the dynamic value as a SBSDynamicValue if it exists, None otherwise

getSpotColorInfo()

getSpotColoInfo() get SBSParamSpotColorInfo that handle spot color info

Returns:

SBSParamSpotColorInfo

getUidIsUsed(aUID)

Check if the given uid is already used in the context of this SBSObject.

Parameters:

aUID (str) – UID to check

Returns:

True if the uid is already used, False otherwise

Raise:

AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject

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

setDynamicValue(aDynamicValue)

Set the dynamic value for this parameter. Remove the previous constant value or dynamic value if defined.

Parameters:

aDynamicValue (SBSDynamicValue) – the dynamic value to affect

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

• aSBSWriter (SBSWriter) – the substance writer

• aXmlNode (xml.etree.ElementTree) – the xml node to fill

class params.params.SBSParamsArray(aName='', aUID='', aParamsArrayCells=None)

Bases: SBSObject

Class that contains information on a paramsArray as defined in a .sbs file. It allows to define the gradient keys in a Gradient map filter.

Members:

• mName (str): name (type) of the array.

• mUID (str): unique identifier of the array in the /paramsArray/ context.

• mParamsArrayCells (list of SBSParamsArrayCell): list of cells, representing gradient keys.

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getUidIsUsed(aUID)

Parse the ParamsArrayCell list to find a SBSParamsArrayCell with the given uid

Parameters:

aUID (str) – UID to check

Returns:

True if this uid is already used, False otherwise

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

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

• aSBSWriter (SBSWriter) – the substance writer

• aXmlNode (xml.etree.ElementTree) – the xml node to fill

class params.params.SBSParamsArrayCell(aUID='', aParameters=None)

Bases: SBSObject

Class that contains information on a paramsArrayCell as defined in a .sbs file. It allows to define a gradient key in a Gradient map filter.

Members:

• mUID (str): unique identifier of the cell in the /paramsArrayCells/ context.

• mParameters (list of SBSParameter): parameter list of the cell.

equals(other)

Check if this SBSObject is equivalent to the other SBSObject. Some members may be excluded from this check, the UIDs or GUILayout for instance.

Parameters:

other (SBSObject) – The SBSObject to compare to

Returns:

True if the two SBSObject are similar according to their definition.

getUidIsUsed(aUID)

Check if the given uid is already used in the context of this SBSObject.

Parameters:

aUID (str) – UID to check

Returns:

True if the uid is already used, False otherwise

Raise:

AttributeError if the function getUidIsUsed in not properly overloaded on this SBSObject

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

write(aSBSWriter, aXmlNode)

Write recursively the content of the SBSObject into the given xml node.

Parameters:

• aSBSWriter (SBSWriter) – the substance writer

• aXmlNode (xml.etree.ElementTree) – the xml node to fill