PyMaterialXCore.InterfaceElement

class InterfaceElement

Bases: TypedElement

The base class for interface elements.

An InterfaceElement supports a set of Input and Output elements, with an API for setting their values.

Inherited by: GraphElement, Implementation, Node, NodeDef, and Variant.

See:

https://materialx.org/docs/api/class_interface_element.html

Methods

__init__(*args, **kwargs)
addInput(self[, name, type])
addOutput(self[, name, type])
addToken(self[, name])
clearContent(self)
getActiveInput(self, arg0)
getActiveInputs(self)
getActiveOutput(self, arg0)
getActiveOutputs(self)
getActiveToken(self, arg0)
getActiveTokens(self)
getActiveValueElement(self, arg0)
getActiveValueElements(self)
getConnectedOutput(self, arg0)
getDeclaration(self[, target])
getDefaultVersion(self)
getInput(self, arg0)
getInputCount(self)
getInputs(self)
getNodeDefString(self)
getOutput(self, arg0)
getOutputCount(self)
getOutputs(self)
getTarget(self)
getToken(self, arg0)
getTokenValue(self, arg0)
getTokens(self)
getVersionIntegers(self)
getVersionString(self)
hasExactInputMatch(self, declaration[, message])
hasNodeDefString(self)
hasTarget(self)
hasVersionString(self)
removeInput(self, arg0)
removeOutput(self, arg0)
removeToken(self, arg0)
setConnectedOutput(self, arg0, arg1)
setDefaultVersion(self, arg0)
setNodeDefString(self, arg0)
setTarget(self, arg0)
setTokenValue(self, arg0, arg1)
setVersionIntegers(self, arg0, arg1)
setVersionString(self, arg0)

Attribute Names

NODE_DEF_ATTRIBUTE = 'nodedef'

Methods

__init__(*args, **kwargs)

addInput(self: InterfaceElement, name: str = '', type: str = 'color3') → PyMaterialXCore.Input

addOutput(self: InterfaceElement, name: str = '', type: str = 'color3') → Output

addToken(self: InterfaceElement, name: str = 'color3') → Token

clearContent(self: InterfaceElement) → None

getActiveInput(self: InterfaceElement, arg0: str) → PyMaterialXCore.Input

getActiveInputs(self: InterfaceElement) → list[Input]

getActiveOutput(self: InterfaceElement, arg0: str) → Output

getActiveOutputs(self: InterfaceElement) → list[Output]

getActiveToken(self: InterfaceElement, arg0: str) → Token

getActiveTokens(self: InterfaceElement) → list[Token]

getActiveValueElement(self: InterfaceElement, arg0: str) → ValueElement

getActiveValueElements(self: InterfaceElement) → list[ValueElement]

getConnectedOutput(self: InterfaceElement, arg0: str) → Output

getDeclaration(self: InterfaceElement, target: str = '') → InterfaceElement

getDefaultVersion(self: InterfaceElement) → bool

getInput(self: InterfaceElement, arg0: str) → PyMaterialXCore.Input

getInputCount(self: InterfaceElement) → int

getInputs(self: InterfaceElement) → list[Input]

getNodeDefString(self: InterfaceElement) → str

getOutput(self: InterfaceElement, arg0: str) → Output

getOutputCount(self: InterfaceElement) → int

getOutputs(self: InterfaceElement) → list[Output]

getTarget(self: InterfaceElement) → str

getToken(self: InterfaceElement, arg0: str) → Token

getTokenValue(self: InterfaceElement, arg0: str) → str

getTokens(self: InterfaceElement) → list[Token]

getVersionIntegers(self: InterfaceElement) → tuple[int, int]

getVersionString(self: InterfaceElement) → str

hasExactInputMatch(self: InterfaceElement, declaration: InterfaceElement, message: str = None) → bool

hasNodeDefString(self: InterfaceElement) → bool

hasTarget(self: InterfaceElement) → bool

hasVersionString(self: InterfaceElement) → bool

removeInput(self: InterfaceElement, arg0: str) → None

removeOutput(self: InterfaceElement, arg0: str) → None

removeToken(self: InterfaceElement, arg0: str) → None

setConnectedOutput(self: InterfaceElement, arg0: str, arg1: Output) → None

setDefaultVersion(self: InterfaceElement, arg0: bool) → None

setNodeDefString(self: InterfaceElement, arg0: str) → None

setTarget(self: InterfaceElement, arg0: str) → None

setTokenValue(self: InterfaceElement, arg0: str, arg1: str) → Token

setVersionIntegers(self: InterfaceElement, arg0: int, arg1: int) → None

setVersionString(self: InterfaceElement, arg0: str) → None