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

#include <ScriptInterface.h>

Inheritance diagram for InputPort:

Collaboration diagram for InputPort:

Public Slots
Matrices
Matrix4x4	matrix ()
	Get input matrix at current frame.
Matrix4x4	matrixAt (const double frame)
	Get input matrix at specific frame.
Matrix4x4	modelViewMatrix ()
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.
QObject	imageFile (const String &name)
	Get a permanent copy of cel image file of specific format.
PermanentFile	imageFileAs (const String &name, const String &formatstring, const String &optionstring)
	Get a permanent copy of cel image file of specific format.
TemporaryFile	workingCopy ()
	Get a temporary copy of cel image file.
TemporaryFile	workingCopyAs (const String &ext, const String &formatstring=String(), const String &optionstring=String())
	Get a temporary copy of cel image file of specific format.
Public Slots inherited from Port
virtual int	portType () const
	Get port type.

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

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

PermanentFile

QObject InputPort::imageFile ( const String &  name )

slot

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

Parameters

name	Name of file to create

Returns

PermanentFile

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

slot

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

Parameters

name	Name of file to create
formatstring	Format to convert image into
optionstring	Image extension specific option

Returns

PermanentFile

Matrix4x4 InputPort::matrix ( )

slot

Get input matrix at current frame.

Returns

Matrix4x4

Matrix4x4 InputPort::matrixAt ( const double  frame )

slot

Get input matrix at specific frame.

Parameters

frame

Frame number

Returns

Matrix4x4

Matrix4x4 InputPort::modelViewMatrix ( )

slot

Returns

Matrix4x4

Matrix4x4 InputPort::perspectiveMatrix ( )

slot

Returns

Matrix4x4

TemporaryFile InputPort::workingCopy ( )

slot

Get a temporary copy of cel image file.

Returns

TemporaryFile

TemporaryFile 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

ext	Extension of image file to create
formatstring	Format to convert image into
optionstring	Image extension specific option

Returns

TemporaryFile

---

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

• dox_files/ScriptInterface.h