/[gr2lib]/trunk/gr2lib/core/coretypes/implementation/Texture.cs
ViewVC logotype

Diff of /trunk/gr2lib/core/coretypes/implementation/Texture.cs

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

--- trunk/gr2lib/core/coretypes/implementation/Texture.cs	2010/07/22 14:24:07	166
+++ trunk/gr2lib/core/coretypes/implementation/Texture.cs	2010/07/24 06:31:50	191
@@ -14,6 +14,9 @@
 
 namespace gr2lib.core.coretypes.implementation
 {
+    /// <summary>
+    /// Represents a Granny_Texture
+    /// </summary>
     public class Texture : ITexture
     {
         private GrannyRigResource _rigResource;
@@ -27,37 +30,50 @@
         private Layout _Layout;
         private List<Image> _Images;
 
-
+        /// <summary>
+        /// Gets the string representation of this instance
+        /// </summary>
+        /// <returns></returns>
         public override string ToString()
         {
             return this.FromFileName.Name;
         }
 
         //private string _ParentResourceName;
+        /// <summary>
+        /// Get's the parent resource name
+        /// </summary>
         protected internal string ParentResourceName { get { return "Textures"; } }
 
+        /// <summary>
+        /// default constructor
+        /// </summary>
         public Texture()// : base("Textures")
         {
             this.FromFileName = "";
-            this.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.GetGrannyEnumTypeString<granny_texture_type>(granny_texture_type.GrannyColorMapTextureType), granny_texture_type.GrannyColorMapTextureType);
+            this.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_type>(granny_texture_type.GrannyColorMapTextureType), granny_texture_type.GrannyColorMapTextureType);
             this.Width = 0;
             this.Height = 0;
-            this.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.GetGrannyEnumTypeString<granny_texture_encoding>(granny_texture_encoding.GrannyBinkTextureEncoding), granny_texture_encoding.GrannyBinkTextureEncoding);
-            this.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.GetGrannyEnumTypeString<granny_pixel_layout>(granny_pixel_layout.GrannyBGRA8888PixelFormat), granny_pixel_layout.GrannyBGRA8888PixelFormat);
+            this.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_encoding>(granny_texture_encoding.GrannyBinkTextureEncoding), granny_texture_encoding.GrannyBinkTextureEncoding);
+            this.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_pixel_layout>(granny_pixel_layout.GrannyBGRA8888PixelFormat), granny_pixel_layout.GrannyBGRA8888PixelFormat);
             this.Layout = new Layout();
             this.Images = new List<Image>();
             //this.ExtendedData = new IntPtr();
             //this.NativePointer = IntPtr.Zero;
             this._rigResource = new GrannyRigResource();
         }
+        /// <summary>
+        /// default constructor (specifying index)
+        /// </summary>
+        /// <param name="index">the texture's index</param>
         public Texture(int index)
         {
             this.FromFileName = "";
-            this.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.GetGrannyEnumTypeString<granny_texture_type>(granny_texture_type.GrannyColorMapTextureType), granny_texture_type.GrannyColorMapTextureType);
+            this.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_type>(granny_texture_type.GrannyColorMapTextureType), granny_texture_type.GrannyColorMapTextureType);
             this.Width = 0;
             this.Height = 0;
-            this.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.GetGrannyEnumTypeString<granny_texture_encoding>(granny_texture_encoding.GrannyBinkTextureEncoding), granny_texture_encoding.GrannyBinkTextureEncoding);
-            this.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.GetGrannyEnumTypeString<granny_pixel_layout>(granny_pixel_layout.GrannyBGRA8888PixelFormat), granny_pixel_layout.GrannyBGRA8888PixelFormat);
+            this.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_encoding>(granny_texture_encoding.GrannyBinkTextureEncoding), granny_texture_encoding.GrannyBinkTextureEncoding);
+            this.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_pixel_layout>(granny_pixel_layout.GrannyBGRA8888PixelFormat), granny_pixel_layout.GrannyBGRA8888PixelFormat);
             this.Layout = new Layout();
             this.Images = new List<Image>();
             //this.ExtendedData = new IntPtr();
@@ -109,11 +125,11 @@
             {
                 Texture managed = new Texture();
                 managed.FromFileName = native.FromFileName;
-                managed.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.GetGrannyEnumTypeString<granny_texture_type>((granny_texture_type)native.TextureType), (granny_texture_type)native.TextureType);
+                managed.TextureType = new NameValuePair<string, granny_texture_type>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_type>((granny_texture_type)native.TextureType), (granny_texture_type)native.TextureType);
                 managed.Width = native.Width;
                 managed.Height = native.Height;
