From 16e0dfe693134ef104e7db9040d89082230b657a Mon Sep 17 00:00:00 2001
From: BlackMATov <blackmatov@gmail.com>
Date: Tue, 13 Jan 2015 23:39:28 +0600
Subject: [PATCH] add function comments

---
 Assets/IsoTools/Scripts/IsoObject.cs |  5 +++-
 Assets/IsoTools/Scripts/IsoWorld.cs  | 38 +++++++++++++++++++++++++---
 UnityIso-csharp.sln                  |  2 +-
 UnityIso.sln                         |  2 +-
 UnityIso.userprefs                   | 10 +++-----
 5 files changed, 44 insertions(+), 13 deletions(-)

diff --git a/Assets/IsoTools/Scripts/IsoObject.cs b/Assets/IsoTools/Scripts/IsoObject.cs
index bee10d5..583ddca 100644
--- a/Assets/IsoTools/Scripts/IsoObject.cs
+++ b/Assets/IsoTools/Scripts/IsoObject.cs
@@ -11,6 +11,7 @@ public class IsoObject : MonoBehaviour {
 
 	[SerializeField]
 	Vector3 _position = Vector3.zero;
+	/// <summary>Isometric object position.</summary>
 	public Vector3 Position {
 		get { return _position; }
 		set {
@@ -29,6 +30,7 @@ public class IsoObject : MonoBehaviour {
 
 	[SerializeField]
 	Vector3 _size = Vector3.one;
+	/// <summary>Isometric object size.</summary>
 	public Vector3 Size {
 		get { return _size; }
 		set {
@@ -46,7 +48,8 @@ public class IsoObject : MonoBehaviour {
 	}
 
 	[SerializeField]
-	bool _alignment = true;	
+	bool _alignment = true;
+	/// <summary>Auto alignment position by isometric tile size.</summary>
 	public bool Alignment {
 		get { return _alignment; }
 		set {
diff --git a/Assets/IsoTools/Scripts/IsoWorld.cs b/Assets/IsoTools/Scripts/IsoWorld.cs
index 22ca392..9a0a3fb 100644
--- a/Assets/IsoTools/Scripts/IsoWorld.cs
+++ b/Assets/IsoTools/Scripts/IsoWorld.cs
@@ -4,9 +4,12 @@ using System.Collections.Generic;
 namespace IsoTools {
 [ExecuteInEditMode]
 public class IsoWorld : MonoBehaviour {
-
+	
+	/// <summary>Isometric tile size.</summary>
 	public float TileSize   = 32.0f;
+	/// <summary>Start sorting depth value.</summary>
 	public float StartDepth = 0.0f;
+	/// <summary>Step sorting depth value.</summary>
 	public float StepDepth  = 0.1f;
 
 	class ObjectInfo {
@@ -28,24 +31,51 @@ public class IsoWorld : MonoBehaviour {
 	List<int>        _depends      = new List<int>();
 	List<ObjectInfo> _objects      = new List<ObjectInfo>();
 	float            _lastTileSize = 0.0f;
-
+	
+	// ------------------------------------------------------------------------
+	/// <summary>
+	/// Marks world for resorting.
+	/// </summary>
+	// ------------------------------------------------------------------------
 	public void MarkDirty() {
 		_dirty = true;
 	}
 	
+	// ------------------------------------------------------------------------
+	/// <summary>
+	/// Convert isometric coordinates to screen coordinates
+	/// </summary>
+	/// <returns>Screen coordinates</returns>
+	/// <param name="pos">Isometric coordinates.</param>
+	// ------------------------------------------------------------------------
 	public Vector2 IsoToScreen(Vector3 pos) {
 		return new Vector2(
 			(pos.x - pos.y),
 			(pos.x + pos.y) * 0.5f + pos.z) * TileSize;
 	}
-
+	
+	// ------------------------------------------------------------------------
+	/// <summary>
+	/// Convert screen coordinates to isometric coordinates
+	/// </summary>
+	/// <returns>Isometric coordinates</returns>
+	/// <param name="pos">Screen coordinates.</param>
+	// ------------------------------------------------------------------------
 	public Vector3 ScreenToIso(Vector2 pos) {
 		return new Vector3(
 			(pos.x * 0.5f + pos.y),
 			(pos.y - pos.x * 0.5f),
 			0.0f) / TileSize;
 	}
-
+	
+	// ------------------------------------------------------------------------
+	/// <summary>
+	/// Convert screen coordinates to isometric coordinates with specified isometric height
+	/// </summary>
+	/// <returns>Isometric coordinates</returns>
+	/// <param name="pos">Screen coordinates.</param>
+	/// <param name="iso_z">Point isometric height.</param>
+	// ------------------------------------------------------------------------
 	public Vector3 ScreenToIso(Vector2 pos, float iso_z) {
 		var iso_pos = ScreenToIso(new Vector2(pos.x, pos.y - iso_z * TileSize));
 		iso_pos.z = iso_z;
diff --git a/UnityIso-csharp.sln b/UnityIso-csharp.sln
index 4670fd3..3d9f2e7 100644
--- a/UnityIso-csharp.sln
+++ b/UnityIso-csharp.sln
@@ -17,7 +17,7 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
-																																		GlobalSection(MonoDevelopProperties) = preSolution
+																																						GlobalSection(MonoDevelopProperties) = preSolution
 		StartupItem = Assembly-CSharp.csproj
 		Policies = $0
 		$0.TextStylePolicy = $1
diff --git a/UnityIso.sln b/UnityIso.sln
index 0dafd5a..6a04c6c 100644
--- a/UnityIso.sln
+++ b/UnityIso.sln
@@ -17,7 +17,7 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
-																																	GlobalSection(MonoDevelopProperties) = preSolution
+																																					GlobalSection(MonoDevelopProperties) = preSolution
 		StartupItem = Assembly-CSharp.csproj
 		Policies = $0
 		$0.TextStylePolicy = $1
diff --git a/UnityIso.userprefs b/UnityIso.userprefs
index 2e712bd..87e6343 100644
--- a/UnityIso.userprefs
+++ b/UnityIso.userprefs
@@ -1,11 +1,9 @@
 <Properties>
-  <MonoDevelop.Ide.Workspace ActiveConfiguration="Debug" />
-  <MonoDevelop.Ide.Workbench ActiveDocument="Assets\IsoTools\Examples\Scripts\IsoController.cs">
+  <MonoDevelop.Ide.Workspace ActiveConfiguration="Debug" PreferredExecutionTarget="MonoDevelop.Default" />
+  <MonoDevelop.Ide.Workbench ActiveDocument="Assets\IsoTools\Scripts\IsoObject.cs">
     <Files>
-      <File FileName="Assets\IsoTools\Examples\Scripts\IsoController.cs" Line="30" Column="35" />
-      <File FileName="Assets\IsoTools\Scripts\IsoObject.cs" Line="18" Column="22" />
-      <File FileName="Assets\IsoTools\Scripts\IsoWorld.cs" Line="14" Column="28" />
-      <File FileName="Assets\IsoTools\Examples\Scripts\IsoAutoController.cs" Line="4" Column="1" />
+      <File FileName="Assets\IsoTools\Scripts\IsoObject.cs" Line="137" Column="14" />
+      <File FileName="Assets\IsoTools\Scripts\IsoWorld.cs" Line="67" Column="57" />
     </Files>
   </MonoDevelop.Ide.Workbench>
   <MonoDevelop.Ide.DebuggingService.Breakpoints>