API documentation for visualization library

Michael Galloy

single page | use frames     summary     class     fields     routine details     file attributes

povray/

visgrpovray__define.pro

object graphics

includes main-level program

This class is a POV-Ray object graphics destination. Drawing to this destination will create one .inc file for every atom in the object graphics hierarchy, a .pov file with the scene setup, and a .ini file with some parameters like output dimensions.

Examples

To create a POV-Ray destination and drawing to it after creating an object graphics hierarchy, view, just do the following:

pov = obj_new('VISgrPOVRay', file_prefix='cow-output/cow', dimensions=dims) pov->draw, view
See the example attached to the end of this file as a main-level program (only available if you have the source code version of this routine):
IDL> .run visgrpovray__define
The example should produce a png file, cow.png:

Class description for visgrpovray

Inheritance

Properties

dimensions get set init

lonarr(2) specifying default width and height of output image; default value is [400, 400]

graphics_tree init

graphics tree to render if none is provided to draw method

file_prefix get set init

prefix to add to all output files; final result will be:

file_prefix + '.png'

Routines

visgrpovray::draw [, tree]

Write the object graphics rooted at the specified scene or view.

visgrpovray::setProperty, file_prefix=file_prefix, dimensions=dimensions

Set properties.

visgrpovray::getProperty, file_prefix=file_prefix, dimensions=dimensions

Get properties.

visgrpovray::cleanup

Free resources.

result = visgrpovray::init( [file_prefix=string] [, dimensions=lonarr(2)] [, graphics_tree=object])

Create POV-Ray output destination for object graphics.

visgrpovray__define

Define instance variables.

Routine details

top visgrpovray::draw

visgrpovray::draw [, tree]

Write the object graphics rooted at the specified scene or view.

Parameters

tree in optional type=object

scene or view object

top visgrpovray::setProperty

visgrpovray::setProperty, file_prefix=file_prefix, dimensions=dimensions

Set properties.

Keywords

file_prefix

prefix to add to all output files; final result will be:

file_prefix + '.png'

dimensions

lonarr(2) specifying default width and height of output image; default value is [400, 400]

top visgrpovray::getProperty

visgrpovray::getProperty, file_prefix=file_prefix, dimensions=dimensions

Get properties.

Keywords

file_prefix

prefix to add to all output files; final result will be:

file_prefix + '.png'

dimensions

lonarr(2) specifying default width and height of output image; default value is [400, 400]

top visgrpovray::cleanup

visgrpovray::cleanup

Free resources.

top visgrpovray::init

result = visgrpovray::init( [file_prefix=string] [, dimensions=lonarr(2)] [, graphics_tree=object])

Create POV-Ray output destination for object graphics.

Return value

1 for success, 0 for failure

Keywords

file_prefix in optional type=string default=idlgr

prefix to add to all output files; final result will be:

file_prefix + '.png'

dimensions in optional type=lonarr(2) default=[400, 400]

default image size of the POV-Ray result

graphics_tree in optional type=object

graphics tree to tree if none is provided to draw method

top visgrpovray__define

visgrpovray__define

Define instance variables.

File attributes

Modification date: Mon Nov 29 18:32:37 2010
Lines: 883
Docformat: rst rst