changeset 5914:f87309876fe2

[Doc only] Fix to RT-30404: [FX3D] Need better documentation for the default PointLight Reviewed-by: kcr
author Chien Yang <chien.yang@oracle.com>
date Thu, 05 Dec 2013 22:47:03 -0800
parents 5c12192a7720
children cc52e2bbd227
files modules/graphics/src/main/java/javafx/scene/PointLight.java modules/graphics/src/main/java/javafx/scene/Scene.java modules/graphics/src/main/java/javafx/scene/SubScene.java
diffstat 3 files changed, 11 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/modules/graphics/src/main/java/javafx/scene/PointLight.java	Thu Dec 05 17:19:51 2013 -0500
+++ b/modules/graphics/src/main/java/javafx/scene/PointLight.java	Thu Dec 05 22:47:03 2013 -0800
@@ -30,7 +30,7 @@
 import javafx.scene.paint.Color;
 
 /**
- * Defines a point light source object. An attenuated light source that has a
+ * Defines a point light source object. A light source that has a
  * fixed point in space and radiates light equally in all directions
  * away from itself.
  *
--- a/modules/graphics/src/main/java/javafx/scene/Scene.java	Thu Dec 05 17:19:51 2013 -0500
+++ b/modules/graphics/src/main/java/javafx/scene/Scene.java	Thu Dec 05 22:47:03 2013 -0800
@@ -164,6 +164,11 @@
  * size based on the preferred size of its content. If only one dimension is specified,
  * the other dimension is computed using the specified dimension, respecting content bias
  * of a root.
+ * 
+ * <p>
+ * A default headlight will be added to a scene that contains one or more
+ * {@code Shape3D} nodes, but no light nodes. This light source is a 
+ * {@code Color.WHITE} {@code PointLight} placed at the camera position.
  *
  * <p>
  * Scene objects must be constructed and modified on the
--- a/modules/graphics/src/main/java/javafx/scene/SubScene.java	Thu Dec 05 17:19:51 2013 -0500
+++ b/modules/graphics/src/main/java/javafx/scene/SubScene.java	Thu Dec 05 22:47:03 2013 -0800
@@ -62,6 +62,11 @@
 /**
  * The {@code SubScene} class is the container for content in a scene graph.
  *
+ * <p>
+ * A default headlight will be added to a scene that contains one or more
+ * {@code Shape3D} nodes, but no light nodes. This light source is a 
+ * {@code Color.WHITE} {@code PointLight} placed at the camera position.
+ *
  * @since JavaFX 8.0
  */
 public class SubScene extends Node {