-                managed.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.GetGrannyEnumTypeString<granny_texture_encoding>((granny_texture_encoding)native.Encoding), (granny_texture_encoding)native.Encoding);
-                managed.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.GetGrannyEnumTypeString<granny_pixel_layout>((granny_pixel_layout)native.SubFormat), (granny_pixel_layout)native.SubFormat);
+                managed.Encoding = new NameValuePair<string, granny_texture_encoding>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_texture_encoding>((granny_texture_encoding)native.Encoding), (granny_texture_encoding)native.Encoding);
+                managed.SubFormat = new NameValuePair<string, granny_pixel_layout>(coreapi.EnumToStringSupport.GetGrannyEnumTypeString<granny_pixel_layout>((granny_pixel_layout)native.SubFormat), (granny_pixel_layout)native.SubFormat);
                 managed.Layout = Layout.ReadFromNative(native.Layout);
                 IntPtr[] images = Helpers.ReadPtrArrayFromMemory<native.Image>(native.Images);
                 int length = images.Length;
@@ -155,73 +171,65 @@
         }
 
         #region ITexture Members
-
-        //[RefreshPropertiesAttribute(RefreshProperties.All)]
-        //public string TextureTypeFormat 
-        //{ 
-        //    get
-        //    {
-        //        string texture_type = "Unknown Texture Type";
-
-        //        foreach (int val in Enum.GetValues(typeof(granny_texture_type)))
-        //        {
-        //            if (val == this.TextureType)
-        //            {
-        //                texture_type = Enum.GetName(typeof(granny_texture_type),val);
-        //                break;
-        //            }
-        //        }
-        //        return texture_type;
-        //    } 
-        //}
-        //[RefreshPropertiesAttribute(RefreshProperties.All)]
-        //public string EncodingFormat
-        //{
-        //    get
-        //    {
-        //        string encodingformat = "Unknown Encoding Format";
-
-        //        foreach (int val in Enum.GetValues(typeof(granny_texture_encoding)))
-        //        {
-        //            if (val == this.Encoding)
-        //            {
-        //                encodingformat = Enum.GetName(typeof(granny_texture_encoding), val);
-        //                break;
-        //            }
-        //        }
-        //        return encodingformat;
-        //    }
-        //}
-
+        /// <summary>
+        /// Get's the texture's name
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         public FilePath FromFileName { get { return _FromFileName; } set { _FromFileName = value; } }
+        /// <summary>
+        /// Get's the texture's type
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         [Editor(typeof(UIComboValueSelector<granny_texture_type, int>), typeof(UITypeEditor))]
         public NameValuePair<string, granny_texture_type> TextureType { get { return _TextureType; } set { _TextureType = value; } }
+        /// <summary>
+        /// Get's the texture's widh
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         public int Width { get { return _Width; } set { _Width = value; } }
+        /// <summary>
+        /// Get's the texture's height
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         public int Height { get { return _Height; } set { _Height = value; } }
+        /// <summary>
+        /// Get's the texture's encoding
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         [Editor(typeof(UIComboValueSelector<granny_texture_encoding, int>), typeof(UITypeEditor))]
         public NameValuePair<string, granny_texture_encoding> Encoding { get { return _Encoding; } set { _Encoding = value; } }
+        /// <summary>
+        /// Get's the texture's subformat
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         [Editor(typeof(UIComboValueSelector<granny_pixel_layout, int>), typeof(UITypeEditor))]
         public NameValuePair<string, granny_pixel_layout> SubFormat { get { return _SubFormat; } set { _SubFormat = value; } }
+        /// <summary>
+        /// Get's the texture's Pixel Layout
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         [Browsable(true)]
         public Layout Layout { get { return _Layout; } set { _Layout = value; } }
+        /// <summary>
+        /// Get a List of Images associated with this texture
+        /// </summary>
         [RefreshPropertiesAttribute(RefreshProperties.All)]
         public List<Image> Images { get { return _Images; } set { _Images = value; } }
         #endregion
 
         #region INativePointer Members
         private IntPtr _NativePointer;
+        /// <summary>
+        /// When used in a derived class, gets the native pointer for this instance
+        /// </summary>
         public IntPtr NativePointer { get { return _NativePointer; } set { _NativePointer = value; } }
         #endregion
 
         #region IExtendedData Members
         private IntPtr _ExtendedData;
+        /// <summary>
+        /// When used in a derived class, gets the ExtendedData pointer for this instance
+        /// </summary>
         public IntPtr ExtendedData { get { return _ExtendedData; } set { _ExtendedData = value; } }
         #endregion
 

 

  ViewVC Help
Powered by ViewVC 1.1.22