vrdHDRLightStudio

class vrdHDRLightStudio

(Inherits vrdSceneObject)

This class is used for connecting a VRED environment to HDR Light Studio.

class LightPaintMode
ReflectionPainting
IlluminationPainting
RimPainting

Functions

vrdHDRLightStudio.editAndLoadSettings()

Opens HDR Light Studio and tries to load a project saved for this environment. If no project has been previously saved for this environment, you start with a blank canvas. The current HDR image is replaced. All changes made on the HDR Light Studio canvas are immediately applied to the HDR image of the connected VRED Sphere Environment.

Returns:Success
Return type:bool
vrdHDRLightStudio.getLightPaint()

Gets the Light Paint enable state. Light Paint allows you to directly click the VRED Render Window for positioning light sources in the HDR image.

Returns:Current state of Light Paint
Return type:bool
vrdHDRLightStudio.getLightPaintMode()

Gets the light paint mode used for positioning light sources in the HDR image.

Returns:Current light paint mode
Return type:vrdHDRLightStudio.LightPaintMode
vrdHDRLightStudio.isConnected()
Returns:Whether the VRED environment this vrdHDRLightStudio object belongs to is connected to a running instance of HDR Light Studio.
Return type:bool
vrdHDRLightStudio.quit()

Shuts down the HDR Light Studio background process (HDRLightStudio.exe) and frees up the license.

vrdHDRLightStudio.saveSettings()

Internally saves the HDR Light Studio project for the Sphere Environment currently being edited.

Returns:Success
Return type:bool
vrdHDRLightStudio.setLightPaint(value)

Toggle Light Paint on or off. Light Paint allows you to directly click the VRED Render Window for positioning light sources in the HDR image.

Parameters:value (bool) – True to enable Light Paint tool, False to disable it.
vrdHDRLightStudio.setLightPaintMode(mode)

Sets the light paint mode used for positioning light sources in the HDR image.

Parameters:mode (vrdHDRLightStudio.LightPaintMode) – New light paint mode
vrdHDRLightStudio.show()

Displays the HDR Light Studio window, if previously closed.