Class: X3DLightNode

X3D: 3.3
Component: Lighting
Status:
fully implemented

x3dom.nodeTypes. X3DLightNode

The X3DLightNode abstract node type is the base type from which all node types that serve as light sources are derived.

HTML Encoding and Default Values

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

Inheritance


Constructor

X3DLightNode(ctx)

Constructor for X3DLightNode

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] 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] The color field specifies the spectral colour properties of both the direct and ambient light emission as an RGB value.
global SFBool false 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] 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 X3DChildNode Field to add metadata information
on SFBool true The on field specifies whether the light is enabled or disabled.
shadowFilterSize SFInt32 0 Sets the smoothness of the shadow umbra.
shadowIntensity SFFloat 0 [o, 1] Defines the attenuation of the shadows
shadowMapSize SFInt32 1024 [0, inf] Specifies the resolution of the used shadow map.
shadowOffset SFFloat 0 Defines the shadow offset for the back projection of the shadow map.
zFar SFFloat -1 -1 or [0, inf] 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] 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.


Properties

Access Name Type Inheritance Description
lightID Static class ID counter (needed for flash performance up)