Slider2D
Make a 3D slider that moves along a plane defined by two axes.
Read time 17 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEditor
- Assembly: UnityEditor
Slider2D(int, Vector3, Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
(optional) override the default ControlID for this Slider2D instance.
The position of the current point in the space of Handles.matrix.
(optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(int, Vector3, Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2, bool)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 offset, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, bool drawHelper)
Parameters
(optional) override the default ControlID for this Slider2D instance.
The position of the current point in the space of Handles.matrix.
(optional) renders the Slider2D at handlePos, but treats the Slider2D's origin as handlePos + offset. Useful for Slider2D instances that are placed/rendered relative to another object or handle.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
(default: false) render a rectangle around the handle when dragging.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2, bool)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, bool drawHelper)
Parameters
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
(default: false) render a rectangle around the handle when dragging.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(int, Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap)
Parameters
(optional) override the default ControlID for this Slider2D instance.
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(int, Vector3, Vector3, Vector3, Vector3, float, CapFunction, Vector2, bool)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(int id, Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, Vector2 snap, bool drawHelper)
Parameters
(optional) override the default ControlID for this Slider2D instance.
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
(default: false) render a rectangle around the handle when dragging.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(Vector3, Vector3, Vector3, Vector3, float, CapFunction, float)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, float snap)
Parameters
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}
Slider2D(Vector3, Vector3, Vector3, Vector3, float, CapFunction, float, bool)
Make a 3D slider that moves along a plane defined by two axes.
public static Vector3 Slider2D(Vector3 handlePos, Vector3 handleDir, Vector3 slideDir1, Vector3 slideDir2, float handleSize, Handles.CapFunction capFunction, float snap, bool drawHelper)
Parameters
The position of the current point in the space of Handles.matrix.
The direction of the handle in the space of Handles.matrix, only used for rendering of the handle.
The first axis of the slider's plane of movement in the space of Handles.matrix.
The second axis of the slider's plane of movement in the space of Handles.matrix.
The size of the handle in the space of Handles.matrix. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
The function to call for doing the actual drawing.
(float or Vector2) The snap increment along both axes, either uniform or per-axis. See Handles.SnapValue.
(default: false) render a rectangle around the handle when dragging.
Returns
Type | Description |
|---|---|
| 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. |
Remarks
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(); } }}