aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/Physics/BulletSPlugin/BSActors.cs
blob: fff63e4eb2707f0ddc7e48d5d0f6dec56161e144 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyrightD
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
using System;
using System.Collections.Generic;
using System.Text;

namespace OpenSim.Region.Physics.BulletSPlugin
{
public class BSActorCollection
{
    private BSScene m_physicsScene { get; set; }
    private Dictionary<string, BSActor> m_actors;

    public BSActorCollection(BSScene physicsScene)
    {
        m_physicsScene = physicsScene;
        m_actors = new Dictionary<string, BSActor>();
    }
    public void Add(string name, BSActor actor)
    {
        lock (m_actors)
        {
            if (!m_actors.ContainsKey(name))
            {
                m_actors[name] = actor;
            }
        }
    }
    public bool RemoveAndRelease(string name)
    {
        bool ret = false;
        lock (m_actors)
        {
            if (m_actors.ContainsKey(name))
            {
                BSActor beingRemoved = m_actors[name];
                m_actors.Remove(name);
                beingRemoved.Dispose();
                ret = true;
            }
        }
        return ret;
    }
    public void Clear()
    {
        lock (m_actors)
        {
            Release();
            m_actors.Clear();
        }
    }
    public void Dispose()
    {
        Clear();
    }
    public bool HasActor(string name)
    {
        return m_actors.ContainsKey(name);
    }
    public bool TryGetActor(string actorName, out BSActor theActor)
    {
        return m_actors.TryGetValue(actorName, out theActor);
    }
    public void ForEachActor(Action<BSActor> act)
    {
        lock (m_actors)
        {
            foreach (KeyValuePair<string, BSActor> kvp in m_actors)
                act(kvp.Value);
        }
    }

    public void Enable(bool enabl)
    {
        ForEachActor(a => a.SetEnabled(enabl));
    }
    public void Release()
    {
        ForEachActor(a => a.Dispose());
    }
    public void Refresh()
    {
        ForEachActor(a => a.Refresh());
    }
    public void RemoveDependencies()
    {
        ForEachActor(a => a.RemoveDependencies());
    }
}

// =============================================================================
/// <summary>
/// Each physical object can have 'actors' who are pushing the object around.
/// This can be used for hover, locking axis, making vehicles, etc.
/// Each physical object can have multiple actors acting on it.
///
/// An actor usually registers itself with physics scene events (pre-step action)
/// and modifies the parameters on the host physical object.
/// </summary>
public abstract class BSActor
{
    protected BSScene m_physicsScene { get; private set; }
    protected BSPhysObject m_controllingPrim { get; private set; }
    public virtual bool Enabled { get; set; }
    public string ActorName { get; private set; }

    public BSActor(BSScene physicsScene, BSPhysObject pObj, string actorName)
    {
        m_physicsScene = physicsScene;
        m_controllingPrim = pObj;
        ActorName = actorName;
        Enabled = true;
    }

    // Return 'true' if activily updating the prim
    public virtual bool isActive
    {
        get { return Enabled; }
    }

    // Turn the actor on an off. Only used by ActorCollection to set all enabled/disabled.
    // Anyone else should assign true/false to 'Enabled'.
    public void SetEnabled(bool setEnabled)
    {
        Enabled = setEnabled;
    }
    // Release any connections and resources used by the actor.
    public abstract void Dispose();
    // Called when physical parameters (properties set in Bullet) need to be re-applied.
    public abstract void Refresh();
    // The object's physical representation is being rebuilt so pick up any physical dependencies (constraints, ...).
    //     Register a prestep action to restore physical requirements before the next simulation step.
    public abstract void RemoveDependencies();

}
}