scenefile Namespace Reference

Root element which contains the scene file description; All valid scene files must contain a single scenefile element. More...

Attributes
real_t	version
	Version of the Milton scenefile format that this scenefile conforms to.
renderer	renderer
	Suggested renderer and relating settings to use for the scene specified in this scenefile.
camera	camera
	Virtual camera to be used to render the scene specified in this scenefile.
output	output
	Specifies an output format for rendering the scene in this scenefile.
scene	scene
	Contains all shape and material data representing the virtual scene.

---

Detailed Description

Root element which contains the scene file description; All valid scene files must contain a single scenefile element.

The main component of the scenefile is the scene element, which specifies all geometry and materials (including light sources) in the scene. You may optionally also specify camera, output, and/or renderer elements, and for each that's left unspecified, a sensible default will be used.

optional

false

Example usage:

{

// valid, bare-bones scenefile describing an empty scene

"scenefile" : {

"scene" : { }

}

}

Example usage:

{

// typical scenefile example

"scenefile" : {

"renderer" : {

"type" : "pathTracer",

"noRenderThreads" : 10,

"noSuperSamples" : 1000,

},

"camera" : {

"type" : "thinlens",

"eye" : "0, 10, 0",

"aperture" : 50,

"fstop" : 18,

},

"scene" : {

// declare a planar, area light source

"material" : {

"emitter" : {

"type" : "oriented",

"power" : [ 80, 80, 80 ],

},

"plane" : { },

},

},

},

}

---

Attribute Documentation

camera scenefile::camera

Virtual camera to be used to render the scene specified in this scenefile.

type	camera
optional	true
default	if no camera is specified, a default pinhole camera will be used looking at the origin.

Example usage:

"camera" : {

"type" : "thinlens",

"eye" : [ 2, 2, 1 ],

"up" : [ 0, 1, 0 ],

"aperture" : 35,

"fstop" : 18,

},

output scenefile::output

Specifies an output format for rendering the scene in this scenefile.

optional

true

default

If no output is specified, the output size default to 480x480, and the output format depends on Milton's configuration and environment. If running on 'nox' mode, output will default to a file "out.png" unless otherwise specified via the "-output" commandline flag. If running in gui mode, rendering output will default to an ImageCanvas which allows the user to view the progress of the progressive renderer. Note that OpenGLRenderer does not support 'nox' mode as it is inherently interactive.

Example usage:

"output" : {

// render to GUI using a Lanczos reconstruction filter

"type" : "reconstruction",

"width" : 640,

"height" : 480,

"filter" : { "type" : "lanczosSinc", },

},

renderer scenefile::renderer

Suggested renderer and relating settings to use for the scene specified in this scenefile.

Many renderer-specific parameters need to be fine-tuned on a scene-by-scene basis. The accuracy and efficiency of photonMapper, for example, is greatly dependent on scene dimensions and geometry. Scene-specific renderer parameters may be specified in the renderer block, and any extraneous parameters unrelated to a specific renderer will be ignored at render-time.

type	renderer
optional	true
default	if no renderer is specified and Milton is run in 'nox' mode, pathTracer will be used as the default; if Milton is run in gui mode, preview (OpenGLRenderer) will be used as the default.

Example usage:

"renderer" : {

"type" : "pathTracer",

"noRenderThreads" : 10,

"noDirectSamples" : 1,

"generator" : "super",

"noSuperSamples" : 1000,

// photonMapper parameters that will be ignored by pathTracer

"diffuseGatherRadius" : 50,

"causticGatherRadius" : 0,

},

scene scenefile::scene

Contains all shape and material data representing the virtual scene.

type	scene
optional	false
default	Defaults to a rather boring, empty scene -- spice it up!!!

real_t scenefile::version

Version of the Milton scenefile format that this scenefile conforms to.

type	real scalar
optional	true
default	1

Example usage:

"scene" : {

"version" : 1.0,

// ...

},