summaryrefslogtreecommitdiff
path: root/indra/newview/lljoystickbutton.h
blob: 053cf0348af95da5f05f75c0cdddfa597fb83153 (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
/**
 * @file lljoystickbutton.h
 * @brief LLJoystick class definition
 *
 * $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_LLJOYSTICKBUTTON_H
#define LL_LLJOYSTICKBUTTON_H

#include "llbutton.h"
#include "llcoord.h"
#include "llviewertexture.h"
#include "llquaternion.h"

typedef enum e_joystick_quadrant
{
    JQ_ORIGIN,
    JQ_UP,
    JQ_DOWN,
    JQ_LEFT,
    JQ_RIGHT
} EJoystickQuadrant;

struct QuadrantNames : public LLInitParam::TypeValuesHelper<EJoystickQuadrant, QuadrantNames>
{
    static void declareValues();
};

class LLJoystick
:   public LLButton
{
public:
    struct Params
    :   public LLInitParam::Block<Params, LLButton::Params>
    {
        Optional<EJoystickQuadrant, QuadrantNames> quadrant;

        Params()
        :   quadrant("quadrant", JQ_ORIGIN)
        {
            changeDefault(label, "");
        }
    };
    LLJoystick(const Params&);

    virtual BOOL    handleMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask);
    virtual BOOL    handleHover(S32 x, S32 y, MASK mask);

    virtual void    onMouseUp() {}
    virtual void    onHeldDown() = 0;
    F32             getElapsedHeldDownTime();

    static void     onBtnHeldDown(void *userdata);      // called by llbutton callback handler
    void            setInitialQuadrant(EJoystickQuadrant initial) { mInitialQuadrant = initial; };

    /**
     * Checks if click location is inside joystick circle.
     *
     * Image containing circle is square and this square has adherent points with joystick
     * circle. Make sure to change method according to shape other than square.
     */
    bool    pointInCircle(S32 x, S32 y) const;
    bool    pointInCenterDot(S32 x, S32 y, S32 radius) const;

    static std::string nameFromQuadrant(const EJoystickQuadrant quadrant);
    static EJoystickQuadrant quadrantFromName(const std::string& name);
    static EJoystickQuadrant selectQuadrant(LLXMLNodePtr node);


protected:
    virtual void    updateSlop();                   // recompute slop margins

protected:
    EJoystickQuadrant   mInitialQuadrant;           // mousedown = click in this quadrant
    LLCoordGL           mInitialOffset;             // pretend mouse started here
    LLCoordGL           mLastMouse;                 // where was mouse on last hover event
    LLCoordGL           mFirstMouse;                // when mouse clicked, where was it
    S32                 mVertSlopNear;              // where the slop regions end
    S32                 mVertSlopFar;               // where the slop regions end
    S32                 mHorizSlopNear;             // where the slop regions end
    S32                 mHorizSlopFar;              // where the slop regions end
    BOOL                mHeldDown;
    LLFrameTimer        mHeldDownTimer;
};


// Turn agent left and right, move forward and back
class LLJoystickAgentTurn
:   public LLJoystick
{
public:
    struct Params : public LLJoystick::Params {};
    LLJoystickAgentTurn(const Params& p) : LLJoystick(p) {}
    virtual void    onHeldDown();
};


// Slide left and right, move forward and back
class LLJoystickAgentSlide
:   public LLJoystick
{
public:
    struct Params : public LLJoystick::Params {};
    LLJoystickAgentSlide(const Params& p) : LLJoystick(p) {}

    virtual void    onHeldDown();
    virtual void    onMouseUp();
};


// Rotate camera around the focus point
class LLJoystickCameraRotate
:   public LLJoystick
{
public:
    struct Params
    :   public LLInitParam::Block<Params, LLJoystick::Params>
    {
        Params()
        {
            changeDefault(held_down_delay.seconds, 0.0);
        }
    };

    LLJoystickCameraRotate(const LLJoystickCameraRotate::Params&);

    virtual void    setToggleState( BOOL left, BOOL top, BOOL right, BOOL bottom );

    virtual BOOL    handleMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask);
    virtual BOOL    handleHover(S32 x, S32 y, MASK mask);
    virtual void    onHeldDown();
    virtual void    resetJoystickCamera();
    virtual void    draw();

protected:
    F32             getOrbitRate();
    virtual void    updateSlop();
    void            drawRotatedImage( LLPointer<LLUIImage> image, S32 rotations );

protected:
    BOOL            mInLeft;
    BOOL            mInTop;
    BOOL            mInRight;
    BOOL            mInBottom;
    BOOL            mInCenter;

    std::string     mCenterImageName;
};


// Track the camera focus point forward/backward and side to side
class LLJoystickCameraTrack
:   public LLJoystickCameraRotate
{
public:
    struct Params
    :   public LLInitParam::Block<Params, LLJoystickCameraRotate::Params>
    {
        Params();
    };

    LLJoystickCameraTrack(const LLJoystickCameraTrack::Params&);
    virtual void    onHeldDown();
    virtual void    resetJoystickCamera();
};

//
class LLJoystickQuaternion :
    public LLJoystick
{
public:
    struct Params :
        public LLInitParam::Block<Params, LLJoystick::Params>
    {
        Params();
    };

    LLJoystickQuaternion(const LLJoystickQuaternion::Params &);

    virtual void    setToggleState(BOOL left, BOOL top, BOOL right, BOOL bottom);

    virtual BOOL    handleMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask);
    virtual void    onHeldDown();
    virtual void    draw();

    void            setRotation(const LLQuaternion &value);
    LLQuaternion    getRotation() const;

protected:
    F32             getOrbitRate();
    virtual void    updateSlop();
    void            drawRotatedImage(LLPointer<LLUIImage> image, S32 rotations);

    BOOL            mInLeft;
    BOOL            mInTop;
    BOOL            mInRight;
    BOOL            mInBottom;

    S32             mXAxisIndex;
    S32             mYAxisIndex;
    S32             mZAxisIndex;

    LLVector3       mVectorZero;
    LLQuaternion    mRotation;
    LLVector3       mUpDnAxis;
    LLVector3       mLfRtAxis;
};

#endif  // LL_LLJOYSTICKBUTTON_H