DzScriptedRenderer Class Reference
[DAZ Studio Advanced Edition Objects, Rendering Objects, Custom RSL Objects]

Custom scriptable 3Delight renderer. More...

Inheritance diagram for DzScriptedRenderer:

DzRenderer List of all members.

Methods

void cameraProject (DzCamera camera, Number width, Number height)
Boolean continueAfterPreProcess ()
void createLight (DzLight light, String shadowMap)
void deleteFiles (Array files)
void doDefaultDisplay ()
String doDefaultShadowPass (DzRenderOptions options, DzCamera camera, DzLight light, String dir, Boolean reuse)
Array doDefaultShadowPass (DzRenderOptions options, DzCamera camera, String dir, Boolean reuse)
void doDefaultShadowPassEnd (DzRenderOptions options, DzCamera camera, DzLight light)
String doDefaultShadowPassPrep (DzRenderOptions options, DzCamera camera, DzLight light, String dir, Boolean reuse)
String getDisplacementPreProcessScript ()
DzRenderHandler getHandler ()
DzLight getLight (Number index)
Number getLightCount ()
String getLightPreProcessScript ()
Array getLightsToRender ()
DzNode getNode (Number index)
Number getNodeCount ()
Array getNodesToRender ()
Number getNumIlluminateHandels ()
DzElement getPropertyHolder ()
String getRenderScript ()
String getShaderCompilerPath ()
String getSurfacePreProcessScript ()
void removeLight (Number index)
void removeNode (Number index)
void renderBackDrop (DzBackdrop backdrop, Number width, Number height)
void renderNode (DzNode node)
Number riAreaLightSource (String name, Array tokens, Array params)
void riAtmosphere (String name, Array tokens, Array params)
void riAttribute (String name, Array tokens, Array params)
void riAttributeBegin ()
void riAttributeEnd ()
void riBegin (String ribPath)
void riClipping (Number hither, Number yon)
void riColor (Color Cs)
void riConcatTransform (DzMatrix4 transform)
void riCoordinateSystem (String space)
void riCoordSysTransform (String space)
void riCropWindow (Number xmin, Number xmax, Number ymin, Number ymax)
void riDeclare (String name, String declaration)
void riDepthOfField (Number fstop, Number focallength, Number focaldistance)
void riDetailRange (Number minvis, Number lowtran, Number uptran, Number maxvis)
void riDisplacement (String name, Array tokens, Array params)
void riDisplay (String name, String type, String mode, Array tokens, Array params)
void riEndWorld (String message)
void riExposure (Number gain, Number gamma)
void riExterior (String name, Array tokens, Array params)
void riFormat (Number xres, Number yres, Number aspect)
void riFrameAspectRatio (Number aspect)
void riGeometricApproximation (String type, Number value)
void riHider (String type, Array tokens, Array params)
void riIdentity ()
void riIlluminate (Number light, Boolean onoff)
void riImager (String name, Array tokens, Array params)
void riInterior (String name, Array tokens, Array params)
Number riLightSource (String name, Array tokens, Array params)
void riMakeBump (String pic, String tex, String swrap, String twrap, DzRenderOptions::PixelFilter filterType, Number swidth, Number twidth, Array tokens, Array params)
void riMakeCubeFaceEnvironment (String px, String nx, String py, String ny, String pz, String nz, String tex, Number fov, DzRenderOptions::PixelFilter filterType, Number swidth, Number twidth, Array tokens, Array params)
void riMakeLatLongEnvironment (String pic, String tex, DzRenderOptions::PixelFilter filterType, Number swidth, Number twidth, Array tokens, Array params)
void riMakeShadow (String pic, String tex, Array tokens, Array params)
void riMakeTexture (String pic, String tex, String swrap, String twrap, DzRenderOptions::PixelFilter filterType, Number swidth, Number twidth, Array tokens, Array params)
void riMatte (Boolean onoff)
void riOpacity (Color Os)
void riOption (String name, Array tokens, Array params)
void riOrientation (String orientation)
void riPerspective (Number fov)
void riPixelFilter (DzRenderOptions::PixelFilter filterType, Number xwidth, Number ywidth)
void riPixelSamples (Number xsamples, Number ysamples)
void riPixelVariance (Number variation)
void riProjection (String name, Array tokens, Array params)
void riQuantize (String type, Number one, Number qmin, Number qmax, Number ampl)
void riRelativeDetail (Number relativedetail)
void riReverseOrientation ()
void riRotate (Number angle, Number dx, Number dy, Number dz)
void riScale (Number dx, Number dy, Number dz)
void riScreenWindow (Number left, Number right, Number bot, Number top)
void riShadingInterpolation (String type)
void riShadingRate (Number size)
void riShutter (Number smin, Number smax)
void riSides (Number nsides)
void riSkew (Number angle, Number dx1, Number dy1, Number dz1, Number dx2, Number dy2, Number dz2)
void riSurface (String name, Array tokens, Array params)
void riTransform (DzMatrix4 transform)
void riTransformBegin ()
void riTransformEnd ()
void riTranslate (Number dx, Number dy, Number dz)
void riWorldBegin ()
void setBackgroundColor (Color color)
void setContinueAfterPreProcess (Boolean shouldContinue)
void setCropWindow (DzRenderHandler handler)
void setDisplacementPreProcessScript (String filename)
void setIsShadowPass (Boolean onOff)
void setLightPreProcessScript (String filename)
void setRenderScript (String filename)
void setSurfacePreProcessScript (String filename)

