DzLight Class Reference
[Scene Items]

Base class for all lights. More...

Inheritance diagram for DzLight:

DzCamera DzNode DzElement DzBase QObject Object DzDistantLight DzShaderLight DzPointLight DzSpotLight List of all members.

Enumerations



enum  ShadowType { None, DeepShadowMap, Raytraced }

Methods

Color getDiffuseColor ()
ShadowType getShadowType ()
DzEnumProperty getShadowTypeControl ()
DzVec3 getWSDirection ()
Boolean isAreaLight ()
Boolean isDirectional ()
Boolean isOn ()

Detailed Description

Base class for all lights.


Member Enumeration Documentation

enum DzLight::ShadowType

The type of shadowing to use for the light.

Enumerator:
None  The light does not utilize shadows
DeepShadowMap  The light utilizes a Deep Shadow Map (DSM)
Raytraced  The light utilizes ray-traced shadows


Member Function Documentation

Color DzLight::getDiffuseColor (  ) 

Returns:
the current diffuse light color, including adjustment for intensity.

Reimplemented in DzDistantLight.

ShadowType DzLight::getShadowType (  ) 

Returns:
The enumerated value indicating the type of shadow utilized by the light.

DzEnumProperty DzLight::getShadowTypeControl (  ) 

Returns:
The property used to indicate the type of shadow utilized by the light.

DzVec3 DzLight::getWSDirection (  ) 

Calculates the direction that light is being cast from this light.

Only valid for directional light sources.

Returns:
The current world-space light-casting direction vector.

Reimplemented in DzDistantLight.

Boolean DzLight::isAreaLight (  ) 

Returns:
true if this is an area light source. If true, the light source center will be given by the position of the light. Additional light geometry will be defined in the derived classes.

Boolean DzLight::isDirectional (  ) 

Indicates if this light is an infinite directional light.

Directional lights do not have a position per se. They are assumed to lie at infinity and cast parallel rays of light into the scene.

Returns:
true if this light is directional. False for omni-directional lights.

Boolean DzLight::isOn (  ) 

Returns:
true if this light is currently on.

Reimplemented in DzDistantLight.


Generated on Thu Sep 24 12:21:13 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.