From Silhouette Wiki
Revision as of 17:40, 25 July 2018 by Paul (talk | contribs)
Jump to navigation Jump to search

The Node object generates output (usually an image) based on a set of inputs (image data and properties).

Base Class: Object


Nodes are created with the Node(type) constructor, where type is the "node type id". A list of available nodes can be queried with the global fx.nodes avariable.


Attributes are read-only except where noted.

Name Description Added
active True if the active node
enabled True if enabled (read/write)
imageToWorldTransform the Matrix used to transform from image coordinates to world coordinates
inputs List of input Ports
outputs List of output Ports
session the Session the node is in (same as parent)
worldToImageTransform the Matrix used to transform from world coordinates to image coordinates
outputMask the output streams it can produce. 6.0
state a dictionary of any extra node-specific state 6.0


Name Description Added
render(frame, stream=Stream_Left) render at the desired frame and returns a Raster with the result


  • the Node.outputMask attribute has been added to query a node for the output streams it can produce.
  • the Node.state attribute allows read-only access to the node's state dictionary
  • the Node.metadata(frame) function returns a metadata dictionary derived from up-stream Sources
  • Node.connectedInputs returns a list of connected input Ports.
  • Node.connectedOutputs returns a list of connected output Ports.
  • Node.pipes returns a list of connected Pipes.
  • Node.ports returns a list of all input/output Ports.
  • Node.matte returns the Obey Matte input Port, or None if the node does not have one
  • Node.render() has a new signature. See Rendering for more information.
  • Node.disconnect(port) disconnects the specified Port.
  • Node.getInput(index=0) returns the specified input Port
  • Node.getOutput(index=0) returns the specified output Port
  • Node.port(name) returns the Port with the specified name/id.