Skip to content

Instantly share code, notes, and snippets.

@edwardrowe
Last active July 17, 2023 00:11
Show Gist options
  • Save edwardrowe/acda1ee53eb037b31d54d583afc13973 to your computer and use it in GitHub Desktop.
Save edwardrowe/acda1ee53eb037b31d54d583afc13973 to your computer and use it in GitHub Desktop.
Unity - Draw Icon on GameObject in Hierarchy
/*The MIT License (MIT)
Copyright (c) 2016 Edward Rowe (@edwardlrowe)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
using System.Collections;
using RedBlueGames.Tools;
using UnityEngine;
/// <summary>
/// Simple component that allows users to write comments to place on MonoBehaviours. Mainly for testmaps.
/// </summary>
public class Comment : MonoBehaviour
{
[BackingFieldTooltip("Body")]
[TextArea]
[SerializeField]
private string body;
/// <summary>
/// Gets or sets the body of the comment, mainly used for display of information on test maps.
/// </summary>
/// <value>The body.</value>
public string Body
{
get
{
return this.comment;
}
set
{
comment = value;
}
}
}
/*The MIT License (MIT)
Copyright (c) 2016 Edward Rowe (@edwardlrowe)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
using UnityEditor;
using UnityEngine;
/// <summary>
/// Draws a Comment Icon on GameObjects in the Hierarchy that contain the Comment component.
/// </summary>
[InitializeOnLoad]
public class CommentHierarchyIcon
{
private static readonly Texture2D Icon;
static CommentHierarchyIcon()
{
Icon = AssetDatabase.LoadAssetAtPath("Assets/Gizmos/CommentIcon.png", typeof(Texture2D)) as Texture2D;
if (Icon == null)
{
return;
}
EditorApplication.hierarchyWindowItemOnGUI += DrawIconOnWindowItem;
}
private static void DrawIconOnWindowItem(int instanceID, Rect rect)
{
if (Icon == null)
{
return;
}
GameObject gameObject = EditorUtility.InstanceIDToObject(instanceID) as GameObject;
if (gameObject == null)
{
return;
}
var comment = gameObject.GetComponent<Comment>();
if (comment != null && !string.IsNullOrEmpty(comment.Body))
{
float iconWidth = 15;
EditorGUIUtility.SetIconSize(new Vector2(iconWidth, iconWidth));
var padding = new Vector2(5, 0);
var iconDrawRect = new Rect(
rect.xMax - (iconWidth + padding.x),
rect.yMin,
rect.width,
rect.height);
var iconGUIContent = new GUIContent(Icon);
EditorGUI.LabelField(iconDrawRect, iconGUIContent);
EditorGUIUtility.SetIconSize(Vector2.zero);
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment