DzRenderMgr Class Reference
[Manager Objects]

The manager for Rendering. More...

Inheritance diagram for DzRenderMgr:

List of all members.

Enumerations
enum	RenderPriority {   RENDER_PRIORITY_LOWEST = 0, RENDER_PRIORITY_LOW, RENDER_PRIORITY_BELOW_NORMAL, RENDER_PRIORITY_NORMAL,   RENDER_PRIORITY_ABOVE_NORMAL, RENDER_PRIORITY_HIGH, RENDER_PRIORITY_HIGHEST }
Methods
void	doRender (DzRenderOptions opt=undefined)
DzRenderer	findRenderer (String className)
DzRenderer	getActiveRenderer ()
String	getLastSavedRenderPath ()
Number	getNumRenderers ()
DzRenderer	getRenderer (Number which)
Array	getRendererList ()
DzRenderOptions	getRenderOptions ()
Boolean	hasRender ()
String	saveLastRender ()
void	setActiveRenderer (DzRenderer r)
void	showRenderDialog ()
Signals
void	activeRendererChanged (DzRenderer renderer)
	Signature: "activeRendererChanged(DzRenderer*)"
void	hasRenderChanged (Boolean state)
	Signature: "hasRenderChanged(bool)"
void	rendererAdded (DzRenderer renderer)
	Signature: "rendererAdded(DzRenderer*)"
void	renderFinished (Boolean succeeded)
	Signature: "renderFinished(bool)"
void	renderStarting ()
	Signature: "renderStarting()"

---

Detailed Description

The manager for Rendering.

See also:

DzApp::getRenderMgr()

---

Member Enumeration Documentation

enum DzRenderMgr::RenderPriority

Possible render priorities that are used to order various operations when rendering. Most notably, DzNodes and DzMaterials are processed according to their priority when rendering.

Enumerator:

RENDER_PRIORITY_LOWEST	The lowest priority
RENDER_PRIORITY_LOW	A low priority
RENDER_PRIORITY_BELOW_NORMAL	A below normal priority
RENDER_PRIORITY_NORMAL	The normal priority
RENDER_PRIORITY_ABOVE_NORMAL	An above normal priority
RENDER_PRIORITY_HIGH	A high priority
RENDER_PRIORITY_HIGHEST	The highest priority

---

Member Function Documentation

DzRenderMgr::activeRendererChanged

(

DzRenderer

renderer

)

[signal]

Signature: "activeRendererChanged(DzRenderer*)"

Emitted when the active render engine has changed.

Parameters:

renderer

The new active render engine

void DzRenderMgr::doRender

(

DzRenderOptions

opt = undefined

)

Renders the scene with the given render settings. If no render settings are specified, then the current application render settings are used.

Parameters:

opt

The render settings to use for the render. If NULL, the current user render settings are used.

DzRenderer DzRenderMgr::findRenderer

(

String

which

)

Returns:

A pointer to the renderer with the given class name. NULL if a match could not be found.

DzRenderer DzRenderMgr::getActiveRenderer

(

)

Returns:

A pointer to the active renderer for the application. This will be NULL if no renderers are available.

String DzRenderMgr::getLastSavedRenderPath

(

)

Returns:

The path to the last successfully saved render, otherwise an empty string.

Number DzRenderMgr::getNumRenderers

(

)

Returns:

The number of renderers available in the application

DzRenderer DzRenderMgr::getRenderer

(

Number

which

)

Returns:

A pointer to the renderer at the given index in the list of renderers.

Array DzRenderMgr::getRendererList

(

)

Returns:

An array of renderers available in the application

DzRenderOptions DzRenderMgr::getRenderOptions

(

)

Returns:

A pointer to the default DzRenderOptions object. This object stores the user's currently selected rendering options.

Boolean DzRenderMgr::hasRender

(

)

Returns:

true if there is a render that can be saved

DzRenderMgr::hasRenderChanged

(

Boolean

state

)

[signal]

Signature: "hasRenderChanged(bool)"

Emitted when the value returned by DzRenderMgr::hasRender() has changed, signalling a new render operation. This signifies whether or not a call to saveLastRender() will be valid.

DzRenderMgr::rendererAdded

(

DzRenderer

renderer

)

[signal]

Signature: "rendererAdded(DzRenderer*)"

Emitted when a new render engine is added to the manager. This only occurs at startup as plugins are being loaded.

Parameters:

renderer

The new render engine that was added to the manager.

DzRenderMgr::renderFinished

(

Boolean

succeeded

)

[signal]

Signature: "renderFinished(bool)"

Emitted just after a rendering operation is finished. This is only emitted when a render operation is performed by calling DzRenderMgr::doRender() - this includes all rendering operations that are started by the user from the interface. This may not include rendering operations performed by plugins, scripts, etc which do not call doRender().

Parameters:

succeeded

true if the render was successful, false if the render failed or was cancelled by the user.

See also:

DzRenderMgr::renderStarting(), DzScene::renderFinished()

DzRenderMgr::renderStarting

(

)

[signal]

Signature: "renderStarting()"

Emitted just before a rendering operation begins. This is only emitted when a render operation is performed by calling DzRenderMgr::doRender() - this includes all rendering operations that are started by the user from the interface. This may not include rendering operations performed by plugins, scripts, etc which do not call doRender().

See also:

DzRenderMgr::renderFinished(), DzScene::aboutToRender()

String DzRenderMgr::saveLastRender

(

)

Displays a dialog for saving the last render, and saves the image(s)/movie if the user does not cancel.

Returns:

The path to the file selected and successfully saved, otherwise an empty string.

void DzRenderMgr::setActiveRenderer

(

DzRenderer

r

)

Sets the currently active renderer for the application

void DzRenderMgr::showRenderDialog

(

)

Displays the render options dialog to the user. This only works if DAZ Studio is being run with the interface on, if the interface is off, this function does nothing.

---

Copyright © 2002 - 2009 DAZ 3D, Inc.