Light Class Reference
#include <gfx.h>
Class Description
Describes lights used in the interactive renderer.
All methods of this class are implemented by the system.
Inheritance diagram for Light:
Public Member Functions | |
| DllExport | Light () |
| Constructor. More... | |
| Public Member Functions inherited from BaseInterfaceServer | |
| virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
| virtual UtilExport int | NumInterfaces () const |
| virtual UtilExport BaseInterface * | GetInterfaceAt (int i) const |
| virtual UtilExport | ~BaseInterfaceServer () |
| Public Member Functions inherited from InterfaceServer | |
| virtual UtilExport | ~InterfaceServer () |
| Destructor. More... | |
Public Attributes | |
| LightType | type |
| The type of the light. More... | |
| Point3 | color |
| The color of the light. More... | |
| int | attenType |
| Attenuation type. More... | |
| float | attenStart |
| Starting attenuation value. More... | |
| float | attenEnd |
| Ending attenuation value. More... | |
| float | intensity |
| Light multiplier factor. More... | |
| float | hotSpotAngle |
| Angle of cone for spot and cone lights in degrees. More... | |
| float | fallOffAngle |
| Fall-off angle. More... | |
| int | shape |
| Indicates the shape of the light. More... | |
| float | aspect |
| The aspect ratio of the light. More... | |
| int | overshoot |
| If this value is non-zero it indicates the light supports overshoot. More... | |
| BOOL | affectDiffuse |
| When set to FALSE by a user the light does not illuminate the diffuse component of an object's material. More... | |
| BOOL | affectSpecular |
| When set to FALSE by a user the light does not illuminate the specular component of an object's material. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MaxHeapOperators | |
| static UtilExport void * | operator new (size_t size) |
| Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
| Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new (size_t size, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
| New operator used to allocate arrays of objects. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More... | |
| static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
| New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More... | |
| static UtilExport void | operator delete (void *ptr) |
| Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
| Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
| Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More... | |
| static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
| Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More... | |
| static UtilExport void * | operator new (size_t size, void *placement_ptr) |
| Placement new operator. More... | |
| static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
| Placement delete operator. More... | |
| Protected Attributes inherited from BaseInterfaceServer | |
| Tab< BaseInterface * > | interfaces |
Constructor & Destructor Documentation
Member Data Documentation
| LightType type |
The type of the light.
Has one of the following values:
- OMNI_LGT - Omni-directional.
- SPOT_LGT - Spot light.
- DIRECT_LGT - Directional light.
- AMBIENT_LGT - Ambient light (global illumination)
| Point3 color |
The color of the light.
| int attenType |
Attenuation type.
GW_ATTEN_NONE by default.
| float attenStart |
Starting attenuation value.
| float attenEnd |
Ending attenuation value.
| float intensity |
Light multiplier factor.
| float hotSpotAngle |
Angle of cone for spot and cone lights in degrees.
| float fallOffAngle |
Fall-off angle.
| int shape |
Indicates the shape of the light.
It is either:
- GW_SHAPE_RECT - Rectangular spotlights.
- GW_SHAPE_CIRCULAR - Circular spotlights.
| float aspect |
The aspect ratio of the light.
| int overshoot |
If this value is non-zero it indicates the light supports overshoot.
| BOOL affectDiffuse |
When set to FALSE by a user the light does not illuminate the diffuse component of an object's material.
This value is TRUE by default.
| BOOL affectSpecular |
When set to FALSE by a user the light does not illuminate the specular component of an object's material.
This value is TRUE by default.