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...
void	setOverlayText (String textValue, QScriptValue textProperties=QScriptValue())
	Sets the text to be overlaid onto the ouptut image and its properties. 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, const QScriptValue &importOptions=QScriptValue())
	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

inputPort

Input port

setCel

void OutputPort::setCel ( Cel  cel )

slot

Set cel for output port.

Parameters

cel	Outgoing cel for this port

setEmptyCel

void OutputPort::setEmptyCel ( )

slot

Set an empty cel as output.

setImageFile

void OutputPort::setImageFile ( const File  imageFile, const QScriptValue &  importOptions = QScriptValue()  )

slot

Set image file for output port.

Parameters

imageFile	Outgoing cel image for this port
importOptions	(Optional) Object containing the image file import options E.g. {"colorSpace":"sRGB","layerPath":"Background"}

setMatrix

void OutputPort::setMatrix ( const Matrix4x4  matrix )

slot

Set matrix for output port.

Parameters

matrix

Outgoing matrix for this port

setOverlayText

void OutputPort::setOverlayText ( String  textValue, QScriptValue  textProperties = QScriptValue()  )

slot

Sets the text to be overlaid onto the ouptut image and its properties.

Parameters

textValue	The text string to be overlaid.
textProperties	optional object of type: { "font" : "Arial", "fontSize" : 32, "offsetX" : 0, "offsetY" : 0, "foregroundColor" : [255, 255, 255, 255], "backgroundColor" : [0, 0, 0, 255] }