Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CalcLineTranslation(Vector2, Vector2, Vector3, Vector3)

Map a mouse drag onto a movement along a line in 3D space.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor
public static float CalcLineTranslation(Vector2 src, Vector2 dest, Vector3 srcPosition, Vector3 constraintDir)

Parameters

The source point of the drag.

The destination point of the drag.

srcPosition

The 3D position the dragged object had at src ray.

constraintDir

Normalized 3D direction of constrained movement.

Returns

Type

Description

floatThe distance travelled along constraintDir.

Remarks

Certain types of Handles (such as arrows) involve movement along a line in 3D space. For example, the Transform's position arrows move the object along its local X, Y or Z axis as the mouse is dragged. The CalcLineTranslation function converts the movement of the mouse into constrained movement along a 3D line in the familiar way used by Unity's built-in tools.