official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: DirectionalLight

X3D: 3.3
Component: Lighting
Status:
experimental

Quick Links

➨ Fields
➨ Properties

.nodeTypes. DirectionalLight

The DirectionalLight node defines a directional light source that illuminates along rays parallel to a given 3-dimensional vector. A directional light source illuminates only the objects in its enclosing parent group. The light may illuminate everything within this coordinate system, including all children and descendants of its parent group. The accumulated transformations of the parent nodes affect the light. DirectionalLight nodes do not attenuate with distance.

HTML Encoding and Default Values⤴

<DirectionalLight ambientIntensity='0' color='1,1,1' direction='0,0,-1' global='false' intensity='1' metadata='X3DMetadataObject' on='true' shadowCascades='1' shadowFilterSize='0' shadowIntensity='0' shadowMapSize='1024' shadowOffset='0' shadowSplitFactor='1' shadowSplitOffset='0.1' zFar='-1' zNear='-1' ></DirectionalLight>

Inheritance⤴


Constructor⤴

DirectionalLight(ctx)⤴

Constructor for DirectionalLight

Parameters:
Name Type Argument Default Description
ctx Object <optional>
 null context object, containing initial settings like namespace

Fields⤴

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
ambientIntensity SFFloat 0 [0, 1] X3DLightNode The ambientIntensity specifies the intensity of the ambient emission from the light. Light intensity may range from 0.0 (no light emission) to 1.0 (full intensity).
color SFColor 1,1,1 [0, 1] X3DLightNode The color field specifies the spectral colour properties of both the direct and ambient light emission as an RGB value.
direction SFVec3f 0,0,-1 The direction field specifies the direction vector of the illumination emanating from the light source in the local coordinate system.
global SFBool false X3DLightNode Specifies whether the light is global or scoped. Global lights illuminate all objects that fall within their volume of lighting influence. Scoped lights only illuminate objects that are in the same transformation hierarchy as the light; i.e., only the children and descendants of its enclosing parent group are illuminated.
intensity SFFloat 1 [0, 1] X3DLightNode The intensity field specifies the brightness of the direct emission from the light. Light intensity may range from 0.0 (no light emission) to 1.0 (full intensity).
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
on SFBool true X3DLightNode The on field specifies whether the light is enabled or disabled.
shadowCascades SFInt32 1
shadowFilterSize SFInt32 0 X3DLightNode Sets the smoothness of the shadow umbra.
shadowIntensity SFFloat 0 [o, 1] X3DLightNode Defines the attenuation of the shadows
shadowMapSize SFInt32 1024 [0, inf] X3DLightNode Specifies the resolution of the used shadow map.
shadowOffset SFFloat 0 X3DLightNode Defines the shadow offset for the back projection of the shadow map.
shadowSplitFactor SFFloat 1
shadowSplitOffset SFFloat 0.1
zFar SFFloat -1 -1 or [0, inf] X3DLightNode Specifies the placement of the far plane of the light projection. Objects that are farther away from the light source than the far plane do not cast shadows. If the zFar value is not set, the far plane is placed automatically.
zNear SFFloat -1 -1 or [0, inf] X3DLightNode Specifies the placement of the near plane of the light projection. Objects that are closer to the light source than the near plane do not cast shadows. If the zNear value is not set, the near plane is placed automatically.