aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Framework/Animation.cs
blob: 34255058ca31c60268d94bd145a2ca16a39c4e09 (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
/*
 * 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 copyright
 *       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 OpenMetaverse;
using OpenMetaverse.StructuredData;

namespace OpenSim.Framework
{
    /// <summary>
    /// Information about an Animation
    /// </summary>
    [Serializable]
    public class Animation
    {
        private UUID animID;

        /// <summary>
        /// ID of Animation
        /// </summary>
        public UUID AnimID
        {
            get { return animID; }
            set { animID = value; }
        }

        private int sequenceNum;
        public int SequenceNum
        {
            get { return sequenceNum; }
            set { sequenceNum = value; }
        }

        private UUID objectID;

        /// <summary>
        /// Unique ID of object that is being animated
        /// </summary>
        public UUID ObjectID
        {
            get { return objectID; }
            set { objectID = value; }
        }

        public Animation()
        {
        }

        /// <summary>
        /// Creates an Animation based on the data
        /// </summary>
        /// <param name="animID">UUID ID of animation</param>
        /// <param name="sequenceNum"></param>
        /// <param name="objectID">ID of object to be animated</param>
        public Animation(UUID animID, int sequenceNum, UUID objectID)
        {
            this.animID = animID;
            this.sequenceNum = sequenceNum;
            this.objectID = objectID;
        }

        /// <summary>
        /// Animation from OSDMap from LLSD XML or LLSD json
        /// </summary>
        /// <param name="args"></param>
        public Animation(OSDMap args)
        {
            UnpackUpdateMessage(args);
        }


        /// <summary>
        /// Pack this object up as an OSDMap for transferring via LLSD XML or LLSD json
        /// </summary>
        /// <returns></returns>
        public OSDMap PackUpdateMessage()
        {
            OSDMap anim = new OSDMap();
            anim["animation"] = OSD.FromUUID(animID);
            anim["object_id"] = OSD.FromUUID(objectID);
            anim["seq_num"] = OSD.FromInteger(sequenceNum);
            return anim;
        }

        /// <summary>
        /// Fill object with data from OSDMap
        /// </summary>
        /// <param name="args"></param>
        public void UnpackUpdateMessage(OSDMap args)
        {
            if (args["animation"] != null)
                animID = args["animation"].AsUUID();
            if (args["object_id"] != null)
                objectID = args["object_id"].AsUUID();
            if (args["seq_num"] != null)
                sequenceNum = args["seq_num"].AsInteger();
        }

        public override bool Equals(object obj)
        {
            Animation other = obj as Animation;
            if (other != null)
            {
                return (other.AnimID.Equals(this.AnimID)
                        && other.SequenceNum == this.SequenceNum
                        && other.ObjectID.Equals(this.ObjectID) );
            }
            return base.Equals(obj);
        }

        public override string ToString()
        {
            return "AnimID=" + AnimID.ToString()
                + "/seq=" + SequenceNum.ToString()
                + "/objID=" + ObjectID.ToString();
        }

    }
}