summaryrefslogtreecommitdiff
path: root/indra/llcharacter/llvisualparam.h
blob: 3caddb9c6254a83c2f6d13ea7ef41c0f289e7007 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/**
 * @file llvisualparam.h
 * @brief Implementation of LLPolyMesh class.
 *
 * $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$
 */

#ifndef LL_LLVisualParam_H
#define LL_LLVisualParam_H

#include "v3math.h"
#include "llstring.h"
#include "llxmltree.h"
#include <boost/function.hpp>

class LLPolyMesh;
class LLXmlTreeNode;

enum ESex
{
    SEX_FEMALE =    0x01,
    SEX_MALE =      0x02,
    SEX_BOTH =      0x03  // values chosen to allow use as a bit field.
};

enum EVisualParamGroup
{
    VISUAL_PARAM_GROUP_TWEAKABLE,
    VISUAL_PARAM_GROUP_ANIMATABLE,
    VISUAL_PARAM_GROUP_TWEAKABLE_NO_TRANSMIT,
    VISUAL_PARAM_GROUP_TRANSMIT_NOT_TWEAKABLE, // deprecated params that used to be tweakable.
    NUM_VISUAL_PARAM_GROUPS
};

enum EParamLocation
{
    LOC_UNKNOWN,
    LOC_AV_SELF,
    LOC_AV_OTHER,
    LOC_WEARABLE
};

const std::string param_location_name(const EParamLocation& loc);

const S32 MAX_TRANSMITTED_VISUAL_PARAMS = 255;

//-----------------------------------------------------------------------------
// LLVisualParamInfo
// Contains shared data for VisualParams
//-----------------------------------------------------------------------------
class LLVisualParamInfo
{
    friend class LLVisualParam;
public:
    LLVisualParamInfo();
    virtual ~LLVisualParamInfo() {};

    virtual bool parseXml(LLXmlTreeNode *node);

    S32 getID() const { return mID; }

    virtual void toStream(std::ostream &out);

protected:
    S32                 mID;                // ID associated with VisualParam

    std::string         mName;              // name (for internal purposes)
    std::string         mDisplayName;       // name displayed to the user
    std::string         mMinName;           // name associated with minimum value
    std::string         mMaxName;           // name associated with maximum value
    EVisualParamGroup   mGroup;             // morph group for separating UI controls
    F32                 mMinWeight;         // minimum weight that can be assigned to this morph target
    F32                 mMaxWeight;         // maximum weight that can be assigned to this morph target
    F32                 mDefaultWeight;
    ESex                mSex;               // Which gender(s) this param applies to.
};

//-----------------------------------------------------------------------------
// LLVisualParam
// VIRTUAL CLASS
// An interface class for a generalized parametric modification of the avatar mesh
// Contains data that is specific to each Avatar
//-----------------------------------------------------------------------------
LL_ALIGN_PREFIX(16)
class LLVisualParam
{
public:
    typedef boost::function<LLVisualParam*(S32)> visual_param_mapper;

    LLVisualParam();
    virtual ~LLVisualParam();

    // Special: These functions are overridden by child classes
    // (They can not be virtual because they use specific derived Info classes)
    LLVisualParamInfo*      getInfo() const { return mInfo; }
    //   This sets mInfo and calls initialization functions
    bool                    setInfo(LLVisualParamInfo *info);

    // Virtual functions
    //  Pure virtuals
    //virtual bool          parseData( LLXmlTreeNode *node ) = 0;
    virtual void            apply( ESex avatar_sex ) = 0;
    //  Default functions
    virtual void            setWeight(F32 weight);
    virtual void            setAnimationTarget( F32 target_value);
    virtual void            animate(F32 delta);
    virtual void            stopAnimating();

    virtual bool            linkDrivenParams(visual_param_mapper mapper, bool only_cross_params);
    virtual void            resetDrivenParams();

    // Interface methods
    S32                     getID() const       { return mID; }
    void                    setID(S32 id)       { llassert(!mInfo); mID = id; }

    const std::string&      getName() const             { return mInfo->mName; }
    const std::string&      getDisplayName() const      { return mInfo->mDisplayName; }
    const std::string&      getMaxDisplayName() const   { return mInfo->mMaxName; }
    const std::string&      getMinDisplayName() const   { return mInfo->mMinName; }

    void                    setDisplayName(const std::string& s)     { mInfo->mDisplayName = s; }
    void                    setMaxDisplayName(const std::string& s) { mInfo->mMaxName = s; }
    void                    setMinDisplayName(const std::string& s) { mInfo->mMinName = s; }

    EVisualParamGroup       getGroup() const            { return mInfo->mGroup; }
    F32                     getMinWeight() const        { return mInfo->mMinWeight; }
    F32                     getMaxWeight() const        { return mInfo->mMaxWeight; }
    F32                     getDefaultWeight() const    { return mInfo->mDefaultWeight; }
    ESex                    getSex() const          { return mInfo->mSex; }

    F32                     getWeight() const       { return mIsAnimating ? mTargetWeight : mCurWeight; }
    F32                     getCurrentWeight() const    { return mCurWeight; }
    F32                     getLastWeight() const   { return mLastWeight; }
    void                    setLastWeight(F32 val) { mLastWeight = val; }
    bool                    isAnimating() const { return mIsAnimating; }
    bool                    isTweakable() const { return (getGroup() == VISUAL_PARAM_GROUP_TWEAKABLE)  || (getGroup() == VISUAL_PARAM_GROUP_TWEAKABLE_NO_TRANSMIT); }

    LLVisualParam*          getNextParam()      { return mNext; }
    void                    setNextParam( LLVisualParam *next );
    void                    clearNextParam();

    virtual void            setAnimating(bool is_animating) { mIsAnimating = is_animating && !mIsDummy; }
    bool                    getAnimating() const { return mIsAnimating; }

    void                    setIsDummy(bool is_dummy) { mIsDummy = is_dummy; }

    void                    setParamLocation(EParamLocation loc);
    EParamLocation          getParamLocation() const { return mParamLocation; }

protected:
    LLVisualParam(const LLVisualParam& pOther);

    F32                 mCurWeight;         // current weight
    F32                 mLastWeight;        // last weight
    LLVisualParam*      mNext;              // next param in a shared chain
    F32                 mTargetWeight;      // interpolation target
    bool                mIsAnimating;   // this value has been given an interpolation target
    bool                mIsDummy;  // this is used to prevent dummy visual params from animating


    S32                 mID;                // id for storing weight/morphtarget compares compactly
    LLVisualParamInfo   *mInfo;
    EParamLocation      mParamLocation;     // where does this visual param live?
} LL_ALIGN_POSTFIX(16);

#endif // LL_LLVisualParam_H