- Substance 3D home
- Home
- Command Line Tools
- Command Line overview
- sbsbaker
- sbscooker
- sbsmtools
- sbsmutator
- sbsrender
- sbsupdater
- Command Line overview
- Pysbs - Python API
- Pysbs - Python API overview
- Getting started
- General topics
- Examples
- API Content
- API Content overview
- Substance definitions
- Common interfaces
- compnode
- context projectmgr
- graph
- mdl
- modelgraphindex
- modelannotationnames
- modelgraph
- modelgraphgenerator
- modelgraphimplementation
- modelnodenames
- modeloperand
- modulegraphindex
- moduleannotation
- moduleconnection
- modulegraph
- modulegraphgenerator
- modulegraphimplementation
- modulegraphlibrary
- modulegraphregister
- modulenode
- modulenodeimplementation
- modulenodeinstance
- moduleoperand
- moduleoutputbridging
- moduleparaminput
- params
- projectmgrdoc
- sbsarchive
- sbscommon
- sbspreset
- sbsproject
- substance
- Libraries
- sbsenum
- sbslibrary
- sbsbakerslibrary
- Helpers
- Execution context
- API Change log
- Samples
- Setup and Getting Started
- Integrations
- Substance Maya toolset
- Release notes
mdlnode
class mdl.mdlnode.MDLNode(aUID='', aGUILayout=None, aConnections=None, aMDLImplementation=None)
Bases: pysbs.sbscommon.nodes.SBSNode
Class that contains information on a MDL node as defined in a .sbs file
- Members:
- mUID (str): node unique identifier in the MDLGraph context.
- mGUILayout (
SBSGUILayout): GUI position/options - mConnections (list of
SBSConnection, optional): input connections list. - mMDLImplementation (
MDLImplementation): implementation of the MDL node.
changeDependencyUID(aSBSDocument, oldDepUID, newDepUID)
Change the UID of the dependency referenced by this node.
| Parameters: |
|
|---|
changeResourcePath(oldPath, newPath)
Change the referenced resource path.
| Parameters: |
|
|---|
classify(aOther, aParentContainer = None)
Use the definition of the two nodes to classify them, and their GUI position if they have the same definition.
To classify the different kind of MDLImplementation, this order is specify:
Constant < Selector < MDLInstance < MDLGraphInstance < SBSInstance.
For two identical implementation kind, the names or the paths of the nodes are used to compare the lexicographic order.
At a final option, the GUI position is used, and in this case, mostLeft < mostRight and then mostUp < mostDown.
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.
getConnectedNodesUID()
Get the UIDs of the nodes connected to this node.
| Returns: | The UIDs as a list of string |
|---|
getConnectionOnPin(aPinIdentifier)
Get the connection defined on the given input.
| Parameters: | aPinIdentifier (str) – identifier of the input pin (for SBSCompNode, SBSParamNode and MDLNode) or of the output pin(for SBSParamsGraphNode) |
|---|---|
| Returns: | a SBSConnection object corresponding to the connection defined on the given pin. None otherwise |
getConnections()
Get the connections defined on this node.
| Returns: | a list of SBSConnection |
|---|
getConnectionsFromNode(aLeftNode)
Get all the connections coming from the given left node.
| Parameters: | aLeftNode (SBSNode or str) – The node to look for in the incoming connections of this node, as an object or a UID |
|---|---|
| Returns: | a list of SBSConnection |
getDefinition()
Get the node definition (Inputs, Outputs, Parameters) accordingly to the MDL node implementation
| Returns: | a MDLNodeDef object if defined, None otherwise |
|---|
getDisplayName()
| Returns: | the display name of this node as a string |
|---|
getInputDefinition(self, aInputIdentifier=None)
Get the input definition corresponding to the given identifier.
| Parameters: | aInputIdentifier (InputEnum or str, optional) – The identifier to get. If let None, the primary input will be returned |
|---|---|
| Returns: | the input definition as a CompNodeInput if found, None otherwise |
getMDLImplConstant()
| Returns: | the MDLImplConstant object if this node is a MDL constant, None otherwise. |
|---|
getMDLImplMDLGraphInstance()
| Returns: | the MDLImplMDLGraphInstance object if this node is a MDL graph instance, None otherwise. |
|---|
getMDLImplMDLInstance()
| Returns: | the MDLImplMDLInstance object if this node is a native MDL instance, None otherwise. |
|---|
getMDLImplSBSInstance()
| Returns: | the MDLImplSBSInstance object if this node is a Substance graph instance, None otherwise. |
|---|
getMDLImplSelector()
| Returns: | the MDLImplSelector object if this node is a MDL selector, None otherwise. |
|---|
getMDLImplementation(self)
Get the appropriate implementation depending on the MDL node kind
| Returns: | A MDLNodeImpl object |
|---|
getOffsetPosition(aOffset = None)
Compute the position of this node offset by the given offset
| Parameters: | aOffset (list of 2 float, optional) – the offset to apply to the node’s current position. Default to [0,0] |
|---|---|
| Returns: | the offset position |
getOutputType(aOutputIdentifier=None)
Get the output type of this node given the output identifier.
| Parameters: | aOutputIdentifier (str, optional) – The output identifier to look for. If None, the first output will be considered |
|---|---|
| Returns: | The node output type as a string (color or float) if found, None otherwise |
getParameter(aParameter=None)
Get a parameter with the given name in the appropriate MDL node implementation. The parameter can be: - None in case of a Constant or Selector node, where there is only one parameter. - Simply the name of the parameter to get - A set of names separated by ‘/’ to access a sub member of the root member, for instance ‘surface/intensity’ - A name with an operator [] to access a particular item of a parameter array, for instance ‘color[2]’
| Parameters: | aParameter (str, optional) – Parameter identifier (name of the operand). Can be None in case of a MDLImplConstant or a MDLImplSelector |
|---|---|
| Returns: | The parameter if found (MDLParameter or MDLOperand), None otherwise |
getParameterValue(aParameter=None)
Find a parameter with the given name in the appropriate MDL node implementation, and return its value. The parameter can be: - None in case of a Constant or Selector node, where there is only one parameter. - Simply the name of the parameter to get - A set of names separated by ‘/’ to access a sub member of the root member, for instance ‘surface/intensity’ - A name with an operator [] to access a particular item of a parameter array, for instance ‘color[2]’
| Parameters: | aParameter (str, optional) – Parameter identifier (name of the operand). Can be None in case of a MDLImplConstant or a MDLImplSelector |
|---|---|
| Returns: | The parameter value if found, None otherwise |
getPosition()
Get the position of this node in the graph GUI.
| Returns: | a list of 3 float |
|---|
getRect()
Return the rectangle of this node.
| Returns: | The rectangle as a Rect |
|---|
getResourcesPath()
If this node uses resources in its parameters, returns the list of resources used.
| Returns: | The list of resources used by this node, as internal paths. Return an empty list 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 |
hasAReferenceOnDependency(aDependency)
Check if this node directly references the given dependency. For instance if it instantiates a graph or a resource included in this dependency.
| Parameters: | aDependency (str or SBSDependency) – The dependency to look for (UID or object) |
|---|---|
| Returns: | True if this node references this dependency, False otherwise |
hasAReferenceOnInternalPath(aInternalPath)
Check if this node references the given internal path (pkg:///). For instance if it instantiates the graph or the resource pointed at the given path.
| Parameters: | aInternalPath (str) – The internal path to look for |
|---|---|
| Returns: | True if this node references the given internal path, False otherwise |
isAConstant()
| Returns: | True if the MDLNode is a constant node implementation, False otherwise. |
|---|
isAPassthrough()
| Returns: | True if the MDLNode is passthrough (e.g. an implementation of a special node that allows to organize graph connection layout), False otherwise. |
|---|
isAPotentialOutput()
Check if this node can be set as an output of the MDLGraph
| Returns: | True if the MDLNode is a MDL instance of kind ‘mdl::material(bool,material_surface,material_surface,color,material_volume,material_geometry)’ |
|---|
isASelector()
| Returns: | True if the MDLNode is selector (e.g. an implementation of a special node that allows access to struct members), False otherwise. |
|---|
isAnInput()
| Returns: | True if the MDLNode is an input of the graph (e.g. exposed constant node), False otherwise. |
|---|
isConnectedTo(aLeftNode)
Check if the node is connected to the given node, in the direction aLeftNode -> self
| Parameters: | aLeftNode (SBSNode or str (UID)) – The node to look for in the connections of this node. |
|---|---|
| Returns: | True if the nodes are connected, False otherwise |
isDocked()
Check if this node is docked.
| Returns: | True if this node is docked, None otherwise |
|---|
isMDLGraphInstance()
| Returns: | True if the MDLNode is a MDL graph instance, False otherwise. |
|---|
isMDLInstance()
| Returns: | True if the MDLNode is a native function or native material node implementation, False otherwise. |
|---|
isSBSInstance()
| Returns: | True if the MDLNode is a Substance graph instance, False otherwise. |
|---|
parse(aContext, aDirAbsPath, aSBSParser, aXmlNode)
Parse recursively the given xml node to retrieve the content of the SBSObject.
removeConnectionOnPin(aInput)
Remove the connection on the given input pin.
| Parameters: | aPinIdentifier (InputEnum or FunctionInputEnum or str) – identifier of the input pin (for SBSCompNode and SBSParamNode) or of the output pin(for SBSParamsGraphNode) to disconnect |
|---|---|
| Returns: | True if a connection is removed, False otherwise |
removeConnectionsFrom(aLeftNode)
Remove all the connections from aLeftNode to this node (in the direction aLeftNode -> self)
| Parameters: | aLeftNode (SBSNode or str (UID)) – The node to look for in the connections of this node. |
|---|---|
| Returns: | Nothing |
resetParameter(aParameter=None)
Reset the given parameter to its default value. The parameter can be: - None in case of a Constant or Selector node, where there is only one parameter. - Simply the name of the parameter to get - A set of names separated by ‘/’ to access a sub member of the root member, for instance ‘surface/intensity’ - A name with an operator [] to access a particular item of a parameter array, for instance ‘color[2]’
| Parameters: | aParameter (str, optional) – identifier of the parameter to set |
|---|---|
| Returns: | True if succeed, False otherwise |
| Raise: | SBSImpossibleActionError if the node has no implementation |
setParameterValue(aParameter, aParamValue)
Set the parameter to the appropriate MDL node implementation The parameter can be: - Simply the name of the parameter to set - A set of names separated by ‘/’ to access a sub member of the root member, for instance ‘surface/intensity’ - A name with an operator [] to access a particular item of a parameter array, for instance ‘color[2]’
| Parameters: |
|
|---|---|
| Returns: | True if success, False otherwise |
| Raise: |
|
setPinVisibilityForParameter(aParameter, aVisible)
Set the visibility of the input pin associated to the given parameter. Only available for MDL instances and MDL Graph instances
| Parameters: |
|
|---|---|
| Raise: |
|
setPosition(aPosition)
Set the position of this node in the graph GUI.
| Parameters: | aPosition (a list of 3 float) – The position to set |
|---|
useResource(aResourcePath)
| Returns: | True if the node uses the given resource (bsdf measurement, ies profile or texture), False otherwise. |
|---|
write(aSBSWriter, aXmlNode)
Write recursively the content of the SBSObject into the given xml node.
| Parameters: |
|
|---|
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online
Adobe MAX
The Creativity Conference
Oct 14–16 Miami Beach and online