This interface represents light profiles. More...
Public Member Functions | |
| virtual Sint32 | reset_file (const char *filename, Uint32 resolution_phi=0, Uint32 resolution_theta=0, Lightprofile_degree degree=LIGHTPROFILE_HERMITE_BASE_1, Uint32 flags=LIGHTPROFILE_COUNTER_CLOCKWISE)=0 |
Resets the underlying file to a new file given by filename. More... |
|
| virtual const char * | get_filename () const =0 |
| Returns the resolved file name of the file containing the light profile. More... |
|
| virtual const char * | get_original_filename () const =0 |
| Returns the unresolved file name as passed to reset_file(). More... |
|
| virtual Uint32 | get_resolution_phi () const =0 |
| Returns the resolution of the grid in phi-direction. More... |
|
| virtual Uint32 | get_resolution_theta () const =0 |
| Returns the resolution of the grid in theta-direction. More... |
|
| virtual Lightprofile_degree | get_degree () const =0 |
| Returns the interpolation degree that was used to interpolate the grid data. More... |
|
| virtual Uint32 | get_flags () const =0 |
| Returns flags that were used to interpret the light profile data in the file. More... |
|
| virtual Float32 | get_phi (Uint32 index) const =0 |
Returns the index -th phi value. More... |
|
| virtual Float32 | get_theta (Uint32 index) const =0 |
Returns the index -th theta value. More... |
|
| virtual const Float32 * | get_data () const =0 |
| Returns the normalized data of the entire mesh. More... |
|
| virtual Float32 | get_data (Uint32 index_phi, Uint32 index_theta) const =0 |
| Returns the normalized data for a grid vertex. More... |
|
| virtual Float64 | get_candela_multiplier () const =0 |
| Returns the normalization factor. More... |
|
| virtual Float32 | sample (Float32 phi, Float32 theta, bool candela) const =0 |
| Samples the light profile. More... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0xa4ac11fd, 0x705d, 0x4a0a, 0x80, 0x0b, 0x38, 0xe5, 0x3d, 0x46, 0x96, 0x47, IScene_element >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IScene_element > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0xa4ac11fd, 0x705d, 0x4a0a, 0x80, 0x0b, 0x38, 0xe5, 0x3d, 0x46, 0x96, 0x47, IScene_element >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
This interface represents light profiles.
IES light profiles [IES02] are supplied by lamp vendors to describe their products. They contain a rectangular grid of measured light intensities.
A light profile appears in the scene as an argument of an MDL function call (see mi::IMdl_function_call) or default argument of an MDL function definition (see mi::IMdl_function_definition). The type of such an argument is "Attachable<Ref<Lightprofile>>" (see mi::IRef and mi::IAttachable).
|
pure virtual |
Returns the normalization factor.
All data is normalized such that the maximum is 1.0. The values returned by methods like get_data() need to be multiplied by this normalization factor to retrieve the true value.
|
pure virtual |
Returns the normalized data of the entire mesh.
|
pure virtual |
Returns the normalized data for a grid vertex.
| index_phi | Index in phi-direction of the vertex. |
| index_theta | Index in theta-direction of the vertex. |
|
pure virtual |
Returns the interpolation degree that was used to interpolate the grid data.
|
pure virtual |
Returns the resolved file name of the file containing the light profile.
The method returns NULL if there is no file associated with the light profile, e.g., after default construction or failures to resolve the file name passed to reset_file().
|
pure virtual |
Returns flags that were used to interpret the light profile data in the file.
|
pure virtual |
Returns the unresolved file name as passed to reset_file().
The method returns NULL after default construction.
Returns the index -th phi value.
Note that the mesh is an equidistant grid, i.e., the distance between subsequent phi values is always the same. If index is out of bounds, 0 is returned.
|
pure virtual |
Returns the resolution of the grid in phi-direction.
|
pure virtual |
Returns the resolution of the grid in theta-direction.
Returns the index -th theta value.
Note that the mesh is an equidistant grid, i.e., the distance between subsequent theta values is always the same. If index is out of bounds, 0 is returned.
|
pure virtual |
Resets the underlying file to a new file given by filename.
| filename | The new file containing the light profile data. |
| resolution_phi | The desired resolution in phi-direction. The special value 0 represents the resolution from the file itself. |
| resolution_theta | The desired resolution in theta-direction. The special value 0 represents the resolution from the file itself. |
| degree | The interpolation method to use. |
| flags | Flags to be used when interpreting the file data, see mi::Lightprofile_flags for details. |
NULL pointer).degree or flags is invalid (exactly one of mi::LIGHTPROFILE_COUNTER_CLOCKWISE or mi::LIGHTPROFILE_COUNTER_CLOCKWISE must be set).
|
pure virtual |
Samples the light profile.
The method computes a bi-linear interpolation of the light profile at (phi,theta) according to the resolution.
| phi | First dimension of sample point. |
| theta | Second dimension of sample point. |
| candela | If false, normalized values are returned, otherwise true values. See get_candela_multiplier(). |