Constructors

 DzScriptedRenderer ()

Detailed Description

Custom scriptable 3Delight renderer.

Implements a scriptable RenderMan interface for the scene to render itself through the 3Delight renderer.

Samples:

Constructor & Destructor Documentation

DzScriptedRenderer::DzScriptedRenderer (  ) 

Default Constructor.

Attention:
This class is only available as a component of DAZ Studio Advanced Edition

Member Function Documentation

void DzScriptedRenderer::cameraProject ( DzCamera  camera,
Number  width,
Number  height 
)

Sets up the camera for the pass

Parameters:
camera camera to use
width width of render
height height of render

Boolean DzScriptedRenderer::continueAfterPreProcess (  ) 

Returns:
True if the renderer should use the call to RiSurface, RiDisplace, RiLight, or RiAreaLight

void DzScriptedRenderer::createLight ( DzLight  light,
String  shadowMap 
)

Creates a light in the stream.

Parameters:
light light to create
shadowMap shadow map for the light

void DzScriptedRenderer::deleteFiles ( Array  files  ) 

Method to delete a list of files

Parameters:
files An Array of String...

void DzScriptedRenderer::doDefaultDisplay (  ) 

Makes the renderer call the same display call as the standard 3delight renderer in studio

String DzScriptedRenderer::doDefaultShadowPass ( DzRenderOptions  options,
DzCamera  camera,
DzLight  light,
String  dir,
Boolean  reuse 
)

Parameters:
options RenderOptions for the shadow maps
camera Camera for the shadow pass
light Light to generate shadow map for
dir Directory to generate the shadwo map in
reuse If shadow map already exists it is reuse.
Returns:
Name of the generated shadow map.

Array DzScriptedRenderer::doDefaultShadowPass ( DzRenderOptions  options,
DzCamera  camera,
String  dir,
Boolean  reuse 
)

Parameters:
options The render options to render
camera The camera to generate the shadow map for
dir Directory to generate the shadow maps in
reuse If reuse is true and a shadow map exists by the the same label of a light exists, the shadow map is reused instead of being generated.
Returns:
The [String] Array...

void DzScriptedRenderer::doDefaultShadowPassEnd ( DzRenderOptions  options,
DzCamera  camera,
DzLight  light 
)

Cleans up doDefaultShadowPassPrep

Parameters:
options Render options
camera camera
light light the shadow map was generated for
Note:
this call must be proceeded by a call to doDefaultShadowPassPrep

String DzScriptedRenderer::doDefaultShadowPassPrep ( DzRenderOptions  options,
DzCamera  camera,
DzLight  light,
String  dir,
Boolean  reuse 
)

Parameters:
options Render options for the pass
camera Camera for the shadow pass
light Light to generate shadow map for
dir directory to put the shadow map in
reuse if the map should be reused or not
Returns:
name of the shadow map for the light.
Note:
this call must be followed by a call to doDefaultShadowPassEnd;

