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
|
/**
* @file llteleporthistory.h
* @brief Teleport history
*
* $LicenseInfo:firstyear=2009&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_LLTELEPORTHISTORY_H
#define LL_LLTELEPORTHISTORY_H
#include "llsingleton.h" // for LLSingleton
#include <vector>
#include <string>
#include <boost/function.hpp>
#include <boost/signals2.hpp>
#include "llteleporthistorystorage.h"
/**
* An item of the teleport history.
*
* Contains the location's global coordinates and its title.
*/
class LLTeleportHistoryItem
{
public:
LLTeleportHistoryItem()
{}
LLTeleportHistoryItem(std::string title, LLVector3d global_pos)
: mTitle(title), mGlobalPos(global_pos)
{}
/**
* @return title formatted according to the current value of the
* NavBarShowCoordinates setting.
*/
const std::string& getTitle() const;
std::string mTitle; // human-readable location title
std::string mFullTitle; // human-readable location title including coordinates
LLVector3d mGlobalPos; // global position
LLUUID mRegionID; // region ID for getting the region info
};
/**
* Teleport history.
*
* Along with the navigation bar "Back" and "Forward" buttons
* implements web browser-like navigation functionality.
*
* @see LLNavigationBar
*/
class LLTeleportHistory: public LLSingleton<LLTeleportHistory>
{
LOG_CLASS(LLTeleportHistory);
public:
typedef std::vector<LLTeleportHistoryItem> slurl_list_t;
typedef boost::function<void()> history_callback_t;
typedef boost::signals2::signal<void()> history_signal_t;
LLTeleportHistory();
~LLTeleportHistory();
/**
* Go back in the history.
*/
void goBack() { goToItem(getCurrentItemIndex() - 1); }
/**
* Go forward in the history.
*/
void goForward() { goToItem(getCurrentItemIndex() + 1); }
/**
* Go to specific item in the history.
*
* The item is specified by its index (starting from 0).
*/
void goToItem(int idx);
/**
* @return history items.
*/
const slurl_list_t& getItems() const { return mItems; }
void purgeItems();
/**
* Is the history empty?
*
* History containing single item is treated as empty
* because the item points to the current location.
*/
bool isEmpty() const { return mItems.size() <= 1; }
/**
* Get index of the current location in the history.
*/
int getCurrentItemIndex() const { return mCurrentItem; }
/**
* Set a callback to be called upon history changes.
*
* Multiple callbacks can be set.
*/
boost::signals2::connection setHistoryChangedCallback(history_callback_t cb);
/**
* Save history to a file so that we can restore it on startup.
*
* @see load()
*/
void dump() const;
/**
* Process login complete event. Basically put current location into history
*/
void handleLoginComplete();
private:
/**
* Called by when a teleport fails.
*
* Called via callback set on the LLViewerParcelMgr "teleport failed" signal.
*
* @see mTeleportFailedConn
*/
void onTeleportFailed();
/**
* Update current location.
*
* @param new_pos Current agent global position. After local teleports we
* cannot rely on gAgent.getPositionGlobal(),
* so the new position gets passed explicitly.
*
* Called when a teleport finishes.
* Called via callback set on the LLViewerParcelMgr "teleport finished" signal.
*
* Takes mRequestedItem into consideration: if it's not -1
* (i.e. user is teleporting to an arbitrary location, not to a history item)
* we purge forward items and append a new one, making it current. Otherwise
* we just modify mCurrentItem.
*
* @see mRequestedItem
* @see mGotInitialUpdate
*/
void updateCurrentLocation(const LLVector3d& new_pos);
/**
* Invokes the "history changed" callback(s).
*/
void onHistoryChanged();
/**
* Format current agent location in a human-readable manner.
*
* @param full whether to include coordinates
* @param local_pos_override hack: see description of updateCurrentLocation()
* @return
*/
static std::string getCurrentLocationTitle(bool full, const LLVector3& local_pos_override);
/**
* Actually, the teleport history.
*/
slurl_list_t mItems;
/**
* Current position within the history.
*/
int mCurrentItem;
/**
* Requested position within the history.
*
* When a teleport succeeds, this is checked by updateCurrentLocation() to tell
* if this is a teleport within the history (mRequestedItem >=0) or not (-1).
*
* Set by goToItem(); reset by onTeleportFailed() (if teleport fails).
*
* @see goToItem()
* @see updateCurrentLocation()
*/
int mRequestedItem;
/**
* Have we received the initial location update?
*
* @see updateCurrentLocation()
*/
bool mGotInitialUpdate;
LLTeleportHistoryStorage* mTeleportHistoryStorage;
/**
* Signal emitted when the history gets changed.
*
* Invokes callbacks set with setHistoryChangedCallback().
*/
history_signal_t mHistoryChangedSignal;
/**
* Teleport success notification connection.
*
* Using this connection we get notified when a teleport finishes
* or initial location update occurs.
*/
boost::signals2::connection mTeleportFinishedConn;
/**
* Teleport failure notification connection.
*
* Using this connection we get notified when a teleport fails.
*/
boost::signals2::connection mTeleportFailedConn;
};
#endif
|
