summaryrefslogtreecommitdiff
path: root/indra/newview/lltooldraganddrop.h
blob: 5d10daca4d170c8a0a74343f9b19045b3294d766 (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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
/**
 * @file lltooldraganddrop.h
 * @brief LLToolDragAndDrop class header file
 *
 * $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_TOOLDRAGANDDROP_H
#define LL_TOOLDRAGANDDROP_H

#include "lldictionary.h"
#include "lltool.h"
#include "llview.h"
#include "lluuid.h"
#include "llassetstorage.h"
#include "llpermissions.h"
#include "llwindow.h"
#include "llviewerinventory.h"

class LLToolDragAndDrop;
class LLViewerRegion;
class LLVOAvatar;
class LLPickInfo;

class LLToolDragAndDrop : public LLTool, public LLSingleton<LLToolDragAndDrop>
{
    LLSINGLETON(LLToolDragAndDrop);
public:
    typedef boost::signals2::signal<void ()> enddrag_signal_t;

    // overridden from LLTool
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask) override;
    virtual BOOL    handleHover(S32 x, S32 y, MASK mask) override;
    virtual BOOL    handleKey(KEY key, MASK mask) override;
    virtual BOOL    handleToolTip(S32 x, S32 y, MASK mask) override;
    virtual void    onMouseCaptureLost() override;
    virtual void    handleDeselect() override;

    void            setDragStart( S32 x, S32 y );           // In screen space
    BOOL            isOverThreshold( S32 x, S32 y );        // In screen space

    enum ESource
    {
        SOURCE_AGENT,
        SOURCE_WORLD,
        SOURCE_NOTECARD,
        SOURCE_LIBRARY,
        SOURCE_VIEWER,
        SOURCE_PEOPLE
    };

    void beginDrag(EDragAndDropType type,
                   const LLUUID& cargo_id,
                   ESource source,
                   const LLUUID& source_id = LLUUID::null,
                   const LLUUID& object_id = LLUUID::null);
    void beginMultiDrag(const std::vector<EDragAndDropType> types,
                        const uuid_vec_t& cargo_ids,
                        ESource source,
                        const LLUUID& source_id = LLUUID::null);
    void endDrag();
    ESource getSource() const { return mSource; }
    const LLUUID& getSourceID() const { return mSourceID; }
    const LLUUID& getObjectID() const { return mObjectID; }
    EAcceptance getLastAccept() { return mLastAccept; }

    boost::signals2::connection setEndDragCallback( const enddrag_signal_t::slot_type& cb ) { return mEndDragSignal.connect(cb); }

    void setCargoCount(U32 count) { mCargoCount = count; }
    void resetCargoCount() { mCargoCount = 0; }
    U32 getCargoCount() const { return (mCargoCount > 0) ? mCargoCount : mCargoIDs.size(); }
    S32 getCargoIndex() const { return mCurItemIndex; }

    static S32 getOperationId() { return sOperationId; }

    // deal with permissions of object, etc. returns TRUE if drop can
    // proceed, otherwise FALSE.
    static BOOL handleDropMaterialProtections(LLViewerObject* hit_obj,
                         LLInventoryItem* item,
                         LLToolDragAndDrop::ESource source,
                         const LLUUID& src_id);

protected:
    enum EDropTarget
    {
        DT_NONE = 0,
        DT_SELF = 1,
        DT_AVATAR = 2,
        DT_OBJECT = 3,
        DT_LAND = 4,
        DT_COUNT = 5
    };

protected:
    // dragOrDrop3dImpl points to a member of LLToolDragAndDrop that
    // takes parameters (LLViewerObject* obj, S32 face, MASK, BOOL
    // drop) and returns a BOOL if drop is ok
    typedef EAcceptance (LLToolDragAndDrop::*dragOrDrop3dImpl)
        (LLViewerObject*, S32, MASK, BOOL);

    void dragOrDrop(S32 x, S32 y, MASK mask, BOOL drop,
                    EAcceptance* acceptance);
    void dragOrDrop3D(S32 x, S32 y, MASK mask, BOOL drop,
                      EAcceptance* acceptance);

    static void pickCallback(const LLPickInfo& pick_info);
    void pick(const LLPickInfo& pick_info);

protected:

    U32             mCargoCount;

    S32             mDragStartX;
    S32             mDragStartY;

    std::vector<EDragAndDropType> mCargoTypes;
    //void*         mCargoData;
    uuid_vec_t mCargoIDs;
    ESource mSource;
    LLUUID mSourceID;
    LLUUID mObjectID;

    static S32      sOperationId;

    LLVector3d      mLastCameraPos;
    LLVector3d      mLastHitPos;

    ECursorType     mCursor;
    EAcceptance     mLastAccept;
    BOOL            mDrop;
    S32             mCurItemIndex;
    std::string     mToolTipMsg;
    std::string     mCustomMsg;

    enddrag_signal_t    mEndDragSignal;

protected:
    // 3d drop functions. these call down into the static functions
    // named drop<ThingToDrop> if drop is TRUE and permissions allow
    // that behavior.
    EAcceptance dad3dNULL(LLViewerObject*, S32, MASK, BOOL);
    EAcceptance dad3dRezObjectOnLand(LLViewerObject* obj, S32 face,
                                     MASK mask, BOOL drop);
    EAcceptance dad3dRezObjectOnObject(LLViewerObject* obj, S32 face,
                                       MASK mask, BOOL drop);
    EAcceptance dad3dRezCategoryOnObject(LLViewerObject* obj, S32 face,
                                         MASK mask, BOOL drop);
    EAcceptance dad3dRezScript(LLViewerObject* obj, S32 face,
                               MASK mask, BOOL drop);
    EAcceptance dad3dTextureObject(LLViewerObject* obj, S32 face,
                                   MASK mask, BOOL drop);
    EAcceptance dad3dMaterialObject(LLViewerObject* obj, S32 face,
        MASK mask, BOOL drop);
    EAcceptance dad3dMeshObject(LLViewerObject* obj, S32 face,
                                   MASK mask, BOOL drop);
//  EAcceptance dad3dTextureSelf(LLViewerObject* obj, S32 face,
//                               MASK mask, BOOL drop);
    EAcceptance dad3dWearItem(LLViewerObject* obj, S32 face,
                                 MASK mask, BOOL drop);
    EAcceptance dad3dWearCategory(LLViewerObject* obj, S32 face,
                                 MASK mask, BOOL drop);
    EAcceptance dad3dUpdateInventory(LLViewerObject* obj, S32 face,
                                     MASK mask, BOOL drop);
    EAcceptance dad3dUpdateInventoryCategory(LLViewerObject* obj,
                                             S32 face,
                                             MASK mask,
                                             BOOL drop);
    EAcceptance dad3dGiveInventoryObject(LLViewerObject* obj, S32 face,
                                   MASK mask, BOOL drop);
    EAcceptance dad3dGiveInventory(LLViewerObject* obj, S32 face,
                                   MASK mask, BOOL drop);
    EAcceptance dad3dGiveInventoryCategory(LLViewerObject* obj, S32 face,
                                           MASK mask, BOOL drop);
    EAcceptance dad3dRezFromObjectOnLand(LLViewerObject* obj, S32 face,
                                         MASK mask, BOOL drop);
    EAcceptance dad3dRezFromObjectOnObject(LLViewerObject* obj, S32 face,
                                           MASK mask, BOOL drop);
    EAcceptance dad3dRezAttachmentFromInv(LLViewerObject* obj, S32 face,
                                          MASK mask, BOOL drop);
    EAcceptance dad3dCategoryOnLand(LLViewerObject *obj, S32 face,
                                    MASK mask, BOOL drop);
    EAcceptance dad3dAssetOnLand(LLViewerObject *obj, S32 face,
                                 MASK mask, BOOL drop);
    EAcceptance dad3dActivateGesture(LLViewerObject *obj, S32 face,
                                 MASK mask, BOOL drop);

    // helper called by methods above to handle "application" of an item
    // to an object (texture applied to face, mesh applied to shape, etc.)
    EAcceptance dad3dApplyToObject(LLViewerObject* obj, S32 face, MASK mask, BOOL drop, EDragAndDropType cargo_type);


    // set the LLToolDragAndDrop's cursor based on the given acceptance
    ECursorType acceptanceToCursor( EAcceptance acceptance );

    // This method converts mCargoID to an inventory item or
    // folder. If no item or category is found, both pointers will be
    // returned NULL.
    LLInventoryObject* locateInventory(LLViewerInventoryItem*& item,
                                       LLViewerInventoryCategory*& cat);

    //LLInventoryObject* locateMultipleInventory(
    //  LLViewerInventoryCategory::cat_array_t& cats,
    //  LLViewerInventoryItem::item_array_t& items);

    void dropObject(LLViewerObject* raycast_target,
            BOOL bypass_sim_raycast,
            BOOL from_task_inventory,
            BOOL remove_from_inventory);

    // accessor that looks at permissions, copyability, and names of
    // inventory items to determine if a drop would be ok.
    static EAcceptance willObjectAcceptInventory(LLViewerObject* obj, LLInventoryItem* item, EDragAndDropType type = DAD_NONE);

public:
    // helper functions
    static BOOL isInventoryDropAcceptable(LLViewerObject* obj, LLInventoryItem* item) { return (ACCEPT_YES_COPY_SINGLE <= willObjectAcceptInventory(obj, item)); }

    BOOL dadUpdateInventory(LLViewerObject* obj, BOOL drop);
    BOOL dadUpdateInventoryCategory(LLViewerObject* obj, BOOL drop);

    // methods that act on the simulator state.
    static void dropScript(LLViewerObject* hit_obj,
                           LLInventoryItem* item,
                           BOOL active,
                           ESource source,
                           const LLUUID& src_id);
    static void dropTexture(LLViewerObject* hit_obj,
                            S32 hit_face,
                            LLInventoryItem* item,
                            ESource source,
                            const LLUUID& src_id,
                            bool all_faces,
                            bool replace_pbr,
                            S32 tex_channel = -1);
    static void dropTextureOneFace(LLViewerObject* hit_obj,
                                   S32 hit_face,
                                   LLInventoryItem* item,
                                   ESource source,
                                   const LLUUID& src_id,
                                   bool remove_pbr,
                                   S32 tex_channel = -1);
    static void dropTextureAllFaces(LLViewerObject* hit_obj,
                                    LLInventoryItem* item,
                                    ESource source,
                                    const LLUUID& src_id,
                                    bool remove_pbr);
    static void dropMaterial(LLViewerObject* hit_obj,
                             S32 hit_face,
                             LLInventoryItem* item,
                             ESource source,
                             const LLUUID& src_id,
                             bool all_faces);
    static void dropMaterialOneFace(LLViewerObject* hit_obj,
                                    S32 hit_face,
                                    LLInventoryItem* item,
                                    ESource source,
                                    const LLUUID& src_id);
    static void dropMaterialAllFaces(LLViewerObject* hit_obj,
                                    LLInventoryItem* item,
                                    ESource source,
                                    const LLUUID& src_id);
    static void dropMesh(LLViewerObject* hit_obj,
                         LLInventoryItem* item,
                         ESource source,
                         const LLUUID& src_id);

    //static void   dropTextureOneFaceAvatar(LLVOAvatar* avatar,S32 hit_face,
    //                                   LLInventoryItem* item)

    static void dropInventory(LLViewerObject* hit_obj,
                              LLInventoryItem* item,
                              ESource source,
                              const LLUUID& src_id);

    static bool handleGiveDragAndDrop(LLUUID agent, LLUUID session, BOOL drop,
                                      EDragAndDropType cargo_type,
                                      void* cargo_data,
                                      EAcceptance* accept,
                                      const LLSD& dest = LLSD());

    // Classes used for determining 3d drag and drop types.
private:
    struct DragAndDropEntry : public LLDictionaryEntry
    {
        DragAndDropEntry(dragOrDrop3dImpl f_none,
                         dragOrDrop3dImpl f_self,
                         dragOrDrop3dImpl f_avatar,
                         dragOrDrop3dImpl f_object,
                         dragOrDrop3dImpl f_land);
        dragOrDrop3dImpl mFunctions[DT_COUNT];
    };
    class LLDragAndDropDictionary : public LLSingleton<LLDragAndDropDictionary>,
                                    public LLDictionary<EDragAndDropType, DragAndDropEntry>
    {
        LLSINGLETON(LLDragAndDropDictionary);
    public:
        dragOrDrop3dImpl get(EDragAndDropType dad_type, EDropTarget drop_target);
    };
};

// utility functions
void pack_permissions_slam(LLMessageSystem* msg, U32 flags, const LLPermissions& perms);

#endif  // LL_TOOLDRAGANDDROP_H