String DzScriptedRenderer::getDisplacementPreProcessScript (  ) 

Returns:
The path to the script that is run in the Displacement preprocess step.

DzRenderHandler DzScriptedRenderer::getHandler (  ) 

Returns:
the current render handler. This is only valid during a render

DzLight DzScriptedRenderer::getLight ( Number  index  ) 

Parameters:
index index for the light
Returns:
the light at the given index

Number DzScriptedRenderer::getLightCount (  ) 

Returns:
number of lights to render

String DzScriptedRenderer::getLightPreProcessScript (  ) 

Returns:
The path to the script that is run in the Light preprocess step.

Array DzScriptedRenderer::getLightsToRender (  ) 

Returns:
list of lights to render

DzNode DzScriptedRenderer::getNode ( Number  index  ) 

Parameters:
index index of node
Returns:
the node at the given index

Number DzScriptedRenderer::getNodeCount (  ) 

Returns:
number of nodes to render.

Array DzScriptedRenderer::getNodesToRender (  ) 

Returns:
list of nodes to be renderered

Number DzScriptedRenderer::getNumIlluminateHandels (  ) 

Returns:
a list of handles for the light. These handles are used in the RiIlluminate to turn lights on/off

DzElement DzScriptedRenderer::getPropertyHolder (  ) 

Returns:
The element that holds the properties for this scripted render pass. When applying a new pass to the render this you should clear the properties off this element and apply properties you may wish to use during the render pass.

String DzScriptedRenderer::getRenderScript (  ) 

Returns:
The render script

String DzScriptedRenderer::getShaderCompilerPath (  ) 

Returns:
String for the default search paths for DAZ Studio shaders.

Reimplemented from DzRenderer.

String DzScriptedRenderer::getSurfacePreProcessScript (  ) 

Returns:
The path to the script that is run in the Surface preprocess step.

void DzScriptedRenderer::removeLight ( Number  index  ) 

Parameters:
index remove a light at given index from the render list

void DzScriptedRenderer::removeNode ( Number  index  ) 

Parameters:
index remove a node at given index from the render list

void DzScriptedRenderer::renderBackDrop ( DzBackdrop  backdrop,
Number  width,
Number  height 
)

Parameters:
backdrop Backdrop for the scene
width width of the render
height height of the render Renders the backdrop for the scene

void DzScriptedRenderer::renderNode ( DzNode  node  ) 

Parameters:
node node to rendr

Number DzScriptedRenderer::riAreaLightSource ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiAreaLightSourceV) function

Parameters:
name The name of the light shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens
Returns:
The light handle index for this light source

void DzScriptedRenderer::riAtmosphere ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiAtmosphereV() function

Parameters:
name The name of the volume shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

void DzScriptedRenderer::riAttribute ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiAttributeV() function

void DzScriptedRenderer::riAttributeBegin (  ) 

DAZ Script implementation of the RiAttributeBegin() function

void DzScriptedRenderer::riAttributeEnd (  ) 

DAZ Script implementation of the RiAttributeEnd() function

void DzScriptedRenderer::riClipping ( Number  hither,
Number  yon 
)

DAZ Script implementation of the RiClipping() function

void DzScriptedRenderer::riColor ( Color  Cs  ) 

DAZ Script implementation of the RiColor() function

void DzScriptedRenderer::riConcatTransform ( DzMatrix4  transform  ) 

DAZ Script implementation of the RiConcatTransform() function

void DzScriptedRenderer::riCoordinateSystem ( String  space  ) 

DAZ Script implementation of the RiCoordinateSystem() function

void DzScriptedRenderer::riCoordSysTransform ( String  space  ) 

DAZ Script implementation of the RiCoordSysTransform() function

void DzScriptedRenderer::riCropWindow ( Number  xmin,
Number  xmax,
Number  ymin,
Number  ymax 
)

DAZ Script implementation of the RiCropWindow() function

void DzScriptedRenderer::riDeclare ( String  name,
String  declaration 
)

DAZ Script implementation of the RiDeclare() function

void DzScriptedRenderer::riDepthOfField ( Number  fstop,
Number  focallength,
Number  focaldistance 
)

DAZ Script implementation of the RiDepthOfField() function

