Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.CircleCap

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function CircleCap(controlID: int, position: Vector3, rotation: Quaternion, size: float): void;
public static void CircleCap(int controlID, Vector3 position, Quaternion rotation, float size);

Parameters

controlID The control ID for the handle.
position The world-space position for the start of the handle.
rotation The rotation of the handle.
size The size of the handle in world-space units.

Description

Draw a camera-facing Circle. Pass this into handle functions.

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


Circle Cap in the scene view.

	// Draw one Circle on each axis of any GameObject that
	// has the "DummyCircleCapScript.js" script attached.
	
	@CustomEditor (DummyCircleCapScript)
	class CircleCap extends Editor {
		
		var circleSize : float = 1;
	
	    function OnSceneGUI () {
	    	Handles.color = Color.red;
	    	Handles.CircleCap(0,
	    			target.transform.position + Vector3(5,0,0),
	    			target.transform.rotation,
	    			circleSize);
	    	Handles.color = Color.green;
	    	Handles.CircleCap(0,
	    			target.transform.position + Vector3(0,5,0),
	    			target.transform.rotation,
	    			circleSize);    	
	    	Handles.color = Color.blue;
	    	Handles.CircleCap(0,
	    			target.transform.position + Vector3(0,0,5),
	    			target.transform.rotation,
	    			circleSize);
	    }
	}

And the script attached to this Handle:

	//DummyCircleCapScript.js
	
	Debug.Log("I have CircleCap Handles attached to this transform!");