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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lluserrelations.h
  3.  * @author Phoenix
  4.  * @date 2006-10-12
  5.  * @brief Declaration of a class for handling granted rights.
  6.  *
  7.  * $LicenseInfo:firstyear=2006&license=viewergpl$
  8.  * 
  9.  * Copyright (c) 2006-2010, Linden Research, Inc.
  10.  * 
  11.  * Second Life Viewer Source Code
  12.  * The source code in this file ("Source Code") is provided by Linden Lab
  13.  * to you under the terms of the GNU General Public License, version 2.0
  14.  * ("GPL"), unless you have obtained a separate licensing agreement
  15.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  16.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  17.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  18.  * 
  19.  * There are special exceptions to the terms and conditions of the GPL as
  20.  * it is applied to this Source Code. View the full text of the exception
  21.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  22.  * online at
  23.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  24.  * 
  25.  * By copying, modifying or distributing this software, you acknowledge
  26.  * that you have read and understood your obligations described above,
  27.  * and agree to abide by those obligations.
  28.  * 
  29.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  30.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  31.  * COMPLETENESS OR PERFORMANCE.
  32.  * $/LicenseInfo$
  33.  */
  34. #ifndef LL_LLUSERRELAIONS_H
  35. #define LL_LLUSERRELAIONS_H
  36. #include <map>
  37. #include "lluuid.h"
  38. /** 
  39.  * @class LLRelationship
  40.  *
  41.  * This class represents a relationship between two agents, where the
  42.  * related agent is stored and the other agent is the relationship is
  43.  * implicit by container ownership.
  44.  * This is merely a cache of this information used by the sim 
  45.  * and viewer.
  46.  *
  47.  * You are expected to use this in a map or similar structure, eg:
  48.  * typedef std::map<LLUUID, LLRelationship> agent_relationship_map;
  49.  */
  50. class LLRelationship
  51. {
  52. public:
  53. /**
  54.  * @brief Constructors.
  55.  */
  56. LLRelationship();
  57. LLRelationship(S32 grant_to, S32 grant_from, bool is_online);
  58. static const LLRelationship DEFAULT_RELATIONSHIP;
  59.     /** 
  60.  * @name Status functionality
  61.  *
  62.  * I thought it would be keen to have a generic status interface,
  63.  * but the only thing we currently cache is online status. As this
  64.  * assumption changes, this API may evolve.
  65.  */
  66. //@{
  67. /**
  68.  * @brief Does this instance believe the related agent is currently
  69.  * online or available.
  70.  *
  71.  * NOTE: This API may be deprecated if there is any transient status
  72.  * other than online status, for example, away/busy/etc.
  73.  *
  74.  * This call does not check any kind of central store or make any
  75.  * deep information calls - it simply checks a cache of online
  76.  * status.
  77.  * @return Returns true if this relationship believes the agent is
  78.  * online.
  79.  */
  80. bool isOnline() const;
  81. /**
  82.  * @brief Set the online status.
  83.  *
  84.  * NOTE: This API may be deprecated if there is any transient status
  85.  * other than online status.
  86.  * @param is_online Se the online status
  87.  */
  88. void online(bool is_online);
  89. //@}
  90. /* @name Granted rights
  91.  */
  92. //@{
  93. /** 
  94.  * @brief Anonymous enumeration for specifying rights.
  95.  */
  96. enum
  97. {
  98. GRANT_NONE = 0x0,
  99. GRANT_ONLINE_STATUS = 0x1,
  100. GRANT_MAP_LOCATION = 0x2,
  101. GRANT_MODIFY_OBJECTS = 0x4,
  102. };
  103. /**
  104.  * ???
  105.  */
  106. static const U8 GRANTED_VISIBLE_MASK;
  107. /**
  108.  * @brief Check for a set of rights granted to agent.
  109.  *
  110.  * @param rights A bitfield to check for rights.
  111.  * @return Returns true if all rights have been granted.
  112.  */
  113. bool isRightGrantedTo(S32 rights) const;
  114. /**
  115.  * @brief Check for a set of rights granted from an agent.
  116.  *
  117.  * @param rights A bitfield to check for rights.
  118.  * @return Returns true if all rights have been granted.
  119.  */
  120. bool isRightGrantedFrom(S32 rights) const;
  121. /**
  122.  * @brief Get the rights granted to the other agent.
  123.  *
  124.  * @return Returns the bitmask of granted rights.
  125.  */
  126. S32 getRightsGrantedTo() const;
  127. /**
  128.  * @brief Get the rights granted from the other agent.
  129.  *
  130.  * @return Returns the bitmask of granted rights.
  131.  */
  132. S32 getRightsGrantedFrom() const;
  133. void setRightsTo(S32 to_agent) { mGrantToAgent = to_agent; mChangeSerialNum++; }
  134. void setRightsFrom(S32 from_agent) { mGrantFromAgent = from_agent; mChangeSerialNum++;}
  135. /**
  136.  * @brief Get the change count for this agent
  137.  *
  138.  * Every change to rights will increment the serial number
  139.  * allowing listeners to determine when a relationship value is actually new
  140.  *
  141.  * @return change serial number for relationship
  142.  */
  143. S32 getChangeSerialNum() const { return mChangeSerialNum; }
  144. /**
  145.  * @brief Grant a set of rights.
  146.  *
  147.  * Any bit which is set will grant that right if it is set in the
  148.  * instance. You can pass in LLGrantedRights::NONE to not change
  149.  * that field.
  150.  * @param to_agent The rights to grant to agent_id.
  151.  * @param from_agent The rights granted from agent_id.
  152.  */
  153. void grantRights(S32 to_agent, S32 from_agent);
  154. /** 
  155.  * @brief Revoke a set of rights.
  156.  *
  157.  * Any bit which is set will revoke that right if it is set in the
  158.  * instance. You can pass in LLGrantedRights::NONE to not change
  159.  * that field.
  160.  * @param to_agent The rights to grant to agent_id.
  161.  * @param from_agent The rights granted from agent_id.
  162.  */
  163. void revokeRights(S32 to_agent, S32 from_agent);
  164. //@}
  165. protected:
  166. S32 mGrantToAgent;
  167. S32 mGrantFromAgent;
  168. S32 mChangeSerialNum;
  169. bool mIsOnline;
  170. };
  171. #endif // LL_LLUSERRELAIONS_H