LanguageEnglish
  • C#
This version of Unity is unsupported.

HandleUtility.DistanceToCube

Leave feedback

Declaration

public static float DistanceToCube(Vector3 position, Quaternion rotation, float size);

Parameters

position Position of the cube.
rotation Rotation of the cube.
size Size of the cube.

Returns

float Distance from mouse to cube in pixels.

Description

Returns the distance in pixels from the mouse pointer to a cube.

Calculates the screen space distance from the mouse pointer to a cube at given world space position with the given rotation and size.

Returns zero when mouse pointer is directly over the cube.

Uses the current camera to determine the distance.

using UnityEngine;
using UnityEditor;

public class ExampleScript : MonoBehaviour
{
}

// Displays cube in scene view, and distance from mouse
// to the cube.
[CustomEditor(typeof(ExampleScript))]
public class ExampleEditor : Editor
{
    public void OnSceneGUI()
    {
        var t = target as ExampleScript;
        var tr = t.transform;
        var position = tr.position;
        var rotation = tr.rotation;
        var size = 1.0f;
        // draw a cube in scene
        Handles.color = Color.yellow;
        Handles.CubeHandleCap(0, position, rotation, size, Event.current.type);
        // calculate distance from mouse to cube, and display it
        var distance = HandleUtility.DistanceToCube(position, rotation, size);
        GUI.color = Color.black;
        Handles.Label(position, distance.ToString("F0"));
        // make scene view repaint on mouse move
        if (Event.current.type == EventType.MouseMove)
            Event.current.Use();
    }
}

.

See Also: DistanceToCircle, DistanceToCone, DistanceToLine.

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2023 Unity Technologies. Publication Date: 2023-04-28.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information