diff options
Diffstat (limited to 'OpenSim/Framework')
-rw-r--r-- | OpenSim/Framework/IClientAPI.cs | 6 | ||||
-rw-r--r-- | OpenSim/Framework/IScene.cs | 10 | ||||
-rw-r--r-- | OpenSim/Framework/ISceneAgent.cs | 68 |
3 files changed, 81 insertions, 3 deletions
diff --git a/OpenSim/Framework/IClientAPI.cs b/OpenSim/Framework/IClientAPI.cs index cda8a1b..6732d59 100644 --- a/OpenSim/Framework/IClientAPI.cs +++ b/OpenSim/Framework/IClientAPI.cs | |||
@@ -707,6 +707,12 @@ namespace OpenSim.Framework | |||
707 | 707 | ||
708 | UUID AgentId { get; } | 708 | UUID AgentId { get; } |
709 | 709 | ||
710 | /// <summary> | ||
711 | /// The scene agent for this client. This will only be set if the client has an agent in a scene (i.e. if it | ||
712 | /// is connected). | ||
713 | /// </summary> | ||
714 | ISceneAgent SceneAgent { get; } | ||
715 | |||
710 | UUID SessionId { get; } | 716 | UUID SessionId { get; } |
711 | 717 | ||
712 | UUID SecureSessionId { get; } | 718 | UUID SecureSessionId { get; } |
diff --git a/OpenSim/Framework/IScene.cs b/OpenSim/Framework/IScene.cs index 7b0fe37..6919c48 100644 --- a/OpenSim/Framework/IScene.cs +++ b/OpenSim/Framework/IScene.cs | |||
@@ -68,12 +68,16 @@ namespace OpenSim.Framework | |||
68 | event restart OnRestart; | 68 | event restart OnRestart; |
69 | 69 | ||
70 | /// <summary> | 70 | /// <summary> |
71 | /// Register the new client with the scene. The client starts off as a child agent - the later agent crossing | 71 | /// Add a new client and create a presence for it. All clients except initial login clients will starts off as a child agent |
72 | /// will promote it to a root agent. | 72 | /// - the later agent crossing will promote it to a root agent. |
73 | /// </summary> | 73 | /// </summary> |
74 | /// <param name="client"></param> | 74 | /// <param name="client"></param> |
75 | /// <param name="type">The type of agent to add.</param> | 75 | /// <param name="type">The type of agent to add.</param> |
76 | void AddNewClient(IClientAPI client, PresenceType type); | 76 | /// <returns> |
77 | /// The scene agent if the new client was added. | ||
78 | /// Null if the required scene agent already existed or no scene agent was added because the required client circuit doesn't exist. | ||
79 | /// </returns> | ||
80 | ISceneAgent AddNewClient(IClientAPI client, PresenceType type); | ||
77 | 81 | ||
78 | /// <summary> | 82 | /// <summary> |
79 | /// Remove the given client from the scene. | 83 | /// Remove the given client from the scene. |
diff --git a/OpenSim/Framework/ISceneAgent.cs b/OpenSim/Framework/ISceneAgent.cs new file mode 100644 index 0000000..69e91ed --- /dev/null +++ b/OpenSim/Framework/ISceneAgent.cs | |||
@@ -0,0 +1,68 @@ | |||
1 | /* | ||
2 | * Copyright (c) Contributors, http://opensimulator.org/ | ||
3 | * See CONTRIBUTORS.TXT for a full list of copyright holders. | ||
4 | * | ||
5 | * Redistribution and use in source and binary forms, with or without | ||
6 | * modification, are permitted provided that the following conditions are met: | ||
7 | * * Redistributions of source code must retain the above copyright | ||
8 | * notice, this list of conditions and the following disclaimer. | ||
9 | * * Redistributions in binary form must reproduce the above copyright | ||
10 | * notice, this list of conditions and the following disclaimer in the | ||
11 | * documentation and/or other materials provided with the distribution. | ||
12 | * * Neither the name of the OpenSimulator Project nor the | ||
13 | * names of its contributors may be used to endorse or promote products | ||
14 | * derived from this software without specific prior written permission. | ||
15 | * | ||
16 | * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY | ||
17 | * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
18 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
19 | * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY | ||
20 | * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
21 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
22 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | ||
23 | * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
24 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
25 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
26 | */ | ||
27 | |||
28 | using System; | ||
29 | |||
30 | namespace OpenSim.Framework | ||
31 | { | ||
32 | /// <summary> | ||
33 | /// An agent in the scene. | ||
34 | /// </summary> | ||
35 | /// <remarks> | ||
36 | /// Interface is a work in progress. Please feel free to add other required properties and methods. | ||
37 | /// </remarks> | ||
38 | public interface ISceneAgent : ISceneEntity | ||
39 | { | ||
40 | /// <value> | ||
41 | /// The client controlling this presence | ||
42 | /// </value> | ||
43 | IClientAPI ControllingClient { get; } | ||
44 | |||
45 | /// <summary> | ||
46 | /// What type of presence is this? User, NPC, etc. | ||
47 | /// </summary> | ||
48 | PresenceType PresenceType { get; } | ||
49 | |||
50 | /// <summary> | ||
51 | /// Avatar appearance data. | ||
52 | /// </summary> | ||
53 | /// <remarks> | ||
54 | // Because appearance setting is in a module, we actually need | ||
55 | // to give it access to our appearance directly, otherwise we | ||
56 | // get a synchronization issue. | ||
57 | /// </remarks> | ||
58 | AvatarAppearance Appearance { get; set; } | ||
59 | |||
60 | /// <summary> | ||
61 | /// Send initial scene data to the client controlling this agent | ||
62 | /// </summary> | ||
63 | /// <remarks> | ||
64 | /// This includes scene object data and the appearance data of other avatars. | ||
65 | /// </remarks> | ||
66 | void SendInitialDataToMe(); | ||
67 | } | ||
68 | } \ No newline at end of file | ||