summaryrefslogtreecommitdiff
path: root/indra/llappearance/llavatarappearancedefines.h
blob: 414bf8bbc1734d767fdc89eb59f2870326771683 (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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/**
 * @file llavatarappearancedefines.h
 * @brief Various LLAvatarAppearance related definitions
 * LLViewerObject
 *
 * $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_AVATARAPPEARANCE_DEFINES_H
#define LL_AVATARAPPEARANCE_DEFINES_H

#include <vector>
#include "lljointpickname.h"
#include "lldictionary.h"
#include "llwearabletype.h"
#include "lluuid.h"

namespace LLAvatarAppearanceDefines
{

extern const S32 SCRATCH_TEX_WIDTH;
extern const S32 SCRATCH_TEX_HEIGHT;

static const U32 AVATAR_HOVER = 11001;

//--------------------------------------------------------------------
// Enums
//--------------------------------------------------------------------
enum ETextureIndex
{
    TEX_INVALID = -1,
    TEX_HEAD_BODYPAINT = 0,
    TEX_UPPER_SHIRT,
    TEX_LOWER_PANTS,
    TEX_EYES_IRIS,
    TEX_HAIR,
    TEX_UPPER_BODYPAINT,
    TEX_LOWER_BODYPAINT,
    TEX_LOWER_SHOES,
    TEX_HEAD_BAKED,     // Pre-composited
    TEX_UPPER_BAKED,    // Pre-composited
    TEX_LOWER_BAKED,    // Pre-composited
    TEX_EYES_BAKED,     // Pre-composited
    TEX_LOWER_SOCKS,
    TEX_UPPER_JACKET,
    TEX_LOWER_JACKET,
    TEX_UPPER_GLOVES,
    TEX_UPPER_UNDERSHIRT,
    TEX_LOWER_UNDERPANTS,
    TEX_SKIRT,
    TEX_SKIRT_BAKED,    // Pre-composited
    TEX_HAIR_BAKED,     // Pre-composited
    TEX_LOWER_ALPHA,
    TEX_UPPER_ALPHA,
    TEX_HEAD_ALPHA,
    TEX_EYES_ALPHA,
    TEX_HAIR_ALPHA,
    TEX_HEAD_TATTOO,
    TEX_UPPER_TATTOO,
    TEX_LOWER_TATTOO,
    TEX_HEAD_UNIVERSAL_TATTOO,
    TEX_UPPER_UNIVERSAL_TATTOO,
    TEX_LOWER_UNIVERSAL_TATTOO,
    TEX_SKIRT_TATTOO,
    TEX_HAIR_TATTOO,
    TEX_EYES_TATTOO,
    TEX_LEFT_ARM_TATTOO,
    TEX_LEFT_LEG_TATTOO,
    TEX_AUX1_TATTOO,
    TEX_AUX2_TATTOO,
    TEX_AUX3_TATTOO,
    TEX_LEFT_ARM_BAKED,      // Pre-composited
    TEX_LEFT_LEG_BAKED,     // Pre-composited
    TEX_AUX1_BAKED,          // Pre-composited
    TEX_AUX2_BAKED,          // Pre-composited
    TEX_AUX3_BAKED,          // Pre-composited
    TEX_NUM_INDICES
};

enum EBakedTextureIndex
{
    BAKED_HEAD = 0,
    BAKED_UPPER,
    BAKED_LOWER,
    BAKED_EYES,
    BAKED_SKIRT,
    BAKED_HAIR,
    BAKED_LEFT_ARM,
    BAKED_LEFT_LEG,
    BAKED_AUX1,
    BAKED_AUX2,
    BAKED_AUX3,
    BAKED_NUM_INDICES
};

// Reference IDs for each mesh. Used as indices for vector of joints
enum EMeshIndex
{
    MESH_ID_HAIR = 0,
    MESH_ID_HEAD,
    MESH_ID_EYELASH,
    MESH_ID_UPPER_BODY,
    MESH_ID_LOWER_BODY,
    MESH_ID_EYEBALL_LEFT,
    MESH_ID_EYEBALL_RIGHT,
    MESH_ID_SKIRT,
    MESH_ID_NUM_INDICES
};

//--------------------------------------------------------------------
// Vector Types
//--------------------------------------------------------------------
typedef std::vector<ETextureIndex> texture_vec_t;
typedef std::vector<EBakedTextureIndex> bakedtexture_vec_t;
typedef std::vector<EMeshIndex> mesh_vec_t;
typedef std::vector<LLWearableType::EType> wearables_vec_t;

//------------------------------------------------------------------------
// LLAvatarAppearanceDictionary
//
// Holds dictionary static entries for textures, baked textures, meshes, etc.; i.e.
// information that is common to all avatars.
//
// This holds const data - it is initialized once and the contents never change after that.
//------------------------------------------------------------------------
class LLAvatarAppearanceDictionary
{
    //--------------------------------------------------------------------
    // Constructors and Destructors
    //--------------------------------------------------------------------
public:
    LLAvatarAppearanceDictionary();
    ~LLAvatarAppearanceDictionary();
private:
    void createAssociations();

    //--------------------------------------------------------------------
    // Local and baked textures
    //--------------------------------------------------------------------
public:
    struct TextureEntry : public LLDictionaryEntry
    {
        TextureEntry(const std::string &name, // this must match the xml name used by LLTexLayerInfo::parseXml
                     bool is_local_texture,
                     EBakedTextureIndex baked_texture_index = BAKED_NUM_INDICES,
                     const std::string& default_image_name = "",
                     LLWearableType::EType wearable_type = LLWearableType::WT_INVALID);
        const std::string   mDefaultImageName;
        const LLWearableType::EType mWearableType;
        // It's either a local texture xor baked
        BOOL                mIsLocalTexture;
        BOOL                mIsBakedTexture;
        // If it's a local texture, it may be used by a baked texture
        BOOL                mIsUsedByBakedTexture;
        EBakedTextureIndex  mBakedTextureIndex;
    };

    struct Textures : public LLDictionary<ETextureIndex, TextureEntry>
    {
        Textures();
    } mTextures;
    const TextureEntry*     getTexture(ETextureIndex index) const { return mTextures.lookup(index); }
    const Textures&         getTextures() const { return mTextures; }

    //--------------------------------------------------------------------
    // Meshes
    //--------------------------------------------------------------------
public:
    struct MeshEntry : public LLDictionaryEntry
    {
        MeshEntry(EBakedTextureIndex baked_index,
                  const std::string &name, // names of mesh types as they are used in avatar_lad.xml
                  U8 level,
                  LLJointPickName pick);
        // Levels of Detail for each mesh.  Must match levels of detail present in avatar_lad.xml
        // Otherwise meshes will be unable to be found, or levels of detail will be ignored
        const U8                        mLOD;
        const EBakedTextureIndex        mBakedID;
        const LLJointPickName   mPickName;
    };

    struct MeshEntries : public LLDictionary<EMeshIndex, MeshEntry>
    {
        MeshEntries();
    } mMeshEntries;
    const MeshEntry*        getMeshEntry(EMeshIndex index) const { return mMeshEntries.lookup(index); }
    const MeshEntries&      getMeshEntries() const { return mMeshEntries; }

    //--------------------------------------------------------------------
    // Baked Textures
    //--------------------------------------------------------------------
public:
    struct BakedEntry : public LLDictionaryEntry
    {
        BakedEntry(ETextureIndex tex_index,
                   const std::string &name, // unused, but necessary for templating.
                   const std::string &hash_name,
                   U32 num_local_textures, ... ); // # local textures, local texture list, # wearables, wearable list
        // Local Textures
        const ETextureIndex mTextureIndex;
        texture_vec_t       mLocalTextures;
        // Wearables
        const LLUUID        mWearablesHashID;
        wearables_vec_t     mWearables;
    };

    struct BakedTextures: public LLDictionary<EBakedTextureIndex, BakedEntry>
    {
        BakedTextures();
    } mBakedTextures;
    const BakedEntry*       getBakedTexture(EBakedTextureIndex index) const { return mBakedTextures.lookup(index); }
    const BakedTextures&    getBakedTextures() const { return mBakedTextures; }

    //--------------------------------------------------------------------
    // Convenience Functions
    //--------------------------------------------------------------------
public:
    // Convert from baked texture to associated texture; e.g. BAKED_HEAD -> TEX_HEAD_BAKED
    ETextureIndex       bakedToLocalTextureIndex(EBakedTextureIndex t) const;

    // find a baked texture index based on its name
    EBakedTextureIndex  findBakedByRegionName(std::string name);
    EBakedTextureIndex  findBakedByImageName(std::string name);

    // Given a texture entry, determine which wearable type owns it.
    LLWearableType::EType       getTEWearableType(ETextureIndex index) const;

    static BOOL                         isBakedImageId(const LLUUID& id);
    static EBakedTextureIndex           assetIdToBakedTextureIndex(const LLUUID& id);
    static LLUUID                       localTextureIndexToMagicId(ETextureIndex t);

}; // End LLAvatarAppearanceDictionary

} // End namespace LLAvatarAppearanceDefines

#endif //LL_AVATARAPPEARANCE_DEFINES_H