Handles.Slider2D

Parameters

Returns

Vector3 The new value modified by the user's interaction with the handle. If the user has not moved the handle, it will return the position value passed into the function.

Description

Make a 3D slider that moves along a plane defined by two axes.

This method will draw a 3D-draggable handle on the screen. The handle is constrained to sliding along a plane in 3D space.


2D slider handle in the Scene View.

Add the following script to your Assets folder as Slider2DExample.cs and add the Slider2DExample component to an object in a scene.

using UnityEngine;

[ExecuteInEditMode]
public class Slider2DExample : MonoBehaviour
{
    public Vector3 targetPosition { get { return m_TargetPosition; } set { m_TargetPosition = value; } }
    [SerializeField]
    private Vector3 m_TargetPosition = new Vector3(1f, 0f, 2f);

    public virtual void Update()
    {
        transform.LookAt(m_TargetPosition);
    }
}

Add the following script to Assets/Editor as Slider2DExampleEditor.cs and select the object with the Slider2DExample component.

using UnityEditor;
using UnityEngine;

[CustomEditor(typeof(Slider2DExample)), CanEditMultipleObjects]
public class Slider2DExampleEditor : Editor
{
    protected virtual void OnSceneGUI()
    {
        Slider2DExample example = (Slider2DExample)target;

        float size = HandleUtility.GetHandleSize(example.targetPosition) * 0.5f;
        float snap = 0.1f;
        Vector3 handleDirection = Vector3.up;

        EditorGUI.BeginChangeCheck();
        Vector3 newTargetPosition = Handles.Slider2D(example.targetPosition, handleDirection, Vector3.right, Vector3.forward, size, Handles.CircleHandleCap, snap);
        if (EditorGUI.EndChangeCheck())
        {
            Undo.RecordObject(example, "Change Look At Target Position");
            example.targetPosition = newTargetPosition;
            example.Update();
        }
    }
}