Page History

Table of Contents

0. Who this is for

These guidelines are for users of the AppSDK who want to use it to create a scene for rendering with V-Ray from the data in their host application scene. We will not discuss details on how to write code with the AppSDK here - there are separate docs for this. Rather we will cover what V-Ray plugins to add to the scene, how to link them and what parameters to set.
Note: This document will be updated and extended over time.

...

• ies_file - Path to the file describing the light source
• filter_color - Use to tint the light. The default is white (1.0, 1.0, 1.0). Light color is defined by color temperature in the IES file.
• soft_shadows - Set to 0 (default) to cast hard shadows as point light; 1 to use the shape of the light for shadows; 2 to also use the shape for illumination
• power - Overrides the power specified in the file if > 0. The unit is lumens.
• ies_light_shape - Overrides the shape in the file if set to >= 0. Possible enumerated values: <TODO table>
• ies_light_width - Used if ies_light_shape override is on.
• ies_light_length - Used if ies_light_shape override is on.
• ies_light_height - Used if ies_light_shape override is on.
• ies_light_diameter - Used if ies_light_shape override is on.

SunLight

• transform - Similarly to the direct light plugin, the position doesn't matter as the light comes from infinity. The rotation matrix has to be set correctly, even though in theory the Sun is omnidirectional. The identity matrix results in light directed along the -Z axis, thus a noon Sun.
• target_transform - Currently doesn't make a difference. Don't leave uninitialized - set an identity transform.
• turbidity - See VRaySun
• ozone - See VRaySun
• water_vapour - See VRaySun
• size_multiplier - See VRaySun
• color_mode - See VRaySun. Values are 0, 1, 2 respectively for Filter, Direct, Override mode.
• intensity_multiplier - Control the intensity of the Sun. Try setting correct scales in SettingsUnitsInfo first.
• filter_color - Force a color tint. It's probably better to leave this white. See also the color_mode parameter.
• ground_albedo - Sky parameter, unused if there is no sky attached. Account for light reflected off an imaginary ground and scattered back in the sky. Default is (0.2, 0.2, 0.2).

...

• horiz_illum - Sky parameter, unused if there is no sky attached. Specifies the intensity (in lx) of the illumination on horizontal surfaces coming from the sky
• sky_model - Sky parameter, unused if there is no sky attached. Selects the mathematical model approximating sky illumination. Values: <TODO>
• up_vector - Set to (0.0, 1.0, 0.0) if your scene up-axis is +Y to have correct lighting.

...