Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Handles.Label

static function Label(position: Vector3, text: string): void;
static void Label(Vector3 position, string text);
static def Label(position as Vector3, text as string) as void
static function Label(position: Vector3, image: Texture): void;
static void Label(Vector3 position, Texture image);
static def Label(position as Vector3, image as Texture) as void
static function Label(position: Vector3, content: GUIContent): void;
static void Label(Vector3 position, GUIContent content);
static def Label(position as Vector3, content as GUIContent) as void
static function Label(position: Vector3, text: string, style: GUIStyle): void;
static void Label(Vector3 position, string text, GUIStyle style);
static def Label(position as Vector3, text as string, style as GUIStyle) as void
static function Label(position: Vector3, content: GUIContent, style: GUIStyle): void;
static void Label(Vector3 position, GUIContent content, GUIStyle style);
static def Label(position as Vector3, content as GUIContent, style as GUIStyle) as void

Parameters

positionPosition in 3D space as seen from the current handle camera.
textText to display on the label.
imageTexture to display on the label.
contentText, image and tooltip for this label.
styleThe style to use. If left out, the label style from the current GUISkin is used.

Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.

Description

Make a text label positioned in 3D space.

Labels have no user interaction, do not catch mouse clicks and are always rendered in normal style.


Label in the Scene View.

	// Create a 180 degrees wire arc with a ScaleValueHandle attached to the disc
	// that lets you modify the "shieldArea" var in the WireArcExample.js, also
	// lets you visualize some info of the transform
	
	@CustomEditor (DummyLabelScript)
	class LabelHandle extends Editor {
	    function OnSceneGUI () {
	    	Handles.color = Color.blue;
	 		Handles.Label(target.transform.position + Vector3.up*2,
	 				target.transform.position.ToString() + "\nShieldArea: " +
	 				target.shieldArea.ToString());
	 		Handles.BeginGUI(Rect(Screen.width - 100, Screen.height - 80, 90,50));
	
	        Handles.DrawWireArc(target.transform.position, 
	        		target.transform.up, 
	        		-target.transform.right, 
	        		180, 
	        		target.shieldArea);
	        target.shieldArea = 
			Handles.ScaleValueHandle(target.shieldArea,
	        				target.transform.position + target.transform.forward*target.shieldArea,
	        				target.transform.rotation,
	        				1,
	        				Handles.ConeCap,
	        				1);
	    }
	}

And the script attached to this Handle:

	// DummyLavelScript.js
	
	var shieldArea : float = 5;