void DzScriptedRenderer::riDetailRange ( Number  minvis,
Number  lowtran,
Number  uptran,
Number  maxvis 
)

DAZ Script implementation of the RiDetailRange() function

void DzScriptedRenderer::riDisplacement ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiDisplacementV() function

Parameters:
name The name of the displacement shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

void DzScriptedRenderer::riDisplay ( String  name,
String  type,
String  mode,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiDisplayV() function

void DzScriptedRenderer::riExposure ( Number  gain,
Number  gamma 
)

DAZ Script implementation of the RiExposure() function

void DzScriptedRenderer::riExterior ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiExteriorV() function

Parameters:
name The name of the volume shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

void DzScriptedRenderer::riFormat ( Number  xres,
Number  yres,
Number  aspect 
)

DAZ Script implementation of the RiFormat() function

void DzScriptedRenderer::riFrameAspectRatio ( Number  aspect  ) 

DAZ Script implementation of the RiFrameAspectRatio() function

void DzScriptedRenderer::riGeometricApproximation ( String  type,
Number  value 
)

DAZ Script implementation of the RiGeometricApproximation() function

void DzScriptedRenderer::riHider ( String  type,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiHiderV() function

void DzScriptedRenderer::riIdentity (  ) 

DAZ Script implementation of the RiIdentity() function

void DzScriptedRenderer::riIlluminate ( Number  light,
Boolean  onoff 
)

DAZ Script implementation of the RiIlluminate() function

void DzScriptedRenderer::riImager ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiImagerV() function

Parameters:
name The name of the imager shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

void DzScriptedRenderer::riInterior ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiInteriorV() function

Parameters:
name The name of the volume shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

Number DzScriptedRenderer::riLightSource ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiLightSourceV() function

Parameters:
name The name of the light shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens
Returns:
The light handle index for this light source

void DzScriptedRenderer::riMakeBump ( String  pic,
String  tex,
String  swrap,
String  twrap,
DzRenderOptions::PixelFilter  filterType,
Number  swidth,
Number  twidth,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiMakeBumpV() function

void DzScriptedRenderer::riMakeCubeFaceEnvironment ( String  px,
String  nx,
String  py,
String  ny,
String  pz,
String  nz,
String  tex,
Number  fov,
DzRenderOptions::PixelFilter  filterType,
Number  swidth,
Number  twidth,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiMakeCubeFaceEnvironmentV() function

void DzScriptedRenderer::riMakeLatLongEnvironment ( String  pic,
String  tex,
DzRenderOptions::PixelFilter  filterType,
Number  swidth,
Number  twidth,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiMakeLatLongEnvironmentV() function

void DzScriptedRenderer::riMakeShadow ( String  pic,
String  tex,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiMakeShadowV() function

void DzScriptedRenderer::riMakeTexture ( String  pic,
String  tex,
String  swrap,
String  twrap,
DzRenderOptions::PixelFilter  filterType,
Number  swidth,
Number  twidth,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiMakeTextureV() function

void DzScriptedRenderer::riMatte ( Boolean  onoff  ) 

DAZ Script implementation of the RiMatte() function

void DzScriptedRenderer::riOpacity ( Color  Os  ) 

DAZ Script implementation of the RiOpacity() function

void DzScriptedRenderer::riOption ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiOptionV() function

void DzScriptedRenderer::riOrientation ( String  orientation  ) 

DAZ Script implementation of the RiOrientation() function

void DzScriptedRenderer::riPerspective ( Number  fov  ) 

DAZ Script implementation of the RiPerspective() function

void DzScriptedRenderer::riPixelFilter ( DzRenderOptions::PixelFilter  filterType,
Number  xwidth,
Number  ywidth 
)

DAZ Script implementation of the RiPixelFilter() function

void DzScriptedRenderer::riPixelSamples ( Number  xsamples,
Number  ysamples 
)

DAZ Script implementation of the RiPixelSamples() function

void DzScriptedRenderer::riPixelVariance ( Number  variation  ) 

DAZ Script implementation of the RiPixelVariance() function

void DzScriptedRenderer::riProjection ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiProjectionV() function

void DzScriptedRenderer::riQuantize ( String  type,
Number  one,
Number  qmin,
Number  qmax,
Number  ampl 
)

DAZ Script implementation of the RiWQuantize() function

void DzScriptedRenderer::riRelativeDetail ( Number  relativedetail  ) 

DAZ Script implementation of the RiRelativeDetail() function

void DzScriptedRenderer::riReverseOrientation (  ) 

DAZ Script implementation of the RiReverseOrientation() function

void DzScriptedRenderer::riRotate ( Number  angle,
Number  dx,
Number  dy,
Number  dz 
)

DAZ Script implementation of the RiRotate() function

void DzScriptedRenderer::riScale ( Number  dx,
Number  dy,
Number  dz 
)

DAZ Script implementation of the RiScale() function

void DzScriptedRenderer::riScreenWindow ( Number  left,
Number  right,
Number  bot,
Number  top 
)

DAZ Script implementation of the RiScreenWindow() function

void DzScriptedRenderer::riShadingInterpolation ( String  type  ) 

DAZ Script implementation of the RiShadingInterpolation() function

void DzScriptedRenderer::riShadingRate ( Number  size  ) 

DAZ Script implementation of the RiShadingRate() function

void DzScriptedRenderer::riShutter ( Number  smin,
Number  smax 
)

DAZ Script implementation of the RiShutter() function

void DzScriptedRenderer::riSides ( Number  nsides  ) 

DAZ Script implementation of the RiSides() function

void DzScriptedRenderer::riSkew ( Number  angle,
Number  dx1,
Number  dy1,
Number  dz1,
Number  dx2,
Number  dy2,
Number  dz2 
)

DAZ Script implementation of the RiSkew() function

void DzScriptedRenderer::riSurface ( String  name,
Array  tokens,
Array  params 
)

DAZ Script implementation of the RiSurfaceV() function

Parameters:
name The name of the surface shader
tokens An Array of String token names passed to the shader
params An Array of corresponding values for tokens

void DzScriptedRenderer::riTransform ( DzMatrix4  transform  ) 

DAZ Script implementation of the RiTransform() function

void DzScriptedRenderer::riTransformBegin (  ) 

DAZ Script implementation of the RiTransformBegin() function

void DzScriptedRenderer::riTransformEnd (  ) 

DAZ Script implementation of the RiTransformEnd() function

void DzScriptedRenderer::riTranslate ( Number  dx,
Number  dy,
Number  dz 
)

DAZ Script implementation of the RiTranslate() function

void DzScriptedRenderer::riWorldBegin (  ) 

DAZ Script implementation of the RiWorldBegin() function

void DzScriptedRenderer::setBackgroundColor ( Color  color  ) 

Parameters:
color Sets the back ground color

void DzScriptedRenderer::setContinueAfterPreProcess ( Boolean  shouldContinue  ) 

Parameters:
shouldContinue PreProcess scripts should set this to false if they do not wish the the Ri call the launched them to execute

void DzScriptedRenderer::setCropWindow ( DzRenderHandler  handler  ) 

Sets the crop window form the handler for the render

void DzScriptedRenderer::setDisplacementPreProcessScript ( String  filename  ) 

Set the path of the script to be run before a material displacement is processed.

Attention:
"Renderer", "DisplacementName" and "Material"

void DzScriptedRenderer::setIsShadowPass ( Boolean  onOff  ) 

Parameters:
onOff Set true if this is a shadow pass

void DzScriptedRenderer::setLightPreProcessScript ( String  filename  ) 

Set the path of the script to be run before riLightSource and riAreaLightSource are processed.

Attention:
"Renderer" and "LightName"

void DzScriptedRenderer::setRenderScript ( String  filename  ) 

Set the path of the script that controls the rendering process.

Attention:
filename is executed the moment the call to this method is made. Global transient variables named Renderer - refering to the current DzRenderer, Camera - refering to the current DzCamera, BackDrop - refering to the current DzBackDrop, and RenderOptions - refering to the current DzRenderOptions, exist for the duration of filename. Referencing these variables from outside filename will result in an error.

void DzScriptedRenderer::setSurfacePreProcessScript ( String  filename  ) 

Set the path of the script to be run before riSurface is processed.

Attention:
"Renderer", "SurfaceName" and "Material"

Generated on Thu Sep 24 12:21:15 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.