Vector3
Representation of 3D vectors and points.
Read time 3 minutesLast updated 4 days ago
Definition
- Type: Struct
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
- Implements: IEquatable<Vector3>, IFormattable
public struct Vector3 : IEquatable<Vector3>, IFormattable
Remarks
This structure is used throughout Unity to pass 3D positions and directions around. It also contains functions for doing common vector operations.
Besides the functions listed below, other classes can be used to manipulate vectors and points as well. For example the Quaternion and the Matrix4x4 classes are useful for rotating or transforming vectors and points.
Fields
Constructors
Constructor | Description |
|---|---|
| Vector3(System.Single,System.Single) | Creates a new three dimensional vector or point in the xy-plane. |
| Vector3(System.Single,System.Single,System.Single) | Creates a new three-dimensional vector or point. |
Properties
Property | Description |
|---|---|
| this[] | Access the x, y, z components using [0], [1], [2] respectively. |
| magnitude | Returns the length of this vector (Read Only). |
| normalized | The unit vector in the direction of the current vector. |
| sqrMagnitude | Returns the squared length of this vector (Read Only). |
Static Properties
Property | Description |
|---|---|
| back | Shorthand for writing |
| down | Shorthand for writing |
| forward | 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 | Checks if the given object is exactly equal to this vector. |
| Normalize | Normalizes the magnitude of the current vector to 1 while maintaining the direction. |
| Scale | Multiplies every component of this vector by the same component of |
| Set | Set x, y and z components of an existing Vector3. |
| ToString | Formats this vector as a string. |
Static Methods
Method | Description |
|---|---|
| Angle | Calculates the angle between two vectors. |
| ClampMagnitude | Creates a copy of a given Vector3 with its magnitude clamped to a maximum length. |
| Cross | Calculates the cross product of two three-dimensional vectors. |
| Distance | Calculates the distance between two three-dimensional points. |
| Dot | Calculates the dot product of two three-dimensional vectors defined in the same coordinate space. |
| Lerp | Interpolates linearly between two points. |
| LerpUnclamped | Interpolates linearly between two vectors, allowing extrapolation beyond the end points. |
| 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 vector incrementally towards a target point. |
| Normalize | Creates a normalized copy of the given vector. |
| OrthoNormalize | Makes vectors normalized and orthogonal to each other. |
| Project | Projects a vector onto another vector. |
| ProjectOnPlane | Projects a vector onto a plane. |
| Reflect | Reflects a vector off the plane defined by a normal vector. |
| RotateTowards | Rotates a vector |
| Scale | Multiplies two vectors component-wise. |
| SignedAngle | Calculates the signed angle between two vectors, using a third vector to determine the sign. |
| Slerp | Spherically interpolates between two three-dimensional vectors. |
| SlerpUnclamped | Spherically interpolates between two vectors. |
| SmoothDamp | Gradually changes a vector towards a desired goal over time. |
Operators
Operator | Description |
|---|---|
| operator + | Adds two three-dimensional vectors with component-wise addition. |
| operator / | Divides a vector by a number. |
| operator == | Returns true if two vectors are approximately equal. |
| Vector3 | Converts a float3 to a Vector3. |
| float3 | Converts a Vector3 to a float3. |
| operator != | Returns true if vectors are different. |
| operator * | Multiplies a vector by a number. |
| operator - | Subtracts one vector from another. |