Package org.web3d.x3d.sai.Lighting
Interface EnvironmentLight
- All Superinterfaces:
X3DChildNode
,X3DLightNode
,X3DNode
- All Known Implementing Classes:
EnvironmentLight
TODO add contained nodes.
X3D node tooltip: (X3D version 4.0 draft) [X3DLightNode] EnvironmentLight defines image-based lighting (IBL). Lights have no visible shape themselves and lighting effects continue through any intermediate geometry.
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
X3D node tooltip: (X3D version 4.0 draft) [X3DLightNode] EnvironmentLight defines image-based lighting (IBL). Lights have no visible shape themselves and lighting effects continue through any intermediate geometry.
- Hint: the bound NavigationInfo controls whether headlight is enabled on/off. TODO add contained nodes.
- Hint: Wikipedia Cube mapping https://en.wikipedia.org/wiki/Cube_mapping
Package hint: This interface is defined by the X3D Java Language Binding Specification for the Scene Authoring Interface (SAI).
-
Method Summary
Modifier and TypeMethodDescriptionfloat
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.float[]
getColor()
Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field diffuse.float[]
Provide array of float results from inputOutput MFFloat field named diffuseCoefficients.Provide org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) from inputOutput SFNode field diffuseTexture.boolean
Provide boolean value from inputOutput SFBool field named global.float
Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.boolean
getOn()
Provide boolean value from inputOutput SFBool field named on.float[]
Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.float
Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.boolean
Provide boolean value from inputOutput SFBool field named shadows.Provide org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) from inputOutput SFNode field specularTexture.setAmbientIntensity
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.setColor
(float[] newValue) Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.setDiffuse
(X3DSingleTextureNode newValue) Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field diffuse.setDiffuseCoefficients
(float[] newValue) Accessor method to assign float array to inputOutput MFFloat field named diffuseCoefficients.setDiffuseTexture
(X3DEnvironmentTextureNode newValue) Accessor method to assign org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) to inputOutput SFNode field diffuseTexture.setGlobal
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named global.setIntensity
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named intensity.setMetadata
(X3DMetadataObject newValue) Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.setOn
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named on.setRotation
(float[] newValue) Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.setShadowIntensity
(float newValue) Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.setShadows
(boolean newValue) Accessor method to assign boolean value to inputOutput SFBool field named shadows.setSpecularTexture
(X3DEnvironmentTextureNode newValue) Accessor method to assign org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) to inputOutput SFNode field specularTexture.
-
Method Details
-
getAmbientIntensity
float getAmbientIntensity()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named ambientIntensity.
Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
getAmbientIntensity
in interfaceX3DLightNode
- Returns:
- value of ambientIntensity field
-
setAmbientIntensity
Accessor method to assign float value to inputOutput SFFloat field named ambientIntensity.
Tooltip: [0,1] Brightness of ambient (nondirectional background) emission from the light. Interchange profile hint: this field may be ignored, applying the default value regardless. *- Specified by:
setAmbientIntensity
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the ambientIntensity field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getColor
float[] getColor()Provide array of 3-tuple float results using RGB values [0..1] using RGB values [0..1] from inputOutput SFColor field named color.
Tooltip: [0,1] color of light, applied to colors of objects.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
getColor
in interfaceX3DLightNode
- Returns:
- value of color field
-
setColor
Accessor method to assign 3-tuple float array using RGB values [0..1] to inputOutput SFColor field named color.
Tooltip: [0,1] color of light, applied to colors of objects.- Hint: X3D Scene Authoring Hints, Color https://www.web3d.org/x3d/content/examples/X3dSceneAuthoringHints.html#Color
- Specified by:
setColor
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the color field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDiffuse
X3DSingleTextureNode getDiffuse()Provide org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) from inputOutput SFNode field diffuse.
Tooltip: [X3DSingleTextureNode] When applying diffuseColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='diffuse'.
- Returns:
- value of diffuse field
-
setDiffuse
Accessor method to assign org.web3d.x3d.sai.Texturing.X3DSingleTextureNode instance (using a properly typed node) to inputOutput SFNode field diffuse.
Tooltip: [X3DSingleTextureNode] When applying diffuseColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='diffuse'.
- Parameters:
newValue
- is new value for the diffuse field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDiffuseCoefficients
float[] getDiffuseCoefficients()Provide array of float results from inputOutput MFFloat field named diffuseCoefficients.
Tooltip: diffuseCoefficients field provides a 3 x 9 array of float values that declares spherical harmonic coefficients for irradiance up to l=2, corresponding to glTF irradianceCoefficients field.- Hint: the diffuseCoefficients field overrides the diffuseTexture field if both are provided.
- Returns:
- value of diffuseCoefficients field
-
setDiffuseCoefficients
Accessor method to assign float array to inputOutput MFFloat field named diffuseCoefficients.
Tooltip: diffuseCoefficients field provides a 3 x 9 array of float values that declares spherical harmonic coefficients for irradiance up to l=2, corresponding to glTF irradianceCoefficients field.- Hint: the diffuseCoefficients field overrides the diffuseTexture field if both are provided.
- Parameters:
newValue
- is new value for the diffuseCoefficients field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getDiffuseTexture
X3DEnvironmentTextureNode getDiffuseTexture()Provide org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) from inputOutput SFNode field diffuseTexture.
Tooltip: [X3DEnvironmentTextureNode] When applying diffuseColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='diffuseTexture'
- Hint: the diffuseCoefficients field overrides the diffuseTexture field if both are provided.
- Returns:
- value of diffuseTexture field
-
setDiffuseTexture
Accessor method to assign org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) to inputOutput SFNode field diffuseTexture.
Tooltip: [X3DEnvironmentTextureNode] When applying diffuseColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='diffuseTexture'
- Hint: the diffuseCoefficients field overrides the diffuseTexture field if both are provided.
- Parameters:
newValue
- is new value for the diffuseTexture field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getGlobal
boolean getGlobal()Provide boolean value from inputOutput SFBool field named global.
Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy.- Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
- Returns:
- value of global field
-
setGlobal
Accessor method to assign boolean value to inputOutput SFBool field named global.
Tooltip: Global lights illuminate all objects within their volume of lighting influence. Scoped lights only illuminate objects within the same transformation hierarchy.- Warning: DirectionalLight default global=false to limit scope and avoid inadvertently illuminating every object in a large scene. PointLight and SpotLight default global=true since their effects are each limited by maximum radius value.
- Parameters:
newValue
- is new value for the global field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getIntensity
float getIntensity()Provide float value within allowed range of [0,infinity) from inputOutput SFFloat field named intensity.
Tooltip: [0,+infinity] Brightness of direct emission from the light. *- Specified by:
getIntensity
in interfaceX3DLightNode
- Returns:
- value of intensity field
-
setIntensity
Accessor method to assign float value to inputOutput SFFloat field named intensity.
Tooltip: [0,+infinity] Brightness of direct emission from the light. *- Specified by:
setIntensity
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the intensity field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getMetadata
X3DMetadataObject getMetadata()Provide org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) from inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
- Specified by:
getMetadata
in interfaceX3DChildNode
- Specified by:
getMetadata
in interfaceX3DLightNode
- Specified by:
getMetadata
in interfaceX3DNode
- Returns:
- value of metadata field
- See Also:
-
setMetadata
Accessor method to assign org.web3d.x3d.sai.Core.X3DMetadataObject instance (using a properly typed node) to inputOutput SFNode field metadata.
Tooltip: [X3DMetadataObject] Information about this node can be contained in a MetadataBoolean, MetadataDouble, MetadataFloat, MetadataInteger, MetadataString or MetadataSet node.- Hint: X3D Architecture 7.2.4 Metadata https://www.web3d.org/specifications/X3Dv4Draft/ISO-IEC19775-1v4-CD1/Part01/components/core.html#Metadata
- Specified by:
setMetadata
in interfaceX3DChildNode
- Specified by:
setMetadata
in interfaceX3DLightNode
- Specified by:
setMetadata
in interfaceX3DNode
- Parameters:
newValue
- is new value for the metadata field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).- See Also:
-
getOn
boolean getOn()Provide boolean value from inputOutput SFBool field named on.
Tooltip: Enables/disables this light source. *- Specified by:
getOn
in interfaceX3DLightNode
- Returns:
- value of on field
-
setOn
Accessor method to assign boolean value to inputOutput SFBool field named on.
Tooltip: Enables/disables this light source. *- Specified by:
setOn
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the on field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getRotation
float[] getRotation()Provide array of 4-tuple float results unit axis, angle (in radians) from inputOutput SFRotation field named rotation.
Tooltip: Orientation (axis, angle in radians) of light rotation relative to local coordinate system. *- Returns:
- value of rotation field
-
setRotation
Accessor method to assign 4-tuple float array unit axis, angle (in radians) to inputOutput SFRotation field named rotation.
Tooltip: Orientation (axis, angle in radians) of light rotation relative to local coordinate system. *- Parameters:
newValue
- is new value for the rotation field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getShadowIntensity
float getShadowIntensity()Provide float value within allowed range of [0,1] from inputOutput SFFloat field named shadowIntensity.
Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *- Specified by:
getShadowIntensity
in interfaceX3DLightNode
- Returns:
- value of shadowIntensity field
-
setShadowIntensity
Accessor method to assign float value to inputOutput SFFloat field named shadowIntensity.
Tooltip: [0,1] shadowIntensity field defines how much light is obscured by shapes that cast shadows, ranging from 0 (light not obscured, no visible shadows) to 1 (light completely obscured, full-intensity shadows). *- Specified by:
setShadowIntensity
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the shadowIntensity field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getShadows
boolean getShadows()Provide boolean value from inputOutput SFBool field named shadows.
Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *- Specified by:
getShadows
in interfaceX3DLightNode
- Returns:
- value of shadows field
-
setShadows
Accessor method to assign boolean value to inputOutput SFBool field named shadows.
Tooltip: shadows field indicates whether or not this light casts a shadow behind illuminated X3DShapeNode geometry. *- Specified by:
setShadows
in interfaceX3DLightNode
- Parameters:
newValue
- is new value for the shadows field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-
getSpecularTexture
X3DEnvironmentTextureNode getSpecularTexture()Provide org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) from inputOutput SFNode field specularTexture.
Tooltip: [X3DEnvironmentTextureNode] When applying specularColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='specularTexture'.
- Returns:
- value of specularTexture field
-
setSpecularTexture
Accessor method to assign org.web3d.x3d.sai.CubeMapTexturing.X3DEnvironmentTextureNode instance (using a properly typed node) to inputOutput SFNode field specularTexture.
Tooltip: [X3DEnvironmentTextureNode] When applying specularColor for this light node, the contained texture provides Physically Based Rendering (PBR) modulation for each pixel.- Hint: if texture node is NULL or unspecified, no effect is applied to material values.
- Hint: contained texture node must include containerField='specularTexture'.
- Parameters:
newValue
- is new value for the specularTexture field.- Returns:
EnvironmentLight
- namely this same object to allow sequential method pipelining (i.e. consecutive method invocations on the same object).
-