path: root/indra/llappearance/llpolyskeletaldistortion.cpp

/**
 * @file llpolyskeletaldistortion.cpp
 * @brief Implementation of LLPolySkeletalDistortion classes
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

//-----------------------------------------------------------------------------
// Header Files
//-----------------------------------------------------------------------------
#include "llpreprocessor.h"
#include "llerror.h"
#include "llavatarappearance.h"
#include "llavatarjoint.h"
#include "llpolymorph.h"
#include "llwearable.h"
#include "llfasttimer.h"
#include "llcallstack.h"

#include "llpolyskeletaldistortion.h"

//-----------------------------------------------------------------------------
// LLPolySkeletalDistortionInfo()
//-----------------------------------------------------------------------------
LLPolySkeletalDistortionInfo::LLPolySkeletalDistortionInfo()
{
}

bool LLPolySkeletalDistortionInfo::parseXml(LLXmlTreeNode* node)
{
        llassert( node->hasName( "param" ) && node->getChildByName( "param_skeleton" ) );

        if (!LLViewerVisualParamInfo::parseXml(node))
                return false;

        LLXmlTreeNode* skeletalParam = node->getChildByName("param_skeleton");

        if (NULL == skeletalParam)
        {
                LL_WARNS() << "Failed to getChildByName(\"param_skeleton\")"
                        << LL_ENDL;
                return false;
        }

        for( LLXmlTreeNode* bone = skeletalParam->getFirstChild(); bone; bone = skeletalParam->getNextChild() )
        {
                if (bone->hasName("bone"))
                {
                        std::string name;
                        LLVector3 scale;
                        LLVector3 pos;
                        bool haspos = false;

                        static LLStdStringHandle name_string = LLXmlTree::addAttributeString("name");
                        if (!bone->getFastAttributeString(name_string, name))
                        {
                                LL_WARNS() << "No bone name specified for skeletal param." << LL_ENDL;
                                continue;
                        }

                        static LLStdStringHandle scale_string = LLXmlTree::addAttributeString("scale");
                        if (!bone->getFastAttributeVector3(scale_string, scale))
                        {
                                LL_WARNS() << "No scale specified for bone " << name << "." << LL_ENDL;
                                continue;
                        }

                        // optional offset deformation (translation)
                        static LLStdStringHandle offset_string = LLXmlTree::addAttributeString("offset");
                        if (bone->getFastAttributeVector3(offset_string, pos))
                        {
                                haspos = true;
                        }
                        mBoneInfoList.push_back(LLPolySkeletalBoneInfo(name, scale, pos, haspos));
                }
                else
                {
                        LL_WARNS() << "Unrecognized element " << bone->getName() << " in skeletal distortion" << LL_ENDL;
                        continue;
                }
        }
        return true;
}

//-----------------------------------------------------------------------------
// LLPolySkeletalDistortion()
//-----------------------------------------------------------------------------
LLPolySkeletalDistortion::LLPolySkeletalDistortion(LLAvatarAppearance *avatarp)
    : LLViewerVisualParam(),
    mDefaultVec(),
    mJointScales(),
    mJointOffsets(),
    mAvatar(avatarp)
{
    mDefaultVec.splat(0.001f);
}

//-----------------------------------------------------------------------------
// LLPolySkeletalDistortion()
//-----------------------------------------------------------------------------
LLPolySkeletalDistortion::LLPolySkeletalDistortion(const LLPolySkeletalDistortion &pOther)
    : LLViewerVisualParam(pOther),
    mDefaultVec(pOther.mDefaultVec),
    mJointScales(pOther.mJointScales),
    mJointOffsets(pOther.mJointOffsets),
    mAvatar(pOther.mAvatar)
{
}

//-----------------------------------------------------------------------------
// ~LLPolySkeletalDistortion()
//-----------------------------------------------------------------------------
LLPolySkeletalDistortion::~LLPolySkeletalDistortion()
{
}

bool LLPolySkeletalDistortion::setInfo(LLPolySkeletalDistortionInfo *info)
{
    if (info->mID < 0)
    {
        return false;
    }
    mInfo = info;
    mID = info->mID;
    setWeight(getDefaultWeight());

    for (LLPolySkeletalBoneInfo& bone_info : getInfo()->mBoneInfoList)
    {
        LLJoint* joint = mAvatar->getJoint(bone_info.mBoneName);
        if (!joint)
        {
            // There's no point continuing after this error - means
            // that either the skeleton or lad file is broken.
            LL_WARNS() << "Joint " << bone_info.mBoneName << " not found." << LL_ENDL;
            return false;
        }

        // store it
        mJointScales[joint] = bone_info.mScaleDeformation;

        // apply to children that need to inherit it
        for (LLJoint* joint : joint->mChildren)
        {
            LLAvatarJoint* child_joint = (LLAvatarJoint*)joint;
            if (child_joint->inheritScale())
            {
                LLVector3 childDeformation = LLVector3(child_joint->getScale());
                childDeformation.scaleVec(bone_info.mScaleDeformation);
                mJointScales[child_joint] = childDeformation;
            }
        }

        if (bone_info.mHasPositionDeformation)
        {
            mJointOffsets[joint] = bone_info.mPositionDeformation;
        }
    }
    return true;
}

/*virtual*/ LLViewerVisualParam* LLPolySkeletalDistortion::cloneParam(LLWearable* wearable) const
{
    return new LLPolySkeletalDistortion(*this);
}

