libremetaverse/libsecondlife-cs/LLObject.cs

/*
 * Copyright (c) 2007, Second Life Reverse Engineering Team
 * All rights reserved.
 *
 * - 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.
 * - Neither the name of the Second Life Reverse Engineering Team 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR 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.Xml;
using System.Xml.Serialization;
using libsecondlife.Packets;

namespace libsecondlife
{
    /// <summary>
    /// Base class for primitives and avatars
    /// </summary>
    [Serializable]
    public abstract partial class LLObject
    {
        #region Enumerations

        /// <summary>
        /// Primary parameters for primitives such as Physics Enabled or Phantom
        /// </summary>
        [Flags]
        public enum ObjectFlags : uint
        {
            /// <summary>None of the primary flags are enabled</summary>
            None = 0,
            /// <summary>Whether physics are enabled for this object</summary>
            Physics = 0x00000001,
            /// <summary></summary>
            CreateSelected = 0x00000002,
            /// <summary></summary>
            ObjectModify = 0x00000004,
            /// <summary></summary>
            ObjectCopy = 0x00000008,
            /// <summary></summary>
            ObjectAnyOwner = 0x00000010,
            /// <summary></summary>
            ObjectYouOwner = 0x00000020,
            /// <summary></summary>
            Scripted = 0x00000040,
            /// <summary>Whether this object contains an active touch script</summary>
            Touch = 0x00000080,
            /// <summary></summary>
            ObjectMove = 0x00000100,
            /// <summary>Whether this object can receive payments</summary>
            Money = 0x00000200,
            /// <summary>Whether this object is phantom (no collisions)</summary>
            Phantom = 0x00000400,
            /// <summary></summary>
            InventoryEmpty = 0x00000800,
            /// <summary></summary>
            JointHinge = 0x00001000,
            /// <summary></summary>
            JointP2P = 0x00002000,
            /// <summary></summary>
            JointLP2P = 0x00004000,
            /// <summary>Deprecated</summary>
            JointWheel = 0x00008000,
            /// <summary></summary>
            AllowInventoryDrop = 0x00010000,
            /// <summary></summary>
            ObjectTransfer = 0x00020000,
            /// <summary></summary>
            ObjectGroupOwned = 0x00040000,
            /// <summary>Deprecated</summary>
            ObjectYouOfficer = 0x00080000,
            /// <summary></summary>
            CameraDecoupled = 0x00100000,
            /// <summary></summary>
            AnimSource = 0x00200000,
            /// <summary></summary>
            CameraSource = 0x00400000,
            /// <summary></summary>
            CastShadows = 0x00800000,
            /// <summary></summary>
            ObjectOwnerModify = 0x10000000,
            /// <summary></summary>
            TemporaryOnRez = 0x20000000,
            /// <summary></summary>
            Temporary = 0x40000000,
            /// <summary></summary>
            ZlibCompressed = 0x80000000
        }

        #endregion Enumerations


        #region Structs

        /// <summary>
        /// 
        /// </summary>
        [Serializable]
        public struct ObjectData
        {
            /// <summary></summary>
            [XmlAttribute("pathtwistbegin")]
            public int PathTwistBegin;
            /// <summary></summary>
            [XmlAttribute("pathend")]
            public float PathEnd;
            /// <summary></summary>
            [XmlAttribute("profilebegin")]
            public float ProfileBegin;
            /// <summary></summary>
            [XmlAttribute("pathradiusoffset")]
            public float PathRadiusOffset;
            /// <summary></summary>
            [XmlAttribute("pathskew")]
            public float PathSkew;
            /// <summary></summary>
            [XmlAttribute("profilecurve")]
            public uint ProfileCurve;
            /// <summary></summary>
            [XmlAttribute("pathscalex")]
            public float PathScaleX;
            /// <summary></summary>
            [XmlAttribute("pathscaley")]
            public float PathScaleY;
            /// <summary></summary>
            [XmlAttribute("material")]
            public uint Material;
            /// <summary></summary>
            [XmlAttribute("pathshearx")]
            public float PathShearX;
            /// <summary></summary>
            [XmlAttribute("pathsheary")]
            public float PathShearY;
            /// <summary></summary>
            [XmlAttribute("pathtaperx")]
            public float PathTaperX;
            /// <summary></summary>
            [XmlAttribute("pathtapery")]
            public float PathTaperY;
            /// <summary></summary>
            [XmlAttribute("profileend")]
            public float ProfileEnd;
            /// <summary></summary>
            [XmlAttribute("pathbegin")]
            public float PathBegin;
            /// <summary></summary>
            [XmlAttribute("pathcurve")]
            public uint PathCurve;
            /// <summary></summary>
            [XmlAttribute("pathtwist")]
            public int PathTwist;
            /// <summary></summary>
            [XmlAttribute("profilehollow")]
            public uint ProfileHollow;
            /// <summary></summary>
            [XmlAttribute("pathrevolutions")]
            public float PathRevolutions;
            /// <summary></summary>
            [XmlAttribute("state")]
            public uint State;
            /// <summary></summary>
            [XmlIgnore]
            public ObjectManager.PCode PCode;
        }

        /// <summary>
        /// 
        /// </summary>
        public struct ObjectProperties
        {
            /// <summary></summary>
            public LLUUID ObjectID;
            /// <summary></summary>
            public LLUUID CreatorID;
            /// <summary></summary>
            public LLUUID OwnerID;
            /// <summary></summary>
            public LLUUID GroupID;
            /// <summary></summary>
            public ulong CreationDate;
            /// <summary></summary>
            public uint BaseMask;
            /// <summary></summary>
            public uint OwnerMask;
            /// <summary></summary>
            public uint GroupMask;
            /// <summary></summary>
            public uint EveryoneMask;
            /// <summary></summary>
            public uint NextOwnerMask;
            /// <summary></summary>
            public int OwnershipCost;
            /// <summary></summary>
            public byte SaleType;
            /// <summary></summary>
            public int SalePrice;
            /// <summary></summary>
            public byte AggregatePerms;
            /// <summary></summary>
            public byte AggregatePermTextures;
            /// <summary></summary>
            public byte AggregatePermTexturesOwner;
            /// <summary></summary>
            public uint Category;
            /// <summary></summary>
            public short InventorySerial;
            /// <summary></summary>
            public LLUUID ItemID;
            /// <summary></summary>
            public LLUUID FolderID;
            /// <summary></summary>
            public LLUUID FromTaskID;
            /// <summary></summary>
            public LLUUID LastOwnerID;
            /// <summary></summary>
            public string Name;
            /// <summary></summary>
            public string Description;
            /// <summary></summary>
            public string TouchName;
            /// <summary></summary>
            public string SitName;
            /// <summary></summary>
            public LLUUID[] TextureIDs;
        }

        /// <summary>
        /// 
        /// </summary>
        public struct ObjectPropertiesFamily
        {
            /// <summary>
            /// 
            /// </summary>
            public enum RequestFlagsType
            {
                /// <summary></summary>
                BugReportRequest = 1,
                /// <summary></summary>
                ComplaintReportRequest = 2
            }

            /// <summary></summary>
            public RequestFlagsType RequestFlags;
            /// <summary></summary>
            public LLUUID ObjectID;
            /// <summary></summary>
            public LLUUID OwnerID;
            /// <summary></summary>
            public LLUUID GroupID;
            /// <summary></summary>
            public uint BaseMask;
            /// <summary></summary>
            public uint OwnerMask;
            /// <summary></summary>
            public uint GroupMask;
            /// <summary></summary>
            public uint EveryoneMask;
            /// <summary></summary>
            public uint NextOwnerMask;
            /// <summary></summary>
            public int OwnershipCost;
            /// <summary></summary>
            public byte SaleType;
            /// <summary></summary>
            public int SalePrice;
            /// <summary></summary>
            public uint Category;
            /// <summary></summary>
            public LLUUID LastOwnerID;
            /// <summary></summary>
            public string Name;
            /// <summary></summary>
            public string Description;
        }

        #endregion Structs


        #region Public Members

        /// <summary></summary>
        public LLUUID ID = LLUUID.Zero;
        /// <summary></summary>
        public LLUUID GroupID = LLUUID.Zero;
        /// <summary></summary>
        public uint LocalID;
        /// <summary></summary>
        public uint ParentID;
        /// <summary></summary>
        public ulong RegionHandle;
        /// <summary></summary>
        public ObjectFlags Flags;
        /// <summary>Unknown</summary>
        public byte[] GenericData;
        /// <summary></summary>
        public LLVector3 Position;
        /// <summary></summary>
        public LLVector3 Scale;
        /// <summary></summary>
        public LLQuaternion Rotation = LLQuaternion.Identity;
        /// <summary></summary>
        public LLVector3 Velocity;
        /// <summary></summary>
        public LLVector3 AngularVelocity;
        /// <summary></summary>
        public LLVector3 Acceleration;
        /// <summary></summary>
        public LLVector4 CollisionPlane;
        /// <summary></summary>
        public TextureEntry Textures;
        /// <summary></summary>
        public ObjectProperties Properties;
        /// <summary></summary>
        public ObjectPropertiesFamily PropertiesFamily;
        /// <summary></summary>
        public SerializableDictionary<string, NameValue> NameValues = new SerializableDictionary<string, NameValue>();

        #endregion Public Members


        #region Public Properties

        /// <summary></summary>
        public ObjectData Data { get { return data; } }

        #endregion Public Properties


        internal ObjectData data = new ObjectData();


        public override bool Equals(object obj)
        {
            LLObject llobj = obj as LLObject;
            if (llobj == null)
                return false;
            return ID.Equals(llobj.ID);
        }

        public override int GetHashCode()
        {
            return ID.GetHashCode();
        }

        #region Static Methods

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathScale"></param>
        /// <returns></returns>
        public static byte PathScaleByte(float pathScale)
        {
            // Y = 100 + 100X
            int scale = (int)Math.Round(100.0f * pathScale);
            return (byte)(100 + scale);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathScale"></param>
        /// <returns></returns>
        public static float PathScaleFloat(byte pathScale)
        {
            // Y = -1 + 0.01X
            return (float)Math.Round((double)pathScale * 0.01d - 1.0d, 6);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathShear"></param>
        /// <returns></returns>
        public static byte PathShearByte(float pathShear)
        {
            // Y = 256 + 100X
            int shear = (int)Math.Round(100.0f * pathShear);
            shear += 256;
            return (byte)(shear % 256);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathShear"></param>
        /// <returns></returns>
        public static float PathShearFloat(byte pathShear)
        {
            if (pathShear == 0) return 0.0f;

            if (pathShear > 150)
            {
                // Negative value
                return ((float)pathShear - 256.0f) / 100.0f;
            }
            else
            {
                // Positive value
                return (float)pathShear / 100.0f;
            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="profileBegin"></param>
        /// <returns></returns>
        public static byte ProfileBeginByte(float profileBegin)
        {
            // Y = ceil (200X)
            return (byte)Math.Round(200.0f * profileBegin);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="profileBegin"></param>
        /// <returns></returns>
        public static float ProfileBeginFloat(byte profileBegin)
        {
            // Y = 0.005X
            return (float)Math.Round((double)profileBegin * 0.005d, 6);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="profileEnd"></param>
        /// <returns></returns>
        public static byte ProfileEndByte(float profileEnd)
        {
            // Y = 200 - 200X
            int end = (int)Math.Round(200.0d * (double)profileEnd);
            return (byte)(200 - end);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="profileEnd"></param>
        /// <returns></returns>
        public static float ProfileEndFloat(byte profileEnd)
        {
            // Y = 1 - 0.005X
            return (float)Math.Round(1.0d - ((double)profileEnd * 0.005d), 6);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathBegin"></param>
        /// <returns></returns>
        public static byte PathBeginByte(float pathBegin)
        {
            // Y = 100X
            return (byte)Convert.ToInt16(100.0f * pathBegin);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathBegin"></param>
        /// <returns></returns>
        public static float PathBeginFloat(byte pathBegin)
        {
            // Y = X / 100
            return (float)pathBegin / 100.0f;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathEnd"></param>
        /// <returns></returns>
        public static byte PathEndByte(float pathEnd)
        {
            // Y = 100 - 100X
            int end = (int)Math.Round(100.0f * pathEnd);
            return (byte)(100 - end);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathEnd"></param>
        /// <returns></returns>
        public static float PathEndFloat(byte pathEnd)
        {
            // Y = 1 - X / 100
            return 1.0f - (float)pathEnd / 100.0f;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathRadiusOffset"></param>
        /// <returns></returns>
        public static sbyte PathRadiusOffsetByte(float pathRadiusOffset)
        {
            // Y = 256 + 100X
            return (sbyte)PathShearByte(pathRadiusOffset);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathRadiusOffset"></param>
        /// <returns></returns>
        public static float PathRadiusOffsetFloat(sbyte pathRadiusOffset)
        {
            // Y = X / 100
            return (float)pathRadiusOffset / 100.0f;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathRevolutions"></param>
        /// <returns></returns>
        public static byte PathRevolutionsByte(float pathRevolutions)
        {
            // Y = 66.5X - 66
            int revolutions = (int)Math.Round(66.5d * (double)pathRevolutions);
            return (byte)(revolutions - 66);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathRevolutions"></param>
        /// <returns></returns>
        public static float PathRevolutionsFloat(byte pathRevolutions)
        {
            // Y = 1 + 0.015X
            return (float)Math.Round(1.0d + (double)pathRevolutions * 0.015d, 6);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathSkew"></param>
        /// <returns></returns>
        public static sbyte PathSkewByte(float pathSkew)
        {
            return PathTaperByte(pathSkew);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathSkew"></param>
        /// <returns></returns>
        public static float PathSkewFloat(sbyte pathSkew)
        {
            return PathTaperFloat(pathSkew);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathTaper"></param>
        /// <returns></returns>
        public static sbyte PathTaperByte(float pathTaper)
        {
            // Y = 256 + 100X
            return (sbyte)PathShearByte(pathTaper);
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="pathTaper"></param>
        /// <returns></returns>
        public static float PathTaperFloat(sbyte pathTaper)
        {
            return (float)pathTaper / 100.0f;
        }

        #endregion Static Methods
    }
}