render Class Reference

The Render class is used to render the scene or a part of the scene. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example. More...

#include <renderinterface.h>

Inheritance diagram for render:

Collaboration diagram for render:

Public Slots
void	setCombine (bool autoCombine, bool secondFieldFirst)
	Set if rendered frames sets should be combined and in which order. Specify these options if you are rendering in PAL or NTSC format.
void	setFieldType (int type)
	Sets the frame output format.
void	setBgColor (ColorRGBA *bgColor)
	Set the background color to use when rendering in scene machine mode.
void	setResolution (int x, int y)
	Set the scene resolution to use for rendering.
void	setResolutionName (String &name)
	Set the scene resolution to use for rendering.
void	setRenderDisplay (String name)
	Set which display module to use for rendering. "Display All" uses the global unconnected display module.
void	setWriteEnabled (bool enabled)
	Enable or disable write modules during the render.
void	renderScene (int fromFrame, int toFrame)
	Render a part of the scene.
void	renderSceneAll ()
	Render the complete scene.
void	cancelRender ()
	Interrupt an active render.
void	disconnect ()
	disconnect all scripts from signals emited by this object.

Signals
void	frameReady (int frame, QObject *frameCel)
	Event that notifies the script that a certain frame is available and at which location.
void	renderFinished ()
	Event that notifies the script when the render has completed.

Public Member Functions
	render (QObject *parent, char *name)
virtual void	attach (TUScriptInterfaceImpl *impl)

Friends
class	SCR_RenderController

Detailed Description

The Render class is used to render the scene or a part of the scene. The scripting environment can receive notifications when scene frame is ready. See the TB_ExportFLV script for an example.

You can use it in Script Editor only.

function frameReady(frame, frameFile)
{
  MessageBox.information("Frame " + frame + " Ready: " + frameFile.path());
}

function renderFinished()
{
  MessageBox.information("Render Finished");
}
render.renderFinished.connect(renderFinished);
render.frameReady.connect(frameReady);


render.setRenderDisplay("Display");
render.renderSceneAll();

render.frameFinished.disconnect(renderFinished);
render.frameReady.disconnect(frameReady);

Constructor & Destructor Documentation

render::render	(	QObject *	parent,
		char *	name
	)

Member Function Documentation

virtual void render::attach ( TUScriptInterfaceImpl *  impl )

virtual

void render::cancelRender ( )

slot

Interrupt an active render.

void render::disconnect ( )

slot

disconnect all scripts from signals emited by this object.

void render::frameReady ( int  frame, QObject *  frameCel  )

signal

Event that notifies the script that a certain frame is available and at which location.

Parameters

frame	rendered frame number
frameCel	rendered frame cel

void render::renderFinished ( )

signal

Event that notifies the script when the render has completed.

void render::renderScene ( int  fromFrame, int  toFrame  )

slot

Render a part of the scene.

Parameters

fromFrame	render start frame
toFrame	render end frame

void render::renderSceneAll ( )

slot

Render the complete scene.

void render::setBgColor ( ColorRGBA *  bgColor )

slot

Set the background color to use when rendering in scene machine mode.

Parameters

bgColor

background color

void render::setCombine ( bool  autoCombine, bool  secondFieldFirst  )

slot

Set if rendered frames sets should be combined and in which order. Specify these options if you are rendering in PAL or NTSC format.

Parameters

autoCombine	automatically combine the two rendered frame field sets
secondFieldFirst	insert the second frame field set at the beginning

void render::setFieldType ( int  type )

slot

Sets the frame output format.

Parameters

type	frame output format: 0 - None, 1 - NTSC, 2 - PAL

void render::setRenderDisplay ( String  name )

slot

Set which display module to use for rendering. "Display All" uses the global unconnected display module.

Parameters

name	display name

void render::setResolution ( int  x, int  y  )

slot

Set the scene resolution to use for rendering.

Parameters

x	width pixels
y	height pixels

void render::setResolutionName ( String &  name )

slot

Set the scene resolution to use for rendering.

Parameters

name	a resolution name.

void render::setWriteEnabled ( bool  enabled )

slot

Enable or disable write modules during the render.

Parameters

enable

enable or disable write modules

Friends And Related Function Documentation

friend class SCR_RenderController

friend

---

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

• dox_files/variableScript/renderinterface.h