Light Class Reference

This class contains base information for lights, as specified on the DragonAge's toolset. More...

#include <eclight.h>

Inheritance diagram for Light:

EclipseObject AmbientLight AreaLight PointLight SpotLight

List of all members.

Public Member Functions

virtual ~Light ()
 Destructor.
YRLightGetLight ()
 Access the YR light object.
virtual PYOBJECT PyAsString ()
 Python text representation method This function must be implemented by all children.

Static Public Member Functions

static bool PyTypeCheck (PYOBJECT a_pObject)
 Python type check Verifies that the provided python object encapsulates a light.

Protected Member Functions

 Light ()
 Default constructor. Usable by children only.
YRLight *& GetYRLight ()
 Provides access to our raytracer light.
int & ShadowSamples ()
 Access to our shadow samples.
YRColorRGBShadowColor ()
 Access our shadow color.
virtual PYOBJECT GetPyStringRep () ECLIPSE_PURE
 Provide a string representation of this child.


Detailed Description

This class contains base information for lights, as specified on the DragonAge's toolset.

Base light class for light definitions coming from the DA toolset.

It also provides means for representing them internally in our raytraced scene.

Concrete implementations of this class are essentially managers for the different types of lights supported by the raytracer.

Yafray Lights are implicitly owned by their environment

Author:
Dan Torres 2008/12/10

Definition at line 47 of file eclight.h.


Member Function Documentation

virtual PYOBJECT Light::PyAsString (  )  [virtual]

Python text representation method This function must be implemented by all children.

Returns:
A python string object with a description of ourselves

Reimplemented from EclipseObject.

static bool Light::PyTypeCheck ( PYOBJECT  a_pObject  )  [static]

Python type check Verifies that the provided python object encapsulates a light.

Returns:
True if the provided object type is the same as ours

Reimplemented from EclipseObject.


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

Generated on Tue Jan 20 17:57:57 2009 for EclipseRay by  doxygen 1.5.7.1