OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
GesturesModule.cs
Go to the documentation of this file.
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 using System.Reflection;
30 using log4net;
31 using Nini.Config;
32 using OpenMetaverse;
33 using OpenSim.Framework;
34 
35 using OpenSim.Region.Framework.Interfaces;
36 using OpenSim.Region.Framework.Scenes;
37 using OpenSim.Services.Interfaces;
38 
39 using Mono.Addins;
40 
41 namespace OpenSim.Region.CoreModules.Avatar.Gestures
42 {
43  [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "GesturesModule")]
45  {
46  private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
47 
48  protected Scene m_scene;
49 
50  public void Initialise(IConfigSource source)
51  {
52  }
53 
54  public void AddRegion(Scene scene)
55  {
56  m_scene = scene;
57 
58  m_scene.EventManager.OnNewClient += OnNewClient;
59  }
60 
61  public void RegionLoaded(Scene scene)
62  {
63  }
64 
65  public void RemoveRegion(Scene scene)
66  {
67  m_scene.EventManager.OnNewClient -= OnNewClient;
68  m_scene = null;
69  }
70 
71  public void Close() {}
72  public string Name { get { return "Gestures Module"; } }
73 
74  public Type ReplaceableInterface
75  {
76  get { return null; }
77  }
78 
79  private void OnNewClient(IClientAPI client)
80  {
81  client.OnActivateGesture += ActivateGesture;
82  client.OnDeactivateGesture += DeactivateGesture;
83  }
84 
85  public virtual void ActivateGesture(IClientAPI client, UUID assetId, UUID gestureId)
86  {
87  IInventoryService invService = m_scene.InventoryService;
88 
89  InventoryItemBase item = new InventoryItemBase(gestureId, client.AgentId);
90  item = invService.GetItem(item);
91  if (item != null)
92  {
93  item.Flags |= 1;
94  invService.UpdateItem(item);
95  }
96  else
97  m_log.WarnFormat(
98  "[GESTURES]: Unable to find gesture {0} to activate for {1}", gestureId, client.Name);
99  }
100 
101  public virtual void DeactivateGesture(IClientAPI client, UUID gestureId)
102  {
103  IInventoryService invService = m_scene.InventoryService;
104 
105  InventoryItemBase item = new InventoryItemBase(gestureId, client.AgentId);
106  item = invService.GetItem(item);
107  if (item != null)
108  {
109  item.Flags &= ~(uint)1;
110  invService.UpdateItem(item);
111  }
112  else
113  m_log.ErrorFormat(
114  "[GESTURES]: Unable to find gesture to deactivate {0} for {1}", gestureId, client.Name);
115  }
116  }
117 }
delegate void ActivateGesture(IClientAPI client, UUID gestureid, UUID assetId)
virtual void ActivateGesture(IClientAPI client, UUID assetId, UUID gestureId)
void AddRegion(Scene scene)
This is called whenever a Scene is added. For shared modules, this can happen several times...
Inventory Item - contains all the properties associated with an individual inventory piece...
void RegionLoaded(Scene scene)
This will be called once for every scene loaded. In a shared module this will be multiple times in on...
void Initialise(IConfigSource source)
This is called to initialize the region module. For shared modules, this is called exactly once...
Interactive OpenSim region server
Definition: OpenSim.cs:55
delegate void DeactivateGesture(IClientAPI client, UUID gestureid)
virtual void DeactivateGesture(IClientAPI client, UUID gestureId)
void Close()
This is the inverse to Initialise. After a Close(), this instance won't be usable anymore...
void RemoveRegion(Scene scene)
This is called whenever a Scene is removed. For shared modules, this can happen several times...