Detailed Description
class SkyLightEval :
public BaseInterface
- Description:
- This class is only available in release 5 or
later.
SkyLightEval is used by the radiosity system and LightTracer to sample the radiance of the sky in a specific direction.
#include <naturalLight.h>
Inheritance diagram for SkyLightEval:
Public Member Functions |
|
| virtual void | DeleteThis ()=0 |
| virtual bool | Gather (const Point3 &origin, const Point3 &direction, Point3 &radiance)=0 |
| virtual Class_ID | ClassID () const =0 |
| virtual bool | IsSameSky (const SkyLightEval *sky) const =0 |
Member Function Documentation
| virtual void DeleteThis | ( | ) | [pure virtual] |
- Remarks:
- Standard method to delete the object.
| virtual bool Gather | ( | const Point3 & | origin, |
| const Point3 & | direction, | ||
| Point3 & | radiance | ||
| ) | [pure virtual] |
- Remarks:
- Returns the spectral radiance along a ray of given origin and direction in world space. Return true if the intensity is in MAX units, or false if intensity is in international units. The radiance is stored in the parameter radiance.
| virtual Class_ID ClassID | ( | ) | const [pure virtual] |
- Remarks:
- Returns the class id of the class that created this SkyLightEval. This is used by IsSameSky to determine whether the sky has changed.
| virtual bool IsSameSky | ( | const SkyLightEval * | sky | ) | const [pure virtual] |
- Remarks:
- Compare two skys. Return true if the Gather method will return the same result. The implementation should determine whether the objects are the same type using ClassID(). If they are different types, return false. If they are the same type, the parameters should be compared to see if the Gather method will return the same values for the two objects.
