render Class Reference

The render JavaScript global object. Render the scene or a part of the scene. More...

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. More...
void	setFieldType (int type)
	Sets the frame output format. More...
void	setBgColor (ColorRGBA *bgColor)
	Set the background color to use when rendering in scene machine mode. More...
void	setResolution (int x, int y)
	Set the scene resolution to use for rendering. More...
void	setResolutionName (String &name)
	Set the scene resolution to use for rendering. More...
void	setRenderDisplay (String &name)
	Set which display module to use for rendering. "Display All" uses the global unconnected display module. More...
void	setWriteEnabled (bool enabled)
	Enable or disable write modules during the render. More...
void	setAutoThumbnailCropping (bool enabled)
	Enable or disable thumbnail cropping for the render. Mainly used when rendering thumbnails. More...
void	setWhiteBackground (bool enabled)
	Enable rendering on a white background. The default is false, which renders on a black background. More...
void	renderScene (int fromFrame, int toFrame)
	Render a part of the scene. More...
void	renderSceneAll ()
	Render the complete scene. More...
void	cancelRender ()
	Interrupt an active render. More...
void	disconnect ()
	disconnect all scripts from signals emitted by this object. More...

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

Detailed Description

The render JavaScript global object. Render the scene or a part of the scene.

The scripting environment can receive notifications when the scene frame is ready.

function frameReady(frame, celImage)
{
  MessageLog.trace("Frame " + frame + " Ready.");
  // Save the image here.
  celImage.imageFile("c:/tmp/myimage" + frame + ".png");
}

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

render.renderFinished.connect(renderFinished);
render.frameReady.connect(frameReady);


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

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

Member Function Documentation

cancelRender

void render::cancelRender ( )

slot

Interrupt an active render.

disconnect

void render::disconnect ( )

slot

disconnect all scripts from signals emitted by this object.

frameReady

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

renderFinished

void render::renderFinished ( )

signal

Event that notifies the script when the render has completed.

renderScene

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

slot

Render a part of the scene.

After a frame is rendered, a frameReady signal will be emitted. Connect to it to save the rendered frame.

Parameters

fromFrame	render start frame
toFrame	render end frame

renderSceneAll

void render::renderSceneAll ( )

slot

Render the complete scene.

setAutoThumbnailCropping

void render::setAutoThumbnailCropping ( bool  enabled )

slot

Enable or disable thumbnail cropping for the render. Mainly used when rendering thumbnails.

Parameters

enabled

enable or disable cropping during render.

setBgColor

void render::setBgColor ( ColorRGBA *  bgColor )

slot

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

Parameters

bgColor

background color

setCombine

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

setFieldType

void render::setFieldType ( int  type )

slot

Sets the frame output format.

Parameters

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

setRenderDisplay

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

setResolution

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

slot

Set the scene resolution to use for rendering.

Parameters

x	width pixels
y	height pixels

setResolutionName

void render::setResolutionName ( String &  name )

slot

Set the scene resolution to use for rendering.

Parameters

name	a resolution name.

setWhiteBackground

void render::setWhiteBackground ( bool  enabled )

slot

Enable rendering on a white background. The default is false, which renders on a black background.

Parameters

enabled

: When true enables rendering on a white background.

setWriteEnabled

void render::setWriteEnabled ( bool  enabled )

slot

Enable or disable write modules during the render.

Parameters

enabled

enable or disable write modules