summaryrefslogtreecommitdiff
path: root/indra/newview/lltool.cpp
blob: 031358c3dca3892af4c7d7b3a2819f766ac91ae9 (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
/** 
 * @file lltool.cpp
 * @brief LLTool class implementation
 *
 * $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$
 */

#include "llviewerprecompiledheaders.h"

#include "lltool.h"

#include "indra_constants.h"
#include "llerror.h"
#include "llview.h"

#include "llviewerwindow.h"
#include "llviewercontrol.h"
#include "lltoolcomp.h"
#include "lltoolfocus.h"
#include "llfocusmgr.h"
#include "llagent.h"
#include "llviewerjoystick.h"

extern bool gDebugClicks;

//static
const std::string LLTool::sNameNull("null");

LLTool::LLTool( const std::string& name, LLToolComposite* composite ) :
	mComposite( composite ),
	mName(name)
{
}

LLTool::~LLTool()
{
	if( hasMouseCapture() )
	{
		LL_WARNS() << "Tool deleted holding mouse capture.  Mouse capture removed." << LL_ENDL;
		gFocusMgr.removeMouseCaptureWithoutCallback( this );
	}
}

bool LLTool::handleAnyMouseClick(S32 x, S32 y, MASK mask, EMouseClickType clicktype, bool down)
{
	bool result = LLMouseHandler::handleAnyMouseClick(x, y, mask, clicktype, down);
	
	// This behavior was moved here from LLViewerWindow::handleAnyMouseClick, so it can be selectively overridden by LLTool subclasses.
	if(down && result)
	{
		// This is necessary to force clicks in the world to cause edit
		// boxes that might have keyboard focus to relinquish it, and hence
		// cause a commit to update their value.  JC
		gFocusMgr.setKeyboardFocus(NULL);
	}
	
	return result;
}

bool LLTool::handleMouseDown(S32 x, S32 y, MASK mask)
{
	if (gDebugClicks)
	{
		LL_INFOS() << "LLTool left mouse down" << LL_ENDL;
	}
	// by default, didn't handle it
	// AGENT_CONTROL_LBUTTON_DOWN is handled by scanMouse() and scanKey()
	// LL_INFOS() << "LLTool::handleMouseDown" << LL_ENDL;
	return false;
}

bool LLTool::handleMouseUp(S32 x, S32 y, MASK mask)
{
	if (gDebugClicks) 
	{
		LL_INFOS() << "LLTool left mouse up" << LL_ENDL;
	}
	// by default, didn't handle it
	// AGENT_CONTROL_LBUTTON_UP is handled by scanMouse() and scanKey()
	// LL_INFOS() << "LLTool::handleMouseUp" << LL_ENDL;
	return true;
}

bool LLTool::handleHover(S32 x, S32 y, MASK mask)
{
	gViewerWindow->setCursor(UI_CURSOR_ARROW);
	LL_DEBUGS("UserInput") << "hover handled by a tool" << LL_ENDL;		
	// by default, do nothing, say we handled it
	return true;
}

bool LLTool::handleScrollWheel(S32 x, S32 y, S32 clicks)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleScrollWheel" << LL_ENDL;
	return false;
}

bool LLTool::handleScrollHWheel(S32 x, S32 y, S32 clicks)
{
    // by default, didn't handle it
    return false;
}

bool LLTool::handleDoubleClick(S32 x,S32 y,MASK mask)
{
	// LL_INFOS() << "LLTool::handleDoubleClick" << LL_ENDL;
	// by default, pretend it's a left click
	return false;
}

bool LLTool::handleRightMouseDown(S32 x,S32 y,MASK mask)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleRightMouseDown" << LL_ENDL;
	return false;
}

bool LLTool::handleRightMouseUp(S32 x, S32 y, MASK mask)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleRightMouseDown" << LL_ENDL;
	return false;
}
 
bool LLTool::handleMiddleMouseDown(S32 x,S32 y,MASK mask)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleMiddleMouseDown" << LL_ENDL;
	return false;
}

bool LLTool::handleMiddleMouseUp(S32 x, S32 y, MASK mask)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleMiddleMouseUp" << LL_ENDL;
	return false;
}

bool LLTool::handleToolTip(S32 x, S32 y, MASK mask)
{
	// by default, didn't handle it
	// LL_INFOS() << "LLTool::handleToolTip" << LL_ENDL;
	return false;
}

void LLTool::setMouseCapture( BOOL b )
{
	if( b )
	{
		gFocusMgr.setMouseCapture(mComposite ? mComposite : this );
	}
	else
	if( hasMouseCapture() )
	{
		gFocusMgr.setMouseCapture( NULL );
	}
}

// virtual
void LLTool::draw()
{ }

bool LLTool::hasMouseCapture()
{
	return gFocusMgr.getMouseCapture() == (mComposite ? mComposite : this);
}

BOOL LLTool::handleKey(KEY key, MASK mask)
{
	return FALSE;
}

LLTool* LLTool::getOverrideTool(MASK mask)
{
	// NOTE: if in flycam mode, ALT-ZOOM camera should be disabled
	if (LLViewerJoystick::getInstance()->getOverrideCamera())
	{
		return NULL;
	}

	static LLCachedControl<bool> alt_zoom(gSavedSettings, "EnableAltZoom", true);
	if (alt_zoom)
	{
		if (mask & MASK_ALT)
		{
			return LLToolCamera::getInstance();
		}
	}
	return NULL;
}