123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490 |
- using System;
- using System.Collections.Generic;
- using System.Linq;
-
- namespace UnityEngine.Tilemaps
- {
- [Serializable]
- internal enum GridInformationType
- {
- Integer,
- String,
- Float,
- Double,
- UnityObject,
- Color
- }
-
- /// <summary>
- /// A simple MonoBehaviour that stores and provides information based on Grid positions and keywords.
- /// </summary>
- [Serializable]
- [HelpURL("https://docs.unity3d.com/Packages/com.unity.2d.tilemap.extras@latest/index.html?subfolder=/manual/GridInformation.html")]
- [AddComponentMenu("Tilemap/Grid Information")]
- public class GridInformation : MonoBehaviour, ISerializationCallbackReceiver
- {
- [Serializable]
- internal struct GridInformationValue
- {
- public GridInformationType type;
- public object data;
- }
-
- [Serializable]
- internal struct GridInformationKey : IEquatable<GridInformationKey>
- {
- public Vector3Int position;
- public String name;
-
- public bool Equals(GridInformationKey key)
- {
- return position == key.position && name == key.name;
- }
-
- public override int GetHashCode()
- {
- return HashCode.Combine(position.GetHashCode(), name.GetHashCode());
- }
- }
-
- private Dictionary<GridInformationKey, GridInformationValue> m_PositionProperties = new Dictionary<GridInformationKey, GridInformationValue>();
- internal Dictionary<GridInformationKey, GridInformationValue> PositionProperties
- {
- get { return m_PositionProperties; }
- }
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionIntKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<int> m_PositionIntValues = new List<int>();
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionStringKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<String> m_PositionStringValues = new List<String>();
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionFloatKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<float> m_PositionFloatValues = new List<float>();
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionDoubleKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<Double> m_PositionDoubleValues = new List<Double>();
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionObjectKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<Object> m_PositionObjectValues = new List<Object>();
-
- [SerializeField]
- [HideInInspector]
- private List<GridInformationKey> m_PositionColorKeys = new List<GridInformationKey>();
-
- [SerializeField]
- [HideInInspector]
- private List<Color> m_PositionColorValues = new List<Color>();
-
- /// <summary>
- /// Callback before serializing this GridInformation
- /// </summary>
- void ISerializationCallbackReceiver.OnBeforeSerialize()
- {
- Grid grid = GetComponentInParent<Grid>();
- if (grid == null)
- return;
-
- m_PositionIntKeys.Clear();
- m_PositionIntValues.Clear();
- m_PositionStringKeys.Clear();
- m_PositionStringValues.Clear();
- m_PositionFloatKeys.Clear();
- m_PositionFloatValues.Clear();
- m_PositionDoubleKeys.Clear();
- m_PositionDoubleValues.Clear();
- m_PositionObjectKeys.Clear();
- m_PositionObjectValues.Clear();
- m_PositionColorKeys.Clear();
- m_PositionColorValues.Clear();
-
- foreach (var kvp in m_PositionProperties)
- {
- switch (kvp.Value.type)
- {
- case GridInformationType.Integer:
- m_PositionIntKeys.Add(kvp.Key);
- m_PositionIntValues.Add((int)kvp.Value.data);
- break;
- case GridInformationType.String:
- m_PositionStringKeys.Add(kvp.Key);
- m_PositionStringValues.Add(kvp.Value.data as String);
- break;
- case GridInformationType.Float:
- m_PositionFloatKeys.Add(kvp.Key);
- m_PositionFloatValues.Add((float)kvp.Value.data);
- break;
- case GridInformationType.Double:
- m_PositionDoubleKeys.Add(kvp.Key);
- m_PositionDoubleValues.Add((double)kvp.Value.data);
- break;
- case GridInformationType.Color:
- m_PositionColorKeys.Add(kvp.Key);
- m_PositionColorValues.Add((Color)kvp.Value.data);
- break;
- default:
- m_PositionObjectKeys.Add(kvp.Key);
- m_PositionObjectValues.Add(kvp.Value.data as Object);
- break;
- }
- }
- }
-
- /// <summary>
- /// Callback after deserializing this GridInformation
- /// </summary>
- void ISerializationCallbackReceiver.OnAfterDeserialize()
- {
- m_PositionProperties.Clear();
- for (int i = 0; i != Math.Min(m_PositionIntKeys.Count, m_PositionIntValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.Integer;
- positionValue.data = m_PositionIntValues[i];
- m_PositionProperties.Add(m_PositionIntKeys[i], positionValue);
- }
- for (int i = 0; i != Math.Min(m_PositionStringKeys.Count, m_PositionStringValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.String;
- positionValue.data = m_PositionStringValues[i];
- m_PositionProperties.Add(m_PositionStringKeys[i], positionValue);
- }
- for (int i = 0; i != Math.Min(m_PositionFloatKeys.Count, m_PositionFloatValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.Float;
- positionValue.data = m_PositionFloatValues[i];
- m_PositionProperties.Add(m_PositionFloatKeys[i], positionValue);
- }
- for (int i = 0; i != Math.Min(m_PositionDoubleKeys.Count, m_PositionDoubleValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.Double;
- positionValue.data = m_PositionDoubleValues[i];
- m_PositionProperties.Add(m_PositionDoubleKeys[i], positionValue);
- }
- for (int i = 0; i != Math.Min(m_PositionObjectKeys.Count, m_PositionObjectValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.UnityObject;
- positionValue.data = m_PositionObjectValues[i];
- m_PositionProperties.Add(m_PositionObjectKeys[i], positionValue);
- }
- for (int i = 0; i != Math.Min(m_PositionColorKeys.Count, m_PositionColorValues.Count); i++)
- {
- GridInformationValue positionValue;
- positionValue.type = GridInformationType.Color;
- positionValue.data = m_PositionColorValues[i];
- m_PositionProperties.Add(m_PositionColorKeys[i], positionValue);
- }
- }
-
- /// <summary>
- /// This is not supported.
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <typeparam name="T">Type of the information to set</typeparam>
- /// <returns>Whether the information was set</returns>
- /// <exception cref="NotImplementedException">This is not implemented as only concrete Types are supported</exception>
- public bool SetPositionProperty<T>(Vector3Int position, String name, T positionProperty)
- {
- throw new NotImplementedException("Storing this type is not accepted in GridInformation");
- }
-
- /// <summary>
- /// Stores int information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, int positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.Integer, positionProperty);
- }
-
- /// <summary>
- /// Stores string information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, string positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.String, positionProperty);
- }
-
- /// <summary>
- /// Stores float information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, float positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.Float, positionProperty);
- }
-
- /// <summary>
- /// Stores double information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, double positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.Double, positionProperty);
- }
-
- /// <summary>
- /// Stores UnityEngine.Object information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, UnityEngine.Object positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.UnityObject, positionProperty);
- }
-
- /// <summary>
- /// Stores color information at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to store information for</param>
- /// <param name="name">Property name to store information for</param>
- /// <param name="positionProperty">The information to be stored at the position</param>
- /// <returns>Whether the information was set</returns>
- public bool SetPositionProperty(Vector3Int position, String name, Color positionProperty)
- {
- return SetPositionProperty(position, name, GridInformationType.Color, positionProperty);
- }
-
- private bool SetPositionProperty(Vector3Int position, String name, GridInformationType dataType, System.Object positionProperty)
- {
- Grid grid = GetComponentInParent<Grid>();
- if (grid != null && positionProperty != null)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- positionValue.type = dataType;
- positionValue.data = positionProperty;
-
- m_PositionProperties[positionKey] = positionValue;
- return true;
- }
- return false;
- }
-
- /// <summary>
- /// Retrieves information stored at the given position with the given property name as the given Type
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default value if property does not exist at the given position</param>
- /// <typeparam name="T">Type of the information to retrieve</typeparam>
- /// <returns>The information stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not the given Type</exception>
- public T GetPositionProperty<T>(Vector3Int position, String name, T defaultValue) where T : UnityEngine.Object
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.UnityObject)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return positionValue.data as T;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Retrieves int information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default int if property does not exist at the given position</param>
- /// <returns>The int stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not a int</exception>
- public int GetPositionProperty(Vector3Int position, String name, int defaultValue)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.Integer)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return (int)positionValue.data;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Retrieves string information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default string if property does not exist at the given position</param>
- /// <returns>The string stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not a string</exception>
- public string GetPositionProperty(Vector3Int position, String name, string defaultValue)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.String)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return (string)positionValue.data;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Retrieves float information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default float if property does not exist at the given position</param>
- /// <returns>The float stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not a float</exception>
- public float GetPositionProperty(Vector3Int position, String name, float defaultValue)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.Float)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return (float)positionValue.data;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Retrieves double information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default double if property does not exist at the given position</param>
- /// <returns>The double stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not a double</exception>
- public double GetPositionProperty(Vector3Int position, String name, double defaultValue)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.Double)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return (double)positionValue.data;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Retrieves Color information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to retrieve information for</param>
- /// <param name="name">Property name to retrieve information for</param>
- /// <param name="defaultValue">Default color if property does not exist at the given position</param>
- /// <returns>The color stored at the position</returns>
- /// <exception cref="InvalidCastException">Thrown when information to be retrieved is not a Color</exception>
- public Color GetPositionProperty(Vector3Int position, String name, Color defaultValue)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
-
- GridInformationValue positionValue;
- if (m_PositionProperties.TryGetValue(positionKey, out positionValue))
- {
- if (positionValue.type != GridInformationType.Color)
- throw new InvalidCastException("Value stored in GridInformation is not of the right type");
- return (Color)positionValue.data;
- }
- return defaultValue;
- }
-
- /// <summary>
- /// Erases information stored at the given position with the given property name
- /// </summary>
- /// <param name="position">Position to erase</param>
- /// <param name="name">Property name to erase</param>
- /// <returns>Whether the information was erased</returns>
- public bool ErasePositionProperty(Vector3Int position, String name)
- {
- GridInformationKey positionKey;
- positionKey.position = position;
- positionKey.name = name;
- return m_PositionProperties.Remove(positionKey);
- }
-
- /// <summary>
- /// Clears all information stored
- /// </summary>
- public virtual void Reset()
- {
- m_PositionProperties.Clear();
- }
-
- /// <summary>
- /// Gets all positions with information with the given property name
- /// </summary>
- /// <param name="propertyName">Property name to search for</param>
- /// <returns>An array of all positions with the property name</returns>
- public Vector3Int[] GetAllPositions(string propertyName)
- {
- return m_PositionProperties.Keys.ToList().FindAll(x => x.name == propertyName).Select(x => x.position).ToArray();
- }
- }
- }
|