Table 6.206 — DRM_Pyramid_Directional_Light

Property

Description

Class

  • <DRM Pyramid Directional Light>

Superclass

Subclass

  • None.

Definition

A light whose intensity varies depending on the observer's position relative to the light's location, direction, and lobe, which is pyramid-shaped.

It is possible when defining the <DRM Lobe Data> component of a <DRM Pyramid Directional Light>, to set the horizontal_width or vertical_width to 0. When one of these values is set to 0, then it means infinity, and that there are no bounds in that direction. The shape of the light then becomes a wedge shape.

If a secondary colour exists, then it is seen outside the lobe.

Class diagram

Figure 6.242 — DRM_Pyramid_Directional_Light

Inherited field elements

Field name

Range

Field data type

None

   

Field elements

Field name

Range

Field data type

use_full_intensity1

 

Boolean

minimum_colour_intensity2

[0.0..1.0]

Long_Float

invisible_behind3

 

Boolean

Associated to (one-way) (inherited)

  • None.

Associated to (one-way)

  • None.

Associated by (one-way) (inherited)

  • None.

Associated by (one-way)

  • None.

Associated with (two-way) (inherited)

  • None.

Associated with (two-way)

  • None.

Composed of (two-way) (inherited)

Composed of (two-way metadata) (inherited)

  • None.

Composed of (two-way metadata)

  • None.

Component of (two-way) (inherited)

Component of (two-way)

  • None.

Constraints

Clarifications

1 If TRUE, this value indicates that the full intensity of the light is shown in the pyramid shaped area. Otherwise, the intensity of the light decreases (towards the minimum_colour_intensity value) as one moves away from the LIGHT_DIRECTION vector.

2 This value is used in conjunction with the primary colour's intensity value. If the primary colour is a <DRM Colour Index>, the full intensity is specified by its intensity_level field. If the primary colour is an <DRM Inline Colour>, the full intensity is 1,0.

A location in the direct path of the <DRM Lobe Data>'s LIGHT_DIRECTION vector receives the full intensity value. If use_full_intensity is FALSE, the intensity decreases with increasing distance from the light direction vector, until the boundary specified by the horizontal and vertical <DRM Lobe Data> widths is reached. Outside the lobe, the intensity is minimum_colour_intensity.

If the minimum_colour_intensity value is 0,0, the secondary colour (if present) will be seen outside the lobe. If no secondary colour is present, then nothing is visible outside the lobe.

3 If this value is TRUE, the directional light is invisible when viewed from behind the plane of the directional light.

4 This specifies the lobe shape.

Example(s)