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

Parent Directory | Revision Log | Patch

--- trunk/gr2lib/core/coretypes/implementation/Texture.cs	2010/07/23 21:08:46	183
+++ trunk/gr2lib/core/coretypes/implementation/Texture.cs	2010/07/23 23:55:52	185
@@ -14,6 +14,9 @@
 
 namespace gr2lib.core.coretypes.implementation
 {
+    /// <summary>
+    /// Represents a Granny_Texture
+    /// </summary>
     public class Texture : ITexture
     {
         private GrannyRigResource _rigResource;
@@ -27,15 +30,24 @@
         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 = "";
@@ -50,6 +62,10 @@
             //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 = "";
@@ -155,24 +171,48 @@
         }
 
         #region ITexture Members
+        /// <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