VRay SDK for C++
Loading...
Searching...
No Matches
VRay::LightUtils Class Reference

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

#include <vraysdk.hpp>

Static Public Member Functions

static bool readIESPreviewData (const Plugin &lightPlugin, VectorList &vertices, IntList &indices)
 
static bool readIESPreviewData (const std::string &fileName, VectorList &vertices, IntList &indices)
 
static bool readLuminaireFieldPreviewData (const Plugin &luminairePlugin, LuminaireFieldReadPreviewData &readData)
 
static bool readLuminaireFieldPreviewData (const std::string &fileName, LuminaireFieldReadPreviewData &readData)
 

Detailed Description

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

Member Function Documentation

◆ readIESPreviewData() [1/2]

static bool VRay::LightUtils::readIESPreviewData ( const Plugin lightPlugin,
VectorList &  vertices,
IntList &  indices 
)
static
Parameters
lightPluginA LightIES plugin instance
verticesOutput vertex preview data.
indicesOutput face index data. Each three consecutive elements make up one triangle.
Returns
false if an error ocurred. Check getLastError() for additional info.

◆ readIESPreviewData() [2/2]

static bool VRay::LightUtils::readIESPreviewData ( const std::string &  fileName,
VectorList &  vertices,
IntList &  indices 
)
static
Parameters
fileNameIES file name (.ies)
verticesOutput vertex preview data.
indicesOutput face index data. Each three consecutive elements make up one triangle.
Returns
false if an error ocurred. Check getLastError() for additional info.

◆ readLuminaireFieldPreviewData() [1/2]

static bool VRay::LightUtils::readLuminaireFieldPreviewData ( const Plugin luminairePlugin,
LuminaireFieldReadPreviewData readData 
)
static
Parameters
luminairePluginA LightLuminaire plugin instance
readDataA structure handle which provides an API for getting the preview data relating to light luminaire field.
Returns
false if an error ocurred. Check getLastError() for additional info.

◆ readLuminaireFieldPreviewData() [2/2]

static bool VRay::LightUtils::readLuminaireFieldPreviewData ( const std::string &  fileName,
LuminaireFieldReadPreviewData readData 
)
static
Parameters
fileNameLuminaire cache file name (.vlw|.vlg|.vlsh)
readDataA structure handle which provides an API for getting the preview data relating to light luminaire field.
Returns
false if an error ocurred. Check getLastError() for additional info.

The documentation for this class was generated from the following file: