Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.Disc

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

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

Parameters

rotation The rotation of the disc.
position The center of the disc.
axis The axis to rotate around.
size The size of the disc in world space See Also:HandleUtility.GetHandleSize.
cutoffPlane If 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.
snap The grid size to snap to.

Returns

Quaternion The new rotation value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the same value as you passed into the function.

Description

Make a 3D disc that can be dragged with the mouse. Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.


Disc Handle on the Scene View.

To use this example, save this script in Assets/Editor:


        
using UnityEngine;
using UnityEditor;

[CustomEditor( typeof( DiscHandle ) )] public class DiscHandleEditor : Editor { public float cylinderSize = 1;

void OnSceneGUI( ) { DiscHandle t = target as DiscHandle;

EditorGUI.BeginChangeCheck( ); Quaternion rot = Handles.Disc( t.rot, t.transform.position, new Vector3(1, 1, 0), 5, false, 1 );

if( EditorGUI.EndChangeCheck( ) ) { Undo.RecordObject( target, "Disc Rotate" ); t.rot = rot; t.Update( ); } } }

..and place this script on the object you wish to attach a Disc Handle:


        
using UnityEngine;

[ExecuteInEditMode] public class DiscHandle : MonoBehaviour { public Quaternion rot = Quaternion.identity;

public void Update( ) { transform.rotation = rot; } }