vrdRayFile

class vrdRayFile

(Inherits vrdSceneObject)

Interface to ray files.

Ray light files contain the simulated spatial and angular distribution, as well as photometric or spectral information of emitted light from a complex light source.

Functions

vrdRayFile.clear()

Clears the loaded file.

vrdRayFile.getDirectEvaluationConeAngle()

Returns the cone of valid directions used when directly looking into a ray file.

Returns:Angle
Return type:float
vrdRayFile.getDirectEvaluationOffset()

Returns the offset along the surface normal to be used when directly looking into a ray file. Use this to fix lookup surfaces that are not exactly where the ray origins are.

Returns:Offset along the surface normal
Return type:float
vrdRayFile.getDirectEvaluationRadius()

Returns the radius to be used for lookup when directly looking into a ray file.

Returns:Radius
Return type:float
vrdRayFile.getEmitterConeAngle()

Returns the one around a ray direction used to generate photons.

Returns:Angle
Return type:float
vrdRayFile.getFileName()

Returns the file name of the ray file.

Returns:File name
Return type:string
vrdRayFile.getRayFileInfo()

Returns ray file information.

Returns:Ray file information
Return type:vrdRayFileInfo
vrdRayFile.getUseLightSpectrum()

Returns true if only the light spectrum is used of a ray.

Returns:True, if only light spectrum is used
Return type:bool
vrdRayFile.getUsePhotonsForDirectLighting()

Returns whether photon mapping for direct lighting is used or not. If disabled, ray lights can be used without photon mapping but it is necessary to define surface with ray light evaluation turned on. These surfaces will then act as light sources using all the ray files that are within the given radius.

Returns:True if photon mapping for direct lighting is used
Return type:bool
vrdRayFile.getUseRandomSampling()

Returns true if random sampling of the rays is used.

Returns:True, if random sampling is used
Return type:bool
vrdRayFile.getVisualizationRayCount()

Returns the number of rays used for the viewport visualization.

Returns:Number of rays
Return type:integer
vrdRayFile.getVisualizationRayLength()

Returns the length used for the viewport visualization of rays.

Returns:Length of rays
Return type:float
vrdRayFile.load(filename)

Loads the given file.

Parameters:filename (string) – path to the ray file
vrdRayFile.reload()

Reloads the current file.

vrdRayFile.setDirectEvaluationConeAngle(angle)

Sets the cone of valid directions to be used when directly looking into a ray file.

Parameters:angle (float) – Angle
vrdRayFile.setDirectEvaluationOffset(offset)

Sets the offset along the surface normal to be used when directly looking into a ray file. Use this to fix lookup surfaces that are not exactly where the ray origins are.

Parameters:offset (float) – Offset along the surface normal
vrdRayFile.setDirectEvaluationRadius(radius)

Sets the radius to be used for lookup when directly looking into a ray file.

Parameters:radius (float) – Radius
vrdRayFile.setEmitterConeAngle(angle)

Sets the cone around a ray direction used to generate photons.

Parameters:angle (float) – Angle
vrdRayFile.setFileName(fileName)

Loads the given ray file and sets the file name.

Parameters:fileName (string) – File path of the ray file
vrdRayFile.setTo(other)

Shares data of ray file in order to reduce memory consumption. Note that when a ray file is no longer used by any light it will be removed and needs to be reloaded from disk again.

Parameters:other (vrdRayFile) – Ray file to get shared data
vrdRayFile.setUseLightSpectrum(use)

Uses only the photometric value of a ray as a scaling factor for the light spectrum. Use this if you have a monochromatic ray file.

Parameters:use (bool) – Enables use of photometric value of a ray if set to True
vrdRayFile.setUsePhotonsForDirectLighting(use)

Toggles whether to use photon mapping for direct lighting or not. If disabled, ray lights can be used without photon mapping but it is necessary to define surface with ray light evaluation turned on. These surfaces will then act as light sources using all the ray files that are within the given radius.

Parameters:use (bool) – True to enable photon mapping for direct lighting
vrdRayFile.setUseRandomSampling(use)

Uses random sampling of the rays. Use this if you have more than one luminaire in your ray file.

Parameters:use (bool) – Enables random sampling if set to True
vrdRayFile.setVisualizationRayCount(count)

Sets the number of rays used for the viewport visualization.

Parameters:count (integer) – Number of rays
vrdRayFile.setVisualizationRayLength(length)

Sets the length of used for the viewport visualization of rays.

Parameters:length (float) – Length of rays