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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lllandmarkactions.h
  3.  * @brief LLLandmark class declaration
  4.  *
  5.  * $LicenseInfo:firstyear=2000&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2000-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_LLLANDMARKACTIONS_H
  33. #define LL_LLLANDMARKACTIONS_H
  34. #include "llinventorymodel.h"
  35. #include "lllandmarklist.h"
  36. class LLLandmark;
  37. /**
  38.  * @brief Provides helper functions to manage landmarks
  39.  */
  40. class LLLandmarkActions
  41. {
  42. public:
  43. typedef boost::function<void(std::string& slurl)> slurl_callback_t;
  44. typedef boost::function<void(std::string& slurl, S32 x, S32 y, S32 z)> region_name_and_coords_callback_t;
  45. /**
  46.  * @brief Fetches landmark LLViewerInventoryItems for the given landmark name. 
  47.  */
  48. static LLInventoryModel::item_array_t fetchLandmarksByName(std::string& name, BOOL if_use_substring);
  49. /**
  50.  * @brief Checks whether landmark exists for current agent position.
  51.  */
  52. static bool landmarkAlreadyExists();
  53. /**
  54.  * @brief Checks whether landmark exists for current agent parcel.
  55.  */
  56. static bool hasParcelLandmark();
  57. /**
  58.  * @brief Searches landmark for global position.
  59.  * @return Returns landmark or NULL.
  60.  * 
  61.  * *TODO: dzaporozhan: There can be many landmarks for single parcel.
  62.  */
  63. static LLViewerInventoryItem* findLandmarkForGlobalPos(const LLVector3d &pos);
  64. /**
  65.  * @brief Searches landmark for agent global position.
  66.  * @return Returns landmark or NULL.
  67.  * 
  68.  * *TODO: dzaporozhan: There can be many landmarks for single parcel.
  69.  */
  70. static LLViewerInventoryItem* findLandmarkForAgentPos();
  71. /**
  72.  * @brief Checks whether agent has rights to create landmark for current parcel.
  73.  */
  74. static bool canCreateLandmarkHere();
  75. /**
  76.  * @brief Creates landmark for current parcel.
  77.  */
  78. static void createLandmarkHere();
  79. /**
  80.  * @brief Creates landmark for current parcel.
  81.  */
  82. static void createLandmarkHere(
  83. const std::string& name, 
  84. const std::string& desc, 
  85. const LLUUID& folder_id);
  86. /**
  87.  * @brief Creates SLURL for given global position.
  88.  */
  89. static void getSLURLfromPosGlobal(const LLVector3d& global_pos, slurl_callback_t cb, bool escaped = true);
  90. static void getRegionNameAndCoordsFromPosGlobal(const LLVector3d& global_pos, region_name_and_coords_callback_t cb);
  91.     /**
  92.      * @brief Gets landmark global position specified by inventory LLUUID.
  93.      * Found position is placed into "posGlobal" variable.
  94.      *.
  95.      * @return - true if specified item exists in Inventory and an appropriate landmark found.
  96.      * and its position is known, false otherwise.
  97.      */
  98.     // *TODO: mantipov: profide callback for cases, when Landmark is not loaded yet.
  99.     static bool getLandmarkGlobalPos(const LLUUID& landmarkInventoryItemID, LLVector3d& posGlobal);
  100.     /**
  101.      * @brief Retrieve a landmark from gLandmarkList by inventory item's id
  102.      * If a landmark is not currently in the gLandmarkList a callback "cb" is called when it is loaded.
  103.      * 
  104.      * @return pointer to loaded landmark from gLandmarkList or NULL if landmark does not exist or wasn't loaded.
  105.      */
  106.     static LLLandmark* getLandmark(const LLUUID& landmarkInventoryItemID, LLLandmarkList::loaded_callback_t cb = NULL);
  107.     /**
  108.      * @brief  Performs standard action of copying of SLURL from landmark to user's clipboard.
  109.      *  This action requires additional server request. The user will be notified  by info message, 
  110.      *  when URL is copied .
  111.      */
  112.     static void copySLURLtoClipboard(const LLUUID& landmarkInventoryItemID);
  113. private:
  114.     LLLandmarkActions();
  115.     LLLandmarkActions(const LLLandmarkActions&);
  116. static void onRegionResponseSLURL(slurl_callback_t cb,
  117.  const LLVector3d& global_pos,
  118.  bool escaped,
  119.  const std::string& url);
  120. static void onRegionResponseNameAndCoords(region_name_and_coords_callback_t cb,
  121.  const LLVector3d& global_pos,
  122.  U64 region_handle);
  123. };
  124. #endif //LL_LLLANDMARKACTIONS_H