API documentation for visualization library

Michael Galloy

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

povray/

visgrpovraylight__define.pro

object graphics

includes main-level program

Any IDL type of light source plus the POV-Ray area light.

Examples

To create an area light:

light = obj_new('VISgrPOVRayLight', type=2, location=[0, 5, 5], $ intensity=2.0, $ /arealight, $ width_axis=[0.3, 0, 0], height_axis=[0, 0.3, 0], $ n_width_light=5, n_height_lights=5, $ adaptive=1.0, /jitter)
This light is actually a 5 by 5 grid of lights spanning 0.3 units in the x direction and 0.3 units in the y direction (although each light is moved slightly by the JITTER keyword). This creates softer shadows.

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 visgrpovraylight__define
This should produce output with an area light (which makes a fuzzy shadow):

Class description for visgrpovraylight

Inheritance

All ancestor classes: IDLGRLIGHT IDLGRGRAPHIC IDLGRCOMPONENT IDLITCOMPONENT visgrpovrayobject

Properties

n_width_lights get set init

number of lights along width axis

height_axis get set init

vector representing height of area light

_extra set init
n_height_lights get set init

number of lights along height axis

arealight get set init

set to use an area light

_ref_extra get
width_axis get set init

vector representing width of area light

adaptive get set init

adaptive value

jitter get set init

set to use jitter

Routines

visgrpovraylight::getProperty, arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _ref_extra=_ref_extra

Get properties.

visgrpovraylight::setProperty, arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _extra=_extra

Set properties.

result = visgrpovraylight::init(arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _extra=_extra)

Create a light object.

visgrpovraylight__define

Define instance variables.

Routine details

top visgrpovraylight::getProperty

visgrpovraylight::getProperty, arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _ref_extra=_ref_extra

Get properties.

Keywords

arealight

set to use an area light

width_axis

vector representing width of area light

height_axis

vector representing height of area light

n_width_lights

number of lights along width axis

n_height_lights

number of lights along height axis

adaptive

adaptive value

jitter

set to use jitter

_ref_extra

top visgrpovraylight::setProperty

visgrpovraylight::setProperty, arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _extra=_extra

Set properties.

Keywords

arealight

set to use an area light

width_axis

vector representing width of area light

height_axis

vector representing height of area light

n_width_lights

number of lights along width axis

n_height_lights

number of lights along height axis

adaptive

adaptive value

jitter

set to use jitter

_extra

top visgrpovraylight::init

result = visgrpovraylight::init(arealight=arealight, width_axis=width_axis, height_axis=height_axis, n_width_lights=n_width_lights, n_height_lights=n_height_lights, adaptive=adaptive, jitter=jitter, _extra=_extra)

Create a light object.

Return value

1 for success, 0 for failure

Keywords

arealight

set to use an area light

width_axis

vector representing width of area light

height_axis

vector representing height of area light

n_width_lights

number of lights along width axis

n_height_lights

number of lights along height axis

adaptive

adaptive value

jitter

set to use jitter

_extra

top visgrpovraylight__define

visgrpovraylight__define

Define instance variables.

File attributes

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