ArcHandle

Description

A class for a compound handle to edit an angle and a radius in the Scene view.

ArcHandle in the Scene View.

This class allows you to display control handles for editing the angle and radius of an arc. The arc originates at Vector3.forward multiplied by the radius and rotates around Vector3.up. The handle rendered by this class's DrawHandle method is affected by global state in the Handles class, such as Handles.matrix and Handles.color.

The following component defines an object with an angle and force property.

using UnityEngine;

public class ProjectileExample : MonoBehaviour
{
    public float elevationAngle { get { return m_ElevationAngle; } set { m_ElevationAngle = value; } }
    [SerializeField]
    float m_ElevationAngle = 45f;

    public float impulse { get { return m_Impulse; } set { m_Impulse = value; } }
    [SerializeField]
    float m_Impulse = 20f;

    public Vector3 facingDirection
    {
        get
        {
            Vector3 result = transform.forward;
            result.y = 0f;
            return result.sqrMagnitude == 0f ? Vector3.forward : result.normalized;
        }
    }

    protected virtual void Start()
    {
        GameObject ball = GameObject.CreatePrimitive(PrimitiveType.Sphere);

        Vector3 direction = facingDirection;
        direction = Quaternion.AngleAxis(elevationAngle, Vector3.Cross(direction, Vector3.up)) * direction;
        ball.AddComponent<Rigidbody>().AddForce(direction  * impulse, ForceMode.Impulse);
    }
}

The following Custom Editor example allows you to edit the elevation angle and force properties for this component in the Scene view, where the force is represented by the radius of the handle.

using UnityEditor;
using UnityEditor.IMGUI.Controls;
using UnityEngine;

[CustomEditor(typeof(ProjectileExample))]
public class ProjectileExampleEditor : Editor
{
    ArcHandle m_ArcHandle = new ArcHandle();

    protected virtual void OnEnable()
    {
        // arc handle has no radius handle by default
        m_ArcHandle.SetColorWithRadiusHandle(Color.white, 0.1f);
    }

    // the OnSceneGUI callback uses the Scene view camera for drawing handles by default
    protected virtual void OnSceneGUI()
    {
        ProjectileExample projectileExample = (ProjectileExample)target;

        // copy the target object's data to the handle
        m_ArcHandle.angle = projectileExample.elevationAngle;
        m_ArcHandle.radius = projectileExample.impulse;

        // set the handle matrix so that angle extends upward from target's facing direction along ground
        Vector3 handleDirection = projectileExample.facingDirection;
        Vector3 handleNormal = Vector3.Cross(handleDirection, Vector3.up);
        Matrix4x4 handleMatrix = Matrix4x4.TRS(
            projectileExample.transform.position,
            Quaternion.LookRotation(handleDirection, handleNormal),
            Vector3.one
        );

        using (new Handles.DrawingScope(handleMatrix))
        {
            // draw the handle
            EditorGUI.BeginChangeCheck();
            m_ArcHandle.DrawHandle();
            if (EditorGUI.EndChangeCheck())
            {
                // record the target object before setting new values so changes can be undone/redone
                Undo.RecordObject(projectileExample, "Change Projectile Properties");

                // copy the handle's updated data back to the target object
                projectileExample.elevationAngle = m_ArcHandle.angle;
                projectileExample.impulse = m_ArcHandle.radius;
            }
        }
    }
}

See Also: Editor.OnSceneGUI, Handles.SetCamera.

Variables

Constructors

Public Functions

Static Functions