Harmony
Script Node Documentation
OutputPort Class Reference

The OutputPort class can be used to specify the outgoing information through an output port of the current scripting module. Output ports can be accessed through the Context object. More...

Public Slots

void connect (InputPort inputPort)
 Connect an InputPort as output for this OutputPort. More...
 
void setEmptyCel ()
 Set an empty cel as output. More...
 
Matrices
void setMatrix (const Matrix4x4 matrix)
 Set matrix for output port. More...
 
void setCel (Cel cel)
 Set cel for output port. More...
 
Files
void setImageFile (const File imageFile)
 Set image file for output port. More...
 
- Public Slots inherited from Port
virtual int portType () const
 Get port type. More...
 

Detailed Description

The OutputPort class can be used to specify the outgoing information through an output port of the current scripting module. Output ports can be accessed through the Context object.

// Load input image cel on disk
image = input.workingCopy();
// Save image into output port
output.setImageFile( image );

Member Function Documentation

◆ connect

void OutputPort::connect ( InputPort  inputPort)
slot

Connect an InputPort as output for this OutputPort.

Parameters
inputPortInput port

◆ setCel

void OutputPort::setCel ( Cel  cel)
slot

Set cel for output port.

Parameters
celOutgoing cel for this port

◆ setEmptyCel

void OutputPort::setEmptyCel ( )
slot

Set an empty cel as output.

◆ setImageFile

void OutputPort::setImageFile ( const File  imageFile)
slot

Set image file for output port.

Parameters
imageFileOutgoing cel image for this port

◆ setMatrix

void OutputPort::setMatrix ( const Matrix4x4  matrix)
slot

Set matrix for output port.

Parameters
matrixOutgoing matrix for this port