Explorar o código

BlendSpace.java: decomposed notes at the class-entry from the blend weight values meaning

Pavly Gerges (pavl_g) hai 6 meses
pai
achega
adf1147858

+ 9 - 3
jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java

@@ -36,7 +36,7 @@ package com.jme3.anim.tween.action;
  * The blending weight is a read-only value, and it can be manipulated using the arbitrary value {@link BlendSpace#setValue(float)} during the application runtime.
  * 
  * <p>
- * Notes:
+ * Notes about the blending action and its relations with the blending weight:
  * <ul>
  * <li> Blending is the action of mixing between 2 successive animation {@link BlendableAction}s by interpolating their transforms and 
  * then applying the result on the assigned {@link HasLocalTransform} object, the {@link BlendSpace} provides this blending action with a blend weight value. </li>
@@ -52,11 +52,17 @@ package com.jme3.anim.tween.action;
  * a blend value of 1 and the second action will use the blend space weight as a value for the interpolation. </li>
  * <li> In case of (Blending weight = 0), the blending hasn't started yet, only the first action will be interpolated at (weight = 1). </li>
  * <li> In case of (Blending weight = 1), the blending is finished and only the second action will continue to run at (weight = 1). </li>
- * <li> Negative values and values greater than 1 aren't allowed (i.e., extrapolations aren't allowed). </li>
- * <li> Find more at {@link BlendAction#doInterpolate(double)} and {@link BlendAction#collectTransform(HasLocalTransform, Transform, float, BlendableAction)}. </li>
  * </ul>
  * </p>
  * 
+ * <p>
+ * Notes about the blending weight value:
+ * <ul>
+ * <li> Negative values and values greater than 1 aren't allowed (i.e., extrapolations aren't allowed). </li>
+ * <li> For more details, see {@link BlendAction#doInterpolate(double)} and {@link BlendAction#collectTransform(HasLocalTransform, Transform, float, BlendableAction)}. </li>
+ * </ul>
+ * </p> 
+ *
  * Created by Nehon.
  * @see LinearBlendSpace an example of blendspace implementation
  */