Harmony
Script Node Documentation
InputPort Class Reference

The InputPort class specifies the information of an input port of the current scripting module. Input ports can be accessed through the Context object. More...

Public Slots

Matrices
Matrix4x4 matrix ()
 Get input matrix at current frame. More...
 
Matrix4x4 matrixAt (const double frame)
 Get input matrix at specific frame. More...
 
Matrix4x4 modelViewMatrix ()
 
Cel getCel ()
 
SM_Cel3dWrapper * getCel3d ()
 
Matrix4x4 perspectiveMatrix ()
 
Files
QObject imageFile ()
 Get a permanent copy of cel image file. This function without parameters is valid only for ports that point to a physically valid file on disk. More...
 
QObject imageFile (const String &name)
 Get a permanent copy of cel image file of specific format. More...
 
File imageFileAs (const String &name, const String &formatstring, const String &optionstring)
 Get a permanent copy of cel image file of specific format. More...
 
File workingCopy ()
 Get a temporary copy of cel image file. More...
 
File workingCopyAs (const String &ext, const String &formatstring=String(), const String &optionstring=String())
 Get a temporary copy of cel image file of specific format. More...
 
- Public Slots inherited from Port
virtual int portType () const
 Get port type. More...
 

Detailed Description

The InputPort class specifies the information of an input port of the current scripting module. Input ports can be accessed through the Context object.

Member Function Documentation

◆ getCel

Cel InputPort::getCel ( )
slot
Returns
Cel

◆ getCel3d

SM_Cel3dWrapper* InputPort::getCel3d ( )
slot

◆ imageFile [1/2]

QObject InputPort::imageFile ( )
slot

Get a permanent copy of cel image file. This function without parameters is valid only for ports that point to a physically valid file on disk.

Returns
File

◆ imageFile [2/2]

QObject InputPort::imageFile ( const String &  name)
slot

Get a permanent copy of cel image file of specific format.

Parameters
nameName of file to create
Returns
File

◆ imageFileAs

File InputPort::imageFileAs ( const String &  name,
const String &  formatstring,
const String &  optionstring 
)
slot

Get a permanent copy of cel image file of specific format.

Parameters
nameName of file to create
formatstringFormat to convert image into
optionstringImage extension specific option (ie. TGA, TGA3, TGA4, SGIDP)
Returns
File

◆ matrix

Matrix4x4 InputPort::matrix ( )
slot

Get input matrix at current frame.

Returns
Matrix4x4

◆ matrixAt

Matrix4x4 InputPort::matrixAt ( const double  frame)
slot

Get input matrix at specific frame.

Parameters
frameFrame number
Returns
Matrix4x4

◆ modelViewMatrix

Matrix4x4 InputPort::modelViewMatrix ( )
slot
Returns
Matrix4x4

◆ perspectiveMatrix

Matrix4x4 InputPort::perspectiveMatrix ( )
slot
Returns
Matrix4x4

◆ workingCopy

File InputPort::workingCopy ( )
slot

Get a temporary copy of cel image file.

Returns
File

◆ workingCopyAs

File InputPort::workingCopyAs ( const String &  ext,
const String &  formatstring = String(),
const String &  optionstring = String() 
)
slot

Get a temporary copy of cel image file of specific format.

Parameters
extExtension of image file to create
formatstringFormat to convert image into
optionstringImage extension specific option
Returns
File