BatchRender Class Reference

#include <lib_batchrender.h>

Detailed Description

A class to access the Render Queue.

Public Member Functions
Bool	Open (void)
Bool	AddFile (const Filename &File, Int32 number)
Bool	DelFile (const Filename &File)
Bool	IsRendering ()
void	SetRendering (Int32 set)
Bool	SetNetError (Int32 n, const String &machineName, const String &errorString, Bool isWarning)
Bool	SetNetError (const C4DUuid &uuid, const String &machineName, const String &errorString, Bool isWarning)
Int32	GetElementCount ()
Filename	GetElement (Int32 n)
void	EnableElement (Int32 n, Bool bSet)
Bool	GetEnableElement (Int32 n)
Int32	GetElementStatus (Int32 n)
void	GetJsonJobs (PyList *list)
BaseBitmap *	GetFrameBitmap (const C4DUuid &nodeUuid, const C4DUuid &frameUuid)
void	SetUseNet (Int32 n, Bool on)

Private Member Functions
	BatchRender ()
	~BatchRender ()

Constructor & Destructor Documentation

BatchRender()

BatchRender ( )

private

~BatchRender()

~BatchRender ( )

private

Member Function Documentation

Open()

Bool Open

(

void

)

Opens the Render Queue window.

Returns

true if successful, otherwise false.

AddFile()

Bool AddFile	(	const Filename &	File,
		Int32	number
	)

Adds a Cinema 4D file to the Render Queue.

Parameters

[in]	File	The filename of the Cinema 4D file.
[in]	number	The position within the Render Queue. If this is greater than the current number of entries it will be added at the end of the list.

Returns

true if successful, otherwise false.

DelFile()

Bool DelFile

(

const Filename &

File

)

Removes a Cinema 4D file from the Render Queue.

Parameters

[in]

File

The Cinema 4D file to be removed from the list.

Returns

true if successful, otherwise false.

IsRendering()

Bool IsRendering

(

)

Checks if the render Queue is rendering.

Returns

true if the render Queue is rendering, otherwise false.

SetRendering()

void SetRendering

(

Int32

set

)

Sets the render status of the Render Queue.

Parameters

[in]

set

The render status: BR_RENDER

SetNetError() [1/2]

Bool SetNetError	(	Int32	n,
		const String &	machineName,
		const String &	errorString,
		Bool	isWarning
	)

Private.

SetNetError() [2/2]

Bool SetNetError	(	const C4DUuid &	uuid,
		const String &	machineName,
		const String &	errorString,
		Bool	isWarning
	)

Private.

GetElementCount()

Int32 GetElementCount

(

)

Retrieves the number of Cinema 4D scene files in the Render Queue.

Returns

The number of Cinema 4D scene files.

GetElement()

Filename GetElement

(

Int32

n

)

Retrieves the filename of the Cinema 4D scene file with the index n.

Parameters

[in]

n

The position within the Render Queue: 0 < n < GetElementCount()

Returns

The filename of the Cinema 4D scene file.

EnableElement()

void EnableElement	(	Int32	n,
		Bool	bSet
	)

Enables or disables the Cinema 4D scene file at the index n for rendering.

Parameters

[in]	n	The position within the Render Queue: 0 < n < GetElementCount()
[in]	bSet	true to enable the scene file for rendering, false to disable it.

GetEnableElement()

Bool GetEnableElement

(

Int32

n

)

Checks if a Cinema 4D scene file from the Render Queue is enabled for rendering.

Parameters

[in]

n

The position within the Render Queue: 0 < n < GetElementCount()

Returns

true if the scene file is enabled for rendering, otherwise false.

GetElementStatus()

Int32 GetElementStatus

(

Int32

n

)

Retrieves the current status of the Cinema 4D scene file at the index n.

Parameters

[in]

n

The position within the Render Queue: 0 < n < GetElementCount()

Returns

The status: RM_RENDER

GetJsonJobs()

void GetJsonJobs

(

PyList *

list

)

Private.

GetFrameBitmap()

BaseBitmap* GetFrameBitmap	(	const C4DUuid &	nodeUuid,
		const C4DUuid &	frameUuid
	)

Private.

SetUseNet()

void SetUseNet	(	Int32	n,
		Bool	on
	)

Private.