vray.LightUtils

class vray.LightUtils

Bases: object

A group of utility methods related to variuos light source plugins.

Methods

__init__()

readLuminaireFieldPreviewData

Returns the generated data needed for Luminaire field preview.
static readLuminaireFieldPreviewData()

Returns the generated data needed for Luminaire field preview. If the second argument regarding the presence of the convex hull data is not provided then it will be resolved internally whether to provide the convex hull data.

Arguments:

  • luminaire - A LightLuminaire plugin instance or a string path to a Luminaire cache file name (.vlw|.vlg|.vlsh).

  • getConvexHullData - Force the returned object to contain the convex hull data. Optional. If ommited, it will be resolved internally whether to provide the convex hull data.

Returns a dictionary of data or None on failure:

  • useConvexHull, boolean - If true, the convex hull data is needed for the preview. Otherwise, only the bounding box. Always present. * bbox, Tuple - Bounding box of the luminaire. Always present.

  • vertices, VectorList - Vertices of light’s convex hull. Optional.

  • indices, IntList - Vertex indices of the convex hull in consecutive triplets. Optional.