From 41c7718659e4455984db3d40cc63a00aaeb80405 Mon Sep 17 00:00:00 2001
From: Angeldark Raymaker <dark.angel_raven@yahoo.com.au>
Date: Sat, 21 Sep 2024 09:03:18 +0100
Subject: [PATCH] FIRE-30873: First pass at refactoring for safer avatar usage

will certainly need a revisit
---
 indra/newview/fsposeranimator.cpp | 43 ++++++++++++++++++++++---------
 indra/newview/fsposeranimator.h   | 13 ++++++++++
 2 files changed, 44 insertions(+), 12 deletions(-)

diff --git a/indra/newview/fsposeranimator.cpp b/indra/newview/fsposeranimator.cpp
index d43cc631ea..9855f12495 100644
--- a/indra/newview/fsposeranimator.cpp
+++ b/indra/newview/fsposeranimator.cpp
@@ -43,7 +43,7 @@ FSPoserAnimator::~FSPoserAnimator() {}
 
 bool FSPoserAnimator::isPosingAvatarJoint(LLVOAvatar *avatar, FSPoserJoint joint)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return false;
 
     BDPosingMotion *motion = (BDPosingMotion *) avatar->findMotion(ANIM_BD_POSING_MOTION);
@@ -59,7 +59,7 @@ bool FSPoserAnimator::isPosingAvatarJoint(LLVOAvatar *avatar, FSPoserJoint joint
 
 void FSPoserAnimator::setPosingAvatarJoint(LLVOAvatar *avatar, FSPoserJoint joint, bool shouldPose)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
 
     bool arePosing = isPosingAvatarJoint(avatar, joint);
@@ -82,7 +82,7 @@ void FSPoserAnimator::setPosingAvatarJoint(LLVOAvatar *avatar, FSPoserJoint join
 
 void FSPoserAnimator::resetAvatarJoint(LLVOAvatar *avatar, FSPoserJoint joint)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
 
     BDPosingMotion *motion = (BDPosingMotion *) avatar->findMotion(ANIM_BD_POSING_MOTION);
@@ -99,7 +99,7 @@ void FSPoserAnimator::resetAvatarJoint(LLVOAvatar *avatar, FSPoserJoint joint)
 LLVector3 FSPoserAnimator::getJointPosition(LLVOAvatar *avatar, FSPoserJoint joint)
 {
     LLVector3 pos;
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return pos;
 
     LLJoint *avJoint = gAgentAvatarp->getJoint(JointKey::construct(joint.jointName()));
@@ -113,7 +113,7 @@ LLVector3 FSPoserAnimator::getJointPosition(LLVOAvatar *avatar, FSPoserJoint joi
 
 void FSPoserAnimator::setJointPosition(LLVOAvatar *avatar, const FSPoserJoint *joint, LLVector3 position, E_BoneDeflectionStyles style)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
     if (!joint)
         return;
@@ -133,7 +133,7 @@ void FSPoserAnimator::setJointPosition(LLVOAvatar *avatar, const FSPoserJoint *j
 LLVector3 FSPoserAnimator::getJointRotation(LLVOAvatar *avatar, FSPoserJoint joint, E_BoneAxisTranslation translation, S32 negation, bool forRecapture)
 {
     LLVector3 vec3;
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return vec3;
 
     LLJoint  *avJoint = avatar->getJoint(JointKey::construct(joint.jointName()));
@@ -148,7 +148,7 @@ LLVector3 FSPoserAnimator::getJointRotation(LLVOAvatar *avatar, FSPoserJoint joi
 void FSPoserAnimator::setJointRotation(LLVOAvatar *avatar, const FSPoserJoint *joint, LLVector3 rotation, E_BoneDeflectionStyles style,
                                        E_BoneAxisTranslation translation, S32 negation)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
     if (!joint)
         return;
@@ -186,7 +186,7 @@ void FSPoserAnimator::setJointRotation(LLVOAvatar *avatar, const FSPoserJoint *j
 
 void FSPoserAnimator::reflectJoint(LLVOAvatar *avatar, const FSPoserJoint *joint)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
 
     if (!joint)
@@ -216,7 +216,7 @@ void FSPoserAnimator::reflectJoint(LLVOAvatar *avatar, const FSPoserJoint *joint
 
 void FSPoserAnimator::flipEntirePose(LLVOAvatar *avatar)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
 
     for (size_t index = 0; index != PoserJoints.size(); ++index)
@@ -362,7 +362,7 @@ LLVector3 FSPoserAnimator::getJointScale(LLVOAvatar *avatar, FSPoserJoint joint)
 
 void FSPoserAnimator::setJointScale(LLVOAvatar *avatar, const FSPoserJoint *joint, LLVector3 scale, E_BoneDeflectionStyles style)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return;
     if (!joint)
         return;
@@ -387,7 +387,7 @@ const FSPoserAnimator::FSPoserJoint* FSPoserAnimator::getPoserJointByName(std::s
 
 bool FSPoserAnimator::tryPosingAvatar(LLVOAvatar *avatar)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return false;
 
     if (avatar->getPosing())
@@ -423,7 +423,7 @@ void FSPoserAnimator::stopPosingAvatar(LLVOAvatar *avatar)
 
 bool FSPoserAnimator::isPosingAvatar(LLVOAvatar* avatar)
 {
-    if (!avatar || avatar->isDead())
+    if (!isAvatarSafeToUse(avatar))
         return false;
 
     if (!avatar->getPosing())
@@ -436,3 +436,22 @@ bool FSPoserAnimator::isPosingAvatar(LLVOAvatar* avatar)
     return !motion->isStopped();
 }
 
+bool FSPoserAnimator::isAvatarSafeToUse(LLVOAvatar *avatar)
+{
+    try // I can't figure this out
+    {
+        if (!avatar)
+            return false;
+        if (avatar->isDead())
+            return false;
+        if (avatar->getRegion() != gAgent.getRegion())
+            return false;
+    }
+    catch (...)
+    {
+        return false;
+    }
+
+    return true;
+}
+
diff --git a/indra/newview/fsposeranimator.h b/indra/newview/fsposeranimator.h
index 7ff1760a1e..33746e1329 100644
--- a/indra/newview/fsposeranimator.h
+++ b/indra/newview/fsposeranimator.h
@@ -72,6 +72,11 @@ typedef enum E_BoneAxisTranslation
     SWAP_X2Z_Y2X_Z2Y    = 5,
 } E_BoneAxisTranslation;
 
+/// <summary>
+/// Similar to translating axes from LLJoint rotations to UI sliders for up/down/left/right, these
+/// negate (multiply by -1) axial changes.
+/// This makes using the trackpad more 'natural' when manipulating a joint.
+/// </summary>
 typedef enum E_BoneAxisNegation
 {
     NEGATE_NOTHING = 0,
@@ -335,6 +340,14 @@ public:
     /// <param name="rotation">The rotation to transform to matrix.</param>
     /// <returns>The rotation vector.</returns>
     LLVector3 translateRotationFromQuaternion(E_BoneAxisTranslation translation, S32 negation, LLQuaternion rotation);
+
+    /// <summary>
+    /// Determines if the avatar can be used.
+    /// try catch needs work.
+    /// </summary>
+    /// <param name="avatar"></param>
+    /// <returns></returns>
+    bool isAvatarSafeToUse(LLVOAvatar *avatar);
 };
 
 #endif // LL_FSPoserAnimator_H