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.Disc

static function Disc(rotation: Quaternion, position: Vector3, axis: Vector3, size: float, cutoffPlane: bool, snap: float): Quaternion;
static Quaternion Disc(Quaternion rotation, Vector3 position, Vector3 axis, float size, bool cutoffPlane, float snap);
static def Disc(rotation as Quaternion, position as Vector3, axis as Vector3, size as float, cutoffPlane as bool, snap as float) as Quaternion

Parameters

rotationThe rotation of the disc.
positionThe center of the disc.
axisThe axis to rotate around.
sizeThe size of the disc in world space See Also:HandleUtility.GetHandleSize.
cutoffPlaneIf true, only the front-facing half of the circle is draw / draggable. This is useful when you have many overlapping rotation axes (like in the default rotate tool) to avoid clutter.
snapThe new value after the user has modified it.

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

Description

Make a 3D disc that can be dragged with the mouse.


Disc Handle on the Scene View.

	// Create a handle to rotate an object over 45 degrees on X and Y axis
	
	@CustomEditor (DiscValueModifier)
	class DiscHandle extends Editor {
		function OnSceneGUI () {
	        target.rot = 
	        	Handles.Disc(target.rot,
	        			target.transform.position,
	        			Vector3(1,1,0),
	        			5,
	        			false,
	        			1);
	        							
	        if (GUI.changed)
	            EditorUtility.SetDirty (target);
	    }
	}

And the script attached to this Handle:

	// Usage: Place this script on the Game Object you want to modify
	// the handle's rot with the disc
	
	@script ExecuteInEditMode()
	
	var rot : Quaternion = Quaternion.identity;
	
	function Update() {
		transform.rotation = rot;
	}