official documentation

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

Class: PointLight

X3D: 3.3
Component: Lighting
Status:
fully implemented

Quick Links

➨ Fields
➨ Properties

.nodeTypes. PointLight

The PointLight node specifies a point light source at a 3D location in the local coordinate system. A point light source emits light equally in all directions; that is, it is omnidirectional. PointLight nodes are specified in the local coordinate system and are affected by ancestor transformations.

HTML Encoding and Default Values⤴

<PointLight ambientIntensity='0' attenuation='1,0,0' color='1,1,1' global='false' intensity='1' location='0,0,0' metadata='X3DMetadataObject' on='true' radius='100' shadowFilterSize='0' shadowIntensity='0' shadowMapSize='1024' shadowOffset='0' zFar='-1' zNear='-1' ></PointLight>

Inheritance⤴


Constructor⤴

PointLight(ctx)⤴

Constructor for PointLight

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).
attenuation SFVec3f 1,0,0 PointLight node's illumination falls off with distance as specified by three attenuation coefficients. The attenuation factor is: 1/max(attenuation[0] + attenuation[1] × r + attenuation[2] × r^2, 1) where r is the distance from the light to the surface being illuminated. The default is no attenuation. An attenuation value of (0, 0, 0) is identical to (1, 0, 0). Attenuation values shall be greater than or equal to zero.
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.
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).
location SFVec3f 0,0,0 The position of the Light
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
on SFBool true X3DLightNode The on field specifies whether the light is enabled or disabled.
radius SFFloat 100 A PointLight node illuminates geometry within radius length base units of its location. Radius is affected by ancestors' transformations.
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.
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.