Tobias Bohnen avatar Tobias Bohnen committed 147b8f2

* doc update

Comments (0)

Files changed (6)

Projects/Miyagi/Common/Data/ColourDefinition.cs

         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ColourDefinition"/> struct for <see cref="Quad"/> primitives.
+        /// Initializes a new instance of the <see cref="ColourDefinition"/> struct for <see cref="Quad"/> quads.
         /// </summary>
         /// <param name="topColour">The top colour.</param>
         /// <param name="bottomColour">The bottom colour.</param>

Projects/Miyagi/Common/Rendering/Quad.cs

-using System;
-/*
+/*
  Miyagi v1.3.0
  Copyright (c) 2008 - 2011 Tobias Bohnen
 
  */
 namespace Miyagi.Common.Rendering
 {
+    using System;
     using System.Diagnostics;
 
     using Miyagi.Common.Data;
     using Miyagi.Internals.ThirdParty;
 
     /// <summary>
-    /// Represents a render primitive.
+    /// Represents a quad.
     /// </summary>
     public sealed class Quad
     {
             this.scaleFactor = new PointF(1, 1);
             this.VertexColours = new Colour[size];
             this.VertexUV = new PointF[size];
-            this.VertexPositions = new PointF[size];            
-            
+            this.VertexPositions = new PointF[size];
+
             this.TransformedVertexPositions = new PointF[size];
             this.croppedVertexPos = new PointF[size];
             this.croppedVertexUV = new PointF[size];
-            this.SetVertexColours(Colours.White);     
+            this.SetVertexColours(Colours.White);
         }
 
         /// <summary>
                     : this.VertexPositions;
             }
         }
+
         /// <summary>
         /// Gets the uv-coordinates of the verticies.
         /// </summary>
         /// </summary>
         /// <param name="x">The x-coordinate.</param>
         /// <param name="y">The y-coordinate.</param>
-        /// <returns><c>true</c> if the primitive is hit; otherwise, <c>false</c>.</returns>
+        /// <returns><c>true</c> if the quad is hit; otherwise, <c>false</c>.</returns>
         public bool HitTest(float x, float y)
         {
             if (this.Width == 0 || this.Height == 0)

Projects/Miyagi/Common/Rendering/Sprite.cs

         /// Initializes a new instance of the Sprite class.
         /// </summary>
         /// <param name="spriteRenderer">The owning <see cref="ISpriteRenderer"/>.</param>
-        /// <param name="quads">The primitives.</param>
+        /// <param name="quads">The quads.</param>
         public Sprite(ISpriteRenderer spriteRenderer, params Quad[] quads)
         {
             ThrowHelper.CheckArgumentNull(spriteRenderer, "spriteRenderer");
         }
 
         /// <summary>
-        /// Gets the primitive count.
+        /// Gets number of quads.
         /// </summary>
         public int QuadCount
         {
         #region Public Methods
 
         /// <summary>
-        /// Gets the primitive at the specified index.
+        /// Gets the quad at the specified index.
         /// </summary>
         /// <param name="index">The index.</param>
-        /// <returns>The primitive at the specified index.</returns>
+        /// <returns>The quad at the specified index.</returns>
         /// <exception cref="ArgumentOutOfRangeException"><c>index</c> is out of range.</exception>
         public Quad GetQuad(int index)
         {
         /// </summary>
         /// <param name="x">The x-coordinate.</param>
         /// <param name="y">The y-coordinate.</param>
-        /// <returns><c>true</c> if the primitive is hit; otherwise, <c>false</c>.</returns>
+        /// <returns><c>true</c> if the quad is hit; otherwise, <c>false</c>.</returns>
         protected Quad HitTest(float x, float y)
         {
             for (int i = 0; i < this.quads.Length; i++)

Projects/Miyagi/TwoD/TwoDManager.cs

     /// </summary>
     public class TwoDManager : IManager
     {
-        #region Fields
-
-        #endregion Fields
-
         #region Constructors
 
         /// <summary>

Projects/Miyagi/UI/ModalGUI.cs

         public DialogResult ShowDialog()
         {
             this.DialogResult = DialogResult.None;
-            
+
             if (this.GUIManager == null || this.Visible)
             {
                 return DialogResult.None;
                     return DialogResult.None;
                 }
             }
-            
+
             this.Hide();
             return this.DialogResult;
         }

Projects/Miyagi/UI/UISprite.cs

         /// <param name="p">The coordinate.</param>
         /// <param name="pixelPerfect">if set to <c>true</c> performs a pixel-perfect hit test.</param>
         /// <returns>
-        /// <c>true</c> if the primitive is hit; otherwise, <c>false</c>.
+        /// <c>true</c> if the quad is hit; otherwise, <c>false</c>.
         /// </returns>
         public bool HitTest(Point p, bool pixelPerfect)
         {
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.