//-----------------------------------------------------------------------------
// apply()
//-----------------------------------------------------------------------------
void LLPolySkeletalDistortion::apply( ESex avatar_sex )
{
    LL_PROFILE_ZONE_SCOPED;

    F32 effective_weight = ( getSex() & avatar_sex ) ? mCurWeight : getDefaultWeight();

    LLJoint* joint;

    for (joint_vec_map_t::value_type& scale_pair : mJointScales)
    {
        joint = scale_pair.first;
        LLVector3 newScale = joint->getScale();
        LLVector3 scaleDelta = scale_pair.second;
        LLVector3 offset = (effective_weight - mLastWeight) * scaleDelta;
        newScale = newScale + offset;
        //An aspect of attached mesh objects (which contain joint offsets) that need to be cleaned up when detached
        // needed?
        // joint->storeScaleForReset( newScale );

        // BENTO for detailed stack tracing of params.
        std::stringstream ostr;
        ostr << "LLPolySkeletalDistortion::apply, id " << getID() << " " << getName() << " effective wt " << effective_weight << " last wt " << mLastWeight << " scaleDelta " << scaleDelta << " offset " << offset;
        LLScopedContextString str(ostr.str());

        joint->setScale(newScale, true);
    }

    for (joint_vec_map_t::value_type& offset_pair : mJointOffsets)
    {
        joint = offset_pair.first;
        LLVector3 newPosition = joint->getPosition();
        LLVector3 positionDelta = offset_pair.second;
        newPosition = newPosition + (effective_weight * positionDelta) - (mLastWeight * positionDelta);
        // SL-315
        bool allow_attachment_pos_overrides = true;
        joint->setPosition(newPosition, allow_attachment_pos_overrides);
    }

    if (mLastWeight != effective_weight && !mIsAnimating)
    {
        mAvatar->setSkeletonSerialNum(mAvatar->getSkeletonSerialNum() + 1);
    }
    mLastWeight = effective_weight;
}


LLPolyMorphData *clone_morph_param_duplicate(const LLPolyMorphData *src_data,
                         const std::string &name)
{
        LLPolyMorphData* cloned_morph_data = new LLPolyMorphData(*src_data);
        cloned_morph_data->mName = name;
        for (U32 v=0; v < cloned_morph_data->mNumIndices; v++)
        {
                cloned_morph_data->mCoords[v] = src_data->mCoords[v];
                cloned_morph_data->mNormals[v] = src_data->mNormals[v];
                cloned_morph_data->mBinormals[v] = src_data->mBinormals[v];
        }
        return cloned_morph_data;
}

LLPolyMorphData *clone_morph_param_direction(const LLPolyMorphData *src_data,
                         const LLVector3 &direction,
                         const std::string &name)
{
        LLPolyMorphData* cloned_morph_data = new LLPolyMorphData(*src_data);
        cloned_morph_data->mName = name;
        LLVector4a dir;
        dir.load3(direction.mV);

        for (U32 v=0; v < cloned_morph_data->mNumIndices; v++)
        {
                cloned_morph_data->mCoords[v] = dir;
                cloned_morph_data->mNormals[v].clear();
                cloned_morph_data->mBinormals[v].clear();
        }
        return cloned_morph_data;
}

LLPolyMorphData *clone_morph_param_cleavage(const LLPolyMorphData *src_data,
                                            F32 scale,
                                            const std::string &name)
{
        LLPolyMorphData* cloned_morph_data = new LLPolyMorphData(*src_data);
        cloned_morph_data->mName = name;

        LLVector4a sc;
        sc.splat(scale);

        LLVector4a nsc;
        nsc.set(scale, -scale, scale, scale);

        for (U32 v=0; v < cloned_morph_data->mNumIndices; v++)
        {
            if (cloned_morph_data->mCoords[v][1] < 0)
            {
                cloned_morph_data->mCoords[v].setMul(src_data->mCoords[v],nsc);
                cloned_morph_data->mNormals[v].setMul(src_data->mNormals[v],nsc);
                cloned_morph_data->mBinormals[v].setMul(src_data->mBinormals[v],nsc);
            }
            else
            {
                cloned_morph_data->mCoords[v].setMul(src_data->mCoords[v],sc);
                cloned_morph_data->mNormals[v].setMul(src_data->mNormals[v], sc);
                cloned_morph_data->mBinormals[v].setMul(src_data->mBinormals[v],sc);
            }
        }
        return cloned_morph_data;
}

// End