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...

#include <ScriptInterface.h>

Inheritance diagram for OutputPort:

Collaboration diagram for OutputPort:

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

void OutputPort::connect ( InputPort  inputPort )

slot

Connect an InputPort as output for this OutputPort.

Parameters

inputPort

Input port

void OutputPort::setCel ( Cel  cel )

slot

Set cel for output port.

Parameters

cel	Outgoing cel for this port

void OutputPort::setEmptyCel ( )

slot

Set an empty cel as output.

void OutputPort::setImageFile ( const File  imageFile )

slot

Set image file for output port.

Parameters

imageFile

Outgoing cel image for this port

void OutputPort::setMatrix ( const Matrix4x4  matrix )

slot

Set matrix for output port.

Parameters

matrix

Outgoing matrix for this port

---

The documentation for this class was generated from the following file:

• dox_files/ScriptInterface.h