llinventoryobserver.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:8k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llinventoryobserver.h
  3.  * @brief LLInventoryObserver class header file
  4.  *
  5.  * $LicenseInfo:firstyear=2002&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2002-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLINVENTORYOBSERVERS_H
  33. #define LL_LLINVENTORYOBSERVERS_H
  34. #include "lluuid.h"
  35. #include <string>
  36. #include <vector>
  37. class LLViewerInventoryCategory;
  38. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39. // Class LLInventoryObserver
  40. //
  41. // This class is designed to be a simple abstract base class which can
  42. // relay messages when the inventory changes.
  43. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  44. class LLInventoryObserver
  45. {
  46. public:
  47. // This enumeration is a way to refer to what changed in a more
  48. // human readable format. You can mask the value provided by
  49. // chaged() to see if the observer is interested in the change.
  50. enum 
  51. {
  52. NONE = 0,
  53. LABEL = 1, // name changed
  54. INTERNAL = 2, // internal change (e.g. asset uuid different)
  55. ADD = 4, // something added
  56. REMOVE = 8, // something deleted
  57. STRUCTURE = 16, // structural change (eg item or folder moved)
  58. CALLING_CARD = 32, // (eg online, grant status, cancel)
  59. GESTURE = 64,
  60. REBUILD = 128,  // item UI changed (eg item type different)
  61. SORT = 256,  // folder needs to be resorted.
  62. ALL = 0xffffffff
  63. };
  64. LLInventoryObserver();
  65. virtual ~LLInventoryObserver();
  66. virtual void changed(U32 mask) = 0;
  67. std::string mMessageName; // used by Agent Inventory Service only. [DEV-20328]
  68. };
  69. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70. // Class LLInventoryCompletionObserver
  71. //
  72. // Class which can be used as a base class for doing something when
  73. // when all observed items are locally complete. This class implements
  74. // the changed() method of LLInventoryObserver and declares a new
  75. // method named done() which is called when all watched items have
  76. // complete information in the inventory model.
  77. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  78. class LLInventoryCompletionObserver : public LLInventoryObserver
  79. {
  80. public:
  81. LLInventoryCompletionObserver() {}
  82. virtual void changed(U32 mask);
  83. void watchItem(const LLUUID& id);
  84. protected:
  85. virtual void done() = 0;
  86. typedef std::vector<LLUUID> item_ref_t;
  87. item_ref_t mComplete;
  88. item_ref_t mIncomplete;
  89. };
  90. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  91. // Class LLInventoryFetchObserver
  92. //
  93. // This class is much like the LLInventoryCompletionObserver, except
  94. // that it handles all the the fetching necessary. Override the done()
  95. // method to do the thing you want.
  96. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  97. class LLInventoryFetchObserver : public LLInventoryObserver
  98. {
  99. public:
  100. LLInventoryFetchObserver(bool retry_if_missing = false): mRetryIfMissing(retry_if_missing) {}
  101. virtual void changed(U32 mask);
  102. typedef std::vector<LLUUID> item_ref_t;
  103. bool isEverythingComplete() const;
  104. void fetchItems(const item_ref_t& ids);
  105. virtual void done() {};
  106. protected:
  107. bool mRetryIfMissing;
  108. item_ref_t mComplete;
  109. item_ref_t mIncomplete;
  110. };
  111. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  112. // Class LLInventoryFetchDescendentsObserver
  113. //
  114. // This class is much like the LLInventoryCompletionObserver, except
  115. // that it handles fetching based on category. Override the done()
  116. // method to do the thing you want.
  117. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  118. class LLInventoryFetchDescendentsObserver : public LLInventoryObserver
  119. {
  120. public:
  121. LLInventoryFetchDescendentsObserver() {}
  122. virtual void changed(U32 mask);
  123. typedef std::vector<LLUUID> folder_ref_t;
  124. void fetchDescendents(const folder_ref_t& ids);
  125. bool isEverythingComplete() const;
  126. virtual void done() = 0;
  127. protected:
  128. bool isComplete(LLViewerInventoryCategory* cat);
  129. folder_ref_t mIncompleteFolders;
  130. folder_ref_t mCompleteFolders;
  131. };
  132. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  133. // Class LLInventoryFetchComboObserver
  134. //
  135. // This class does an appropriate combination of fetch descendents and
  136. // item fetches based on completion of categories and items. Much like
  137. // the fetch and fetch descendents, this will call done() when everything
  138. // has arrived.
  139. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140. class LLInventoryFetchComboObserver : public LLInventoryObserver
  141. {
  142. public:
  143. LLInventoryFetchComboObserver() : mDone(false) {}
  144. virtual void changed(U32 mask);
  145. typedef std::vector<LLUUID> folder_ref_t;
  146. typedef std::vector<LLUUID> item_ref_t;
  147. void fetch(const folder_ref_t& folder_ids, const item_ref_t& item_ids);
  148. virtual void done() = 0;
  149. protected:
  150. bool mDone;
  151. folder_ref_t mCompleteFolders;
  152. folder_ref_t mIncompleteFolders;
  153. item_ref_t mCompleteItems;
  154. item_ref_t mIncompleteItems;
  155. };
  156. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  157. // Class LLInventoryExistenceObserver
  158. //
  159. // This class is used as a base class for doing somethign when all the
  160. // observed item ids exist in the inventory somewhere. You can derive
  161. // a class from this class and implement the done() method to do
  162. // something useful.
  163. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  164. class LLInventoryExistenceObserver : public LLInventoryObserver
  165. {
  166. public:
  167. LLInventoryExistenceObserver() {}
  168. virtual void changed(U32 mask);
  169. void watchItem(const LLUUID& id);
  170. protected:
  171. virtual void done() = 0;
  172. typedef std::vector<LLUUID> item_ref_t;
  173. item_ref_t mExist;
  174. item_ref_t mMIA;
  175. };
  176. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  177. // Class LLInventoryAddedObserver
  178. //
  179. // This class is used as a base class for doing something when 
  180. // a new item arrives in inventory.
  181. // It does not watch for a certain UUID, rather it acts when anything is added
  182. // Derive a class from this class and implement the done() method to do
  183. // something useful.
  184. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  185. class LLInventoryAddedObserver : public LLInventoryObserver
  186. {
  187. public:
  188. LLInventoryAddedObserver() : mAdded() {}
  189. virtual void changed(U32 mask);
  190. protected:
  191. virtual void done() = 0;
  192. typedef std::vector<LLUUID> item_ref_t;
  193. item_ref_t mAdded;
  194. };
  195. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  196. // Class LLInventoryTransactionObserver
  197. //
  198. // Class which can be used as a base class for doing something when an
  199. // inventory transaction completes.
  200. //
  201. // *NOTE: This class is not quite complete. Avoid using unless you fix up it's
  202. // functionality gaps.
  203. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  204. class LLInventoryTransactionObserver : public LLInventoryObserver
  205. {
  206. public:
  207. LLInventoryTransactionObserver(const LLTransactionID& transaction_id);
  208. virtual void changed(U32 mask);
  209. protected:
  210. typedef std::vector<LLUUID> folder_ref_t;
  211. typedef std::vector<LLUUID> item_ref_t;
  212. virtual void done(const folder_ref_t& folders, const item_ref_t& items) = 0;
  213. LLTransactionID mTransactionID;
  214. };
  215. #endif // LL_LLINVENTORYOBSERVERS_H