Base class for all offline renderers.
Inherits :
Inherited By : DzDelightRenderer, DzIrayRenderer and DzScriptedRenderer
void | aboutToRender ( DzRenderer renderer ) |
void | imagePrepared ( DzTexture img, String filename ) |
void | IPRRenderHandlerChanged ( DzRenderer renderer, iprrenderhandler_dz handler ) |
void | rendererModeChanged ( DzRenderer renderer ) |
void | renderFinished ( DzRenderer renderer ) |
void | shapeRenderBeginning ( shape_dz shape ) |
void | shapeRenderFinished ( shape_dz shape ) |
Implements a standard RenderMan interface for the scene to render itself through an offline renderer.
String : compileShader( String shaderPath )
Compiles the shader at the given path, if necessary, and returns the path to the compiled shader.
Parameter(s):
Return Value:
Boolean : customRender( DzRenderHandler handler, DzCamera camera, Array lights, Array nodes, DzRenderOptions opt )
Render a custom set of items.
Parameter(s):
Return Value:
true
if rendering was successful. false
if rendering was canceled by user or there were errors during the render.DzNode : getCurrentNode()
Return Value:
iprrenderhandler_dz : getIPRRenderHandler()
Return Value:
Return Value:
DzRendererMode : getRendererMode()
Return Value:
String : getShaderCompilerPath()
Return Value:
Return Value:
String : getShaderFileName( String shaderName )
Given a shader name (e.g. “metal”), this method returns the file name for it by appending the shader extension for the renderer (e.g. “metal.sdl”).
DzShaderDescription : getShaderInfo( String shaderPath )
Gets the parameter information for the given shader. The passed shader name should be the path to the compiled shader.
String : getShaderPath( String shaderName, Boolean withExtension=true )
Given a shader name (e.g. “metal”), looks in all the shader directories attempting to find the file for it. If withExtension
is true
, the shader path including the extension for the renderer is returned. Otherwise, it returns the full shader path without the extension appended. If it fails to find the shader, it returns an empty string.
Array : getShaderSearchPaths()
Return Value:
See Also:
String : getTextureUtilityPath()
Return Value:
Boolean : isRendering()
Return Value:
true
if the application is currently rendering, otherwise false
.void : killRender()
Stops the render.
void : prepareImage( DzTexture img, String filename )
Called by the framework to prepare/convert an image into a format that this renderer can understand/use when rendering. In derived classes, the function should result in a new image file being generated along with a path that the renderer can use to refer to the file. If the image could not be converted or is not usable by this renderer, the returned string should be empty.
Parameter(s):
See Also:
String : processShaderName( String shaderName )
Processes the given shader name into a form the renderer can use (i.e. appending file extensions, finding absolute paths, etc.).
Boolean : render( DzRenderHandler handler, DzCamera camera, DzRenderOptions opt )
Render the current scene.
Parameter(s):
Return Value:
true
if rendering was successful. false
if rendering was canceled by user or there were errors during the render.void : saveBakeImage( DzBakerOptions opt, Boolean wait )
Converts a .bake file into an image file.
Parameter(s):
true
, this method is exited only when the conversion has ended. If false
the method returns immediately after starting conversion; the baker's saveFileFinished() slot will be invoked after the conversion finishes.void : setIPRRenderHandler( iprrenderhandler_dz handler )
Sets the handler used for Interactive Progressive Rendering (IPR) on this renderer.
Parameter(s):
void : stopBaking()
Stops an active baking operation, if possible.
Boolean : textureConvert( DzRenderHandler handler, DzCamera camera, DzTextureConvertorOptions opt )
Performs texture conversion.
Parameter(s):
Return Value:
true
if the conversion succeeds, false
if the conversion is cancelled or in case of error.void : aboutToRender( DzRenderer renderer )
Signature:“aboutToRender(DzRenderer*)”
Emitted when just before the renderer begins rendering
Parameter(s):
void : imagePrepared( DzTexture img, String filename )
Signature:“imagePrepared(const DzTexture*,const QString&)”
Emitted when the image preparation for img is finished. Derived classes need to make sure to emit this signal at the appropriate times.
Parameter(s):
void : IPRRenderHandlerChanged( DzRenderer renderer, iprrenderhandler_dz handler )
TODO: Add description.
void : rendererModeChanged( DzRenderer renderer )
TODO: Add description.
void : renderFinished( DzRenderer renderer )
Signature:“renderFinished(DzRenderer*)”
Emitted when just after the renderer finishes rendering
Parameter(s):
void : shapeRenderBeginning( shape_dz shape )
TODO: Add description.
void : shapeRenderFinished( shape_dz shape )
TODO: Add description.