From b03dec8be3959153ce678da8fea7ae2756f01835 Mon Sep 17 00:00:00 2001
From: "Pavly Gerges (pavl_g)" <60224159+pavly-gerges@users.noreply.github.com>
Date: Sun, 16 Feb 2025 19:10:12 +0200
Subject: [PATCH] BlendSpace: re-enforcements at the class-entry docs
---
.../java/com/jme3/anim/tween/action/BlendSpace.java | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java b/jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java
index b469097d05..60832c33c3 100644
--- a/jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java
+++ b/jme3-core/src/main/java/com/jme3/anim/tween/action/BlendSpace.java
@@ -33,24 +33,28 @@
/**
* A provider interface which provides a value {@link BlendSpace#getWeight()} to control the blending between 2 successive actions in a {@link BlendAction}.
- * The blending weight is a read-only value, and it's manipulatable using the arbitrary value {@link BlendSpace#setValue(float)} during the application runtime.
+ * 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.
*
*
* Notes:
+ *
* - 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.
* - The blend weight is the value for the interpolation for the target transforms.
* - The blend weight value must be in this interval [0, 1].
+ *
*
*
*
* Different blending weight case scenarios managed by {@link BlendAction} internally:
+ *
* - In case of (0 < Blending weight < 1), the blending is executed each update among 2 actions, the first action will use
* a blend value of 1 and the second action will use the blend space weight as a value for the interpolation.
* - In case of (Blending weight = 0), the blending hasn't started yet, only the first action will be interpolated at (weight = 1).
* - In case of (Blending weight = 1), the blending is finished and only the second action will continue to run at (weight = 1).
- * - Negative values and values greater than 1 aren't allowed (extrapolations aren't allowed).
+ * - Negative values and values greater than 1 aren't allowed (i.e., extrapolations aren't allowed).
* - Find more at {@link BlendAction#doInterpolate(double)} and {@link BlendAction#collectTransform(HasLocalTransform, Transform, float, BlendableAction)}.
+ *
*
*
* Created by Nehon.
@@ -67,7 +71,7 @@ public interface BlendSpace {
/**
* Provides the blend weight value to the assigned {@link BlendAction} instance,
- * this value will be used for interpolating a collection of actions' transformations (keyframes).
+ * this value will be used for interpolating a collection of actions' transformations (i.e., keyframes).
*
* @return the blending weight value in the range from 0 to 1,
* negative values and values above 1 aren't allowed.