Vector2
Representation of 2D vectors and points.
Read time 3 minutesLast updated 5 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Implements: IEquatable<Vector2>, IFormattable
public struct Vector2 : IEquatable<Vector2>, IFormattable
Remarks
This structure is used in some places to represent 2D positions and vectors (e.g. texture coordinates in a Mesh or texture offsets in Material). In the majority of other cases a Vector3 is used.
Fields
Constructors
Constructor | Description |
|---|---|
| Vector2(System.Single,System.Single) | Constructs a new vector with given x, y components. |
Properties
Property | Description |
|---|---|
| this[] | Access the x or y component using [0] or [1] respectively. |
| magnitude | Returns the length of this vector (Read Only). |
| normalized | Returns a normalized vector based on the current vector. The normalized vector has a Vector2.magnitude of 1 and is in the same direction as the current vector. Returns a zero vector If the current vector is too small to be normalized. |
| sqrMagnitude | Returns the squared length of this vector (Read Only). |
Static Properties
Property | Description |
|---|---|
| down | Shorthand for writing |
| left | Shorthand for writing |
| negativeInfinity | Shorthand for writing |
| one | Shorthand for writing |
| positiveInfinity | Shorthand for writing |
| right | Shorthand for writing |
| up | Shorthand for writing |
| zero | Shorthand for writing |
Methods
Method | Description |
|---|---|
| Equals | Determines if the given vector is exactly equal to this vector. |
| Normalize | Makes this vector have a Vector2.magnitude of 1. |
| Scale | Multiplies every component of this vector by the same component of |
| Set | Set x and y components of an existing Vector2. |
| ToString | Formats this vector as a string. |
Static Methods
Method | Description |
|---|---|
| Angle | Gets the unsigned angle in degrees between from and to. |
| ClampMagnitude | Creates a copy of a given vector, with its magnitude clamped to a maximum length. |
| Distance | Returns the distance between a and b. |
| Dot | Calculates the dot product of two vectors. |
| Lerp | Linearly interpolates between vectors |
| LerpUnclamped | Linearly interpolates between vectors |
| Max | Creates a vector that is made from the largest components of two vectors. |
| Min | Creates a vector that is made from the smallest components of two vectors. |
| MoveTowards | Moves a point |
| Perpendicular | Returns the 2D vector perpendicular to this 2D vector. The result is always rotated 90-degrees in a counter-clockwise direction for a 2D coordinate system where the positive Y axis goes up. |
| Reflect | Reflects a vector off the surface defined by a normal. |
| Scale | Multiplies two vectors component-wise. |
| SignedAngle | Gets the signed angle in degrees between from and to. |
| SmoothDamp | Gradually changes a vector towards a desired goal over time. |
Operators
Operator | Description |
|---|---|
| operator + | Adds two vectors. |
| operator / | Divides a vector by a number. |
| operator == | Returns true if two vectors are approximately equal. |
| Vector3 | Converts a Vector2 to a Vector3. |
| Vector2 | Converts a Vector3 to a Vector2. |
| operator * | Multiplies a vector by a number. |
| operator - | Subtracts one vector from another. |