User Tools

Site Tools


DzDistantLight

Base class for all lights. A light that emits in one direction.

More...

Inherits :

Inherited By : DzPointLight and DzSpotLight

Enumerations

Constructors

DAZ Script
DzDistantLight ()

Methods

Detailed Description

TODO: Add detailed description.

Enumerations


: AreaShape

TODO: Add description.

  • Point - TODO: Add description.
  • Rectangle - TODO: Add description.
  • Disc - TODO: Add description.
  • Sphere - TODO: Add description.
  • Cylinder - TODO: Add description.

Constructors


DzDistantLight()

Default Constructor. Creates a new distant light.

Methods


Color : getDiffuseColor()

Return Value:

  • The diffuse color of the light

DzColorProperty : getDiffuseColorControl()

Return Value:

  • A pointer to the property that controls the color this light

Number : getFarClippingPlane()

Return Value:

  • The far clipping plane when viewing from the light in OpenGL

Number : getFlux()

Return Value:

  • The luminous flux of the light.

Since:

  • 4.8.0.18

DzEnumProperty : getIlluminationControl()

Return Value:

  • A pointer to the property that controls Illumination for this light

Number : getIntensity()

Return Value:

  • The current light intensity.

DzFloatProperty : getIntensityControl()

Return Value:

  • A pointer to the property that controls the intensity of this light

Number : getIntensityScale()

Return Value:

  • The current light intensity scale.

Since:

  • 4.8.0.18

DzFloatProperty : getIntensityScaleControl()

Return Value:

  • The property that controls the intensity scale.

Since:

  • 4.8.0.18

DzFloatProperty : getLightFluxControl()

Return Value:

  • The property that controls the luminous flux of the light.

Since:

  • 4.8.0.18

AreaShape : getLightGeometry()

Return Value:

  • The type of geometry for the light; 0 = Point, 1 = Rectangle, 2 = Disc, 3 = Sphere, 4 = Cylinder.

Since:

  • 4.8.0.18

DzEnumProperty : getLightGeometryControl()

Return Value:

  • The property that controls the geometry of the light.

Since:

  • 4.8.0.18

Number : getLightHeight()

Return Value:

  • The height of the light (emitter) geometry, as measured in centimeters, in local space.

Since:

  • 4.8.0.18

DzFloatProperty : getLightHeightControl()

Return Value:

  • The property that controls the height of the light.

Since:

  • 4.8.0.18

DzBoolProperty : getLightPortalControl()

Return Value:

  • The property that controls whether or not the light represents a light portal.

Since:

  • 4.9.2.61

Number : getLightTempature()

Return Value:

  • The color temperature of the light, as measured in Kelvin (K).

Since:

  • 4.8.0.18

DzFloatProperty : getLightTemperatureControl()

Return Value:

  • The property that controls the temperature of the light.

Since:

  • 4.8.0.18

Boolean : getLightTwoSided()

Return Value:

  • true if the light is two-sided (emits light in both directions), otherwise false.

Since:

  • 4.8.0.18

DzBoolProperty : getLightTwoSidedControl()

Return Value:

  • The property that controls whether the light is two sided.

Since:

  • 4.8.0.18

Number : getLightWidth()

Return Value:

  • The width of the light (emitter) geometry, as measured in centimeters, in local space.

Since:

  • 4.8.0.18

DzFloatProperty : getLightWidthControl()

Return Value:

  • The property that controls the width (diameter) of the light.

Since:

  • 4.8.0.18

Number : getNearClippingPlane()

Return Value:

  • The near clipping plane when viewing from the light in OpenGL

DzBoolProperty : getPhotometricModeControl()

Return Value:

  • The property that controls whether the light is in physically-based mode.

Since:

  • 4.8.0.18

DzBoolProperty : getRenderEmitterControl()

Return Value:

  • The property that controls whether the emitter is rendered.

Since:

  • 4.8.0.18

DzFloatProperty : getShadowBiasControl()

Return Value:

  • A pointer to the property that controls the bias for the shadow of this light

DzColorProperty : getShadowColorControl()

Return Value:

  • A pointer to the property that controls the color this light

DzFloatProperty : getShadowIntensityControl()

Return Value:

  • A pointer to the property that controls the shadow intensity of this light

DzFloatProperty : getShadowSoftnessControl()

Return Value:

  • A pointer to the property that controls the softness for the shadow of this light

DzVec3 : getWSDirection()

Return Value:

  • The direction the light is pointing in world-space

Boolean : isLightPortal()

Return Value:

  • true if this light represents a light portal, otherwise false.

Since:

  • 4.9.2.61

Boolean : isOn()

Return Value:

  • true if the light is lighting the scene, false if the light has no effect on the scene.

Boolean : photometricMode()

Return Value:

  • true if the light is in photometric mode (physically based), otherwise false.

Since:

  • 4.8.0.18

Boolean : renderEmitter()

Return Value:

  • true if the geometry of the light (emitter) should be rendered, otherwise false.

Since:

  • 4.8.0.18