path: root/OpenSim/Region/Environment/Scenes/EntityBase.cs

/*
 * 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 OpenSim 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.Runtime.Serialization;
using System.Security.Permissions;
using Axiom.Math;
using libsecondlife;

namespace OpenSim.Region.Environment.Scenes
{
    [Serializable]
    public abstract class EntityBase : ISerializable
    {
        protected uint m_localId;
        protected string m_name;
        protected LLVector3 m_pos;
        protected Quaternion m_rotation = new Quaternion(0, 0, 1, 0);
        protected LLVector3 m_rotationalvelocity;
        protected Scene m_scene;

        protected LLUUID m_uuid;
        protected LLVector3 m_velocity;

        /// <summary>
        /// Creates a new Entity (should not occur on it's own)
        /// </summary>
        public EntityBase()
        {
            m_uuid = LLUUID.Zero;

            m_pos = new LLVector3();
            m_velocity = new LLVector3();
            Rotation = new Quaternion();
            m_name = "(basic entity)";
            m_rotationalvelocity = new LLVector3(0, 0, 0);
        }

        protected EntityBase(SerializationInfo info, StreamingContext context)
        {
            //System.Console.WriteLine("EntityBase Deserialize BGN");

            if (info == null)
            {
                throw new ArgumentNullException("info");
            }

            m_uuid = new LLUUID((Guid) info.GetValue("m_uuid", typeof (Guid)));
            m_name = (string) info.GetValue("m_name", typeof (string));

            m_pos
                = new LLVector3(
                    (float) info.GetValue("m_pos.X", typeof (float)),
                    (float) info.GetValue("m_pos.Y", typeof (float)),
                    (float) info.GetValue("m_pos.Z", typeof (float)));

            m_velocity
                = new LLVector3(
                    (float) info.GetValue("m_velocity.X", typeof (float)),
                    (float) info.GetValue("m_velocity.Y", typeof (float)),
                    (float) info.GetValue("m_velocity.Z", typeof (float)));

            m_rotationalvelocity
                = new LLVector3(
                    (float) info.GetValue("m_rotationalvelocity.X", typeof (float)),
                    (float) info.GetValue("m_rotationalvelocity.Y", typeof (float)),
                    (float) info.GetValue("m_rotationalvelocity.Z", typeof (float)));

            m_rotation
                = new Quaternion(
                    (float) info.GetValue("m_rotation.w", typeof (float)),
                    (float) info.GetValue("m_rotation.x", typeof (float)),
                    (float) info.GetValue("m_rotation.y", typeof (float)),
                    (float) info.GetValue("m_rotation.z", typeof (float)));

            m_localId = (uint) info.GetValue("m_localId", typeof (uint));

            //System.Console.WriteLine("EntityBase Deserialize END");
        }

        public Scene Scene
        {
            get { return m_scene; }
        }

        public virtual LLUUID UUID
        {
            get { return m_uuid; }
            set { m_uuid = value; }
        }

        /// <summary>
        /// 
        /// </summary>
        public virtual string Name
        {
            get { return m_name; }
            set { m_name = value; }
        }

        /// <summary>
        /// 
        /// </summary>
        public virtual LLVector3 AbsolutePosition
        {
            get { return m_pos; }
            set { m_pos = value; }
        }

        /// <summary>
        /// 
        /// </summary>
        public virtual LLVector3 Velocity
        {
            get { return m_velocity; }
            set { m_velocity = value; }
        }

        public virtual Quaternion Rotation
        {
            get { return m_rotation; }
            set { m_rotation = value; }
        }

        public virtual uint LocalId
        {
            get { return m_localId; }
            set { m_localId = value; }
        }

        #region ISerializable Members

        [SecurityPermission(SecurityAction.LinkDemand,
            Flags = SecurityPermissionFlag.SerializationFormatter)]
        public virtual void GetObjectData(
            SerializationInfo info, StreamingContext context)
        {
            if (info == null)
            {
                throw new ArgumentNullException("info");
            }

            info.AddValue("m_uuid", m_uuid.UUID);
            info.AddValue("m_name", m_name);

            // LLVector3
            info.AddValue("m_pos.X", m_pos.X);
            info.AddValue("m_pos.Y", m_pos.Y);
            info.AddValue("m_pos.Z", m_pos.Z);

            // LLVector3
            info.AddValue("m_velocity.X", m_velocity.X);
            info.AddValue("m_velocity.Y", m_velocity.Y);
            info.AddValue("m_velocity.Z", m_velocity.Z);

            // LLVector3
            info.AddValue("m_rotationalvelocity.X", m_rotationalvelocity.X);
            info.AddValue("m_rotationalvelocity.Y", m_rotationalvelocity.Y);
            info.AddValue("m_rotationalvelocity.Z", m_rotationalvelocity.Z);

            // Quaternion
            info.AddValue("m_rotation.w", m_rotation.w);
            info.AddValue("m_rotation.x", m_rotation.x);
            info.AddValue("m_rotation.y", m_rotation.y);
            info.AddValue("m_rotation.z", m_rotation.z);

            info.AddValue("m_localId", m_localId);
        }

        #endregion

        /// <summary>
        /// 
        /// </summary>
        public abstract void UpdateMovement();

        /// <summary>
        /// Performs any updates that need to be done at each frame.
        /// </summary>
        public abstract void Update();

        /// <summary>
        /// Copies the entity
        /// </summary>
        /// <returns></returns>
        public virtual EntityBase Copy()
        {
            return (EntityBase) MemberwiseClone();
        }


        public abstract void SetText(string text, Vector3 color, double alpha);
    }

    //Nested Classes
    public class EntityIntersection
    {
        public Vector3 AAfaceNormal = new Vector3(0, 0, 0);
        public float distance;
        public int face = -1;
        public bool HitTF;
        public Vector3 ipoint = new Vector3(0, 0, 0);
        public Vector3 normal = new Vector3(0, 0, 0);
        public SceneObjectPart obj;

        public EntityIntersection()
        {
        }

        public EntityIntersection(Vector3 _ipoint, Vector3 _normal, bool _HitTF)
        {
            ipoint = _ipoint;
            normal = _normal;
            HitTF = _HitTF;
        }
    }
}