Show / Hide Table of Contents

Struct Vector3

A pure .NET implemenation of Unity's Vector3. See Unity's docs for more details.

Inherited Members
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetType()
Namespace: Sylves
Assembly: Sylves.dll
Syntax
public struct Vector3

Constructors

Vector3(float, float, float)

Declaration
public Vector3(float x, float y, float z)
Parameters
Type Name Description
float x
float y
float z

Properties

this[int]

Declaration
public float this[int index] { get; set; }
Parameters
Type Name Description
int index
Property Value
Type Description
float

back

Declaration
public static Vector3 back { get; }
Property Value
Type Description
Vector3

down

Declaration
public static Vector3 down { get; }
Property Value
Type Description
Vector3

forward

Declaration
public static Vector3 forward { get; }
Property Value
Type Description
Vector3

left

Declaration
public static Vector3 left { get; }
Property Value
Type Description
Vector3

magnitude

Declaration
public float magnitude { get; }
Property Value
Type Description
float

negativeInfinity

Declaration
public static Vector3 negativeInfinity { get; }
Property Value
Type Description
Vector3

normalized

Declaration
public Vector3 normalized { get; }
Property Value
Type Description
Vector3

one

Declaration
public static Vector3 one { get; }
Property Value
Type Description
Vector3

positiveInfinity

Declaration
public static Vector3 positiveInfinity { get; }
Property Value
Type Description
Vector3

right

Declaration
public static Vector3 right { get; }
Property Value
Type Description
Vector3

sqrMagnitude

Declaration
public float sqrMagnitude { get; }
Property Value
Type Description
float

up

Declaration
public static Vector3 up { get; }
Property Value
Type Description
Vector3

x

Declaration
public float x { get; set; }
Property Value
Type Description
float

y

Declaration
public float y { get; set; }
Property Value
Type Description
float

z

Declaration
public float z { get; set; }
Property Value
Type Description
float

zero

Declaration
public static Vector3 zero { get; }
Property Value
Type Description
Vector3

Methods

Angle(Vector3, Vector3)

Declaration
public static float Angle(Vector3 from, Vector3 to)
Parameters
Type Name Description
Vector3 from
Vector3 to
Returns
Type Description
float

ClampMagnitude(Vector3, float)

Declaration
public static Vector3 ClampMagnitude(Vector3 vector, float maxLength)
Parameters
Type Name Description
Vector3 vector
float maxLength
Returns
Type Description
Vector3

Cross(Vector3, Vector3)

Declaration
public static Vector3 Cross(Vector3 lhs, Vector3 rhs)
Parameters
Type Name Description
Vector3 lhs
Vector3 rhs
Returns
Type Description
Vector3

Distance(Vector3, Vector3)

Declaration
public static float Distance(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
float

Dot(Vector3, Vector3)

Declaration
public static float Dot(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
float

Equals(Vector3)

Declaration
public bool Equals(Vector3 other)
Parameters
Type Name Description
Vector3 other
Returns
Type Description
bool

Equals(object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other
Returns
Type Description
bool
Overrides
ValueType.Equals(object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
ValueType.GetHashCode()

Lerp(Vector3, Vector3, float)

Declaration
public static Vector3 Lerp(Vector3 a, Vector3 b, float t)
Parameters
Type Name Description
Vector3 a
Vector3 b
float t
Returns
Type Description
Vector3

LerpUnclamped(Vector3, Vector3, float)

Declaration
public static Vector3 LerpUnclamped(Vector3 a, Vector3 b, float t)
Parameters
Type Name Description
Vector3 a
Vector3 b
float t
Returns
Type Description
Vector3

Magnitude(Vector3)

Declaration
public static float Magnitude(Vector3 a)
Parameters
Type Name Description
Vector3 a
Returns
Type Description
float

Max(Vector3, Vector3)

Declaration
public static Vector3 Max(Vector3 lhs, Vector3 rhs)
Parameters
Type Name Description
Vector3 lhs
Vector3 rhs
Returns
Type Description
Vector3

Min(Vector3, Vector3)

Declaration
public static Vector3 Min(Vector3 lhs, Vector3 rhs)
Parameters
Type Name Description
Vector3 lhs
Vector3 rhs
Returns
Type Description
Vector3

MoveTowards(Vector3, Vector3, float)

Declaration
public static Vector3 MoveTowards(Vector3 current, Vector3 target, float maxDistanceDelta)
Parameters
Type Name Description
Vector3 current
Vector3 target
float maxDistanceDelta
Returns
Type Description
Vector3

Normalize()

Declaration
public void Normalize()

Normalize(Vector3)

Declaration
public static Vector3 Normalize(Vector3 a)
Parameters
Type Name Description
Vector3 a
Returns
Type Description
Vector3

OrthoNormalize(ref Vector3, ref Vector3)

Declaration
public static void OrthoNormalize(ref Vector3 normal, ref Vector3 tangent)
Parameters
Type Name Description
Vector3 normal
Vector3 tangent

OrthoNormalize(ref Vector3, ref Vector3, ref Vector3)

Declaration
public static void OrthoNormalize(ref Vector3 normal, ref Vector3 tangent, ref Vector3 binormal)
Parameters
Type Name Description
Vector3 normal
Vector3 tangent
Vector3 binormal

Project(Vector3, Vector3)

Declaration
public static Vector3 Project(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
Vector3

ProjectOnPlane(Vector3, Vector3)

Declaration
public static Vector3 ProjectOnPlane(Vector3 vector, Vector3 planeNormal)
Parameters
Type Name Description
Vector3 vector
Vector3 planeNormal
Returns
Type Description
Vector3

Reflect(Vector3, Vector3)

Declaration
public static Vector3 Reflect(Vector3 inDirection, Vector3 inNormal)
Parameters
Type Name Description
Vector3 inDirection
Vector3 inNormal
Returns
Type Description
Vector3

Scale(Vector3)

Declaration
public void Scale(Vector3 scale)
Parameters
Type Name Description
Vector3 scale

Scale(Vector3, Vector3)

Declaration
public static Vector3 Scale(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
Vector3

Set(float, float, float)

Declaration
public void Set(float newX, float newY, float newZ)
Parameters
Type Name Description
float newX
float newY
float newZ

SignedAngle(Vector3, Vector3, Vector3)

Declaration
public static float SignedAngle(Vector3 from, Vector3 to, Vector3 axis)
Parameters
Type Name Description
Vector3 from
Vector3 to
Vector3 axis
Returns
Type Description
float

Slerp(Vector3, Vector3, float)

Declaration
public static Vector3 Slerp(Vector3 a, Vector3 b, float t)
Parameters
Type Name Description
Vector3 a
Vector3 b
float t
Returns
Type Description
Vector3

SlerpUnclamped(Vector3, Vector3, float)

Declaration
public static Vector3 SlerpUnclamped(Vector3 a, Vector3 b, float t)
Parameters
Type Name Description
Vector3 a
Vector3 b
float t
Returns
Type Description
Vector3

SqrMagnitude()

Declaration
public float SqrMagnitude()
Returns
Type Description
float

SqrMagnitude(Vector3)

Declaration
public static float SqrMagnitude(Vector3 a)
Parameters
Type Name Description
Vector3 a
Returns
Type Description
float

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
ValueType.ToString()

ToString(string)

Declaration
public string ToString(string format)
Parameters
Type Name Description
string format
Returns
Type Description
string

Operators

operator +(Vector3, Vector3)

Declaration
public static Vector3 operator +(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
Vector3

operator /(Vector3, float)

Declaration
public static Vector3 operator /(Vector3 a, float b)
Parameters
Type Name Description
Vector3 a
float b
Returns
Type Description
Vector3

operator ==(Vector3, Vector3)

Declaration
public static bool operator ==(Vector3 lhs, Vector3 rhs)
Parameters
Type Name Description
Vector3 lhs
Vector3 rhs
Returns
Type Description
bool

operator !=(Vector3, Vector3)

Declaration
public static bool operator !=(Vector3 lhs, Vector3 rhs)
Parameters
Type Name Description
Vector3 lhs
Vector3 rhs
Returns
Type Description
bool

operator *(Vector3, Vector3)

Declaration
public static Vector3 operator *(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
Vector3

operator *(Vector3, float)

Declaration
public static Vector3 operator *(Vector3 a, float b)
Parameters
Type Name Description
Vector3 a
float b
Returns
Type Description
Vector3

operator *(float, Vector3)

Declaration
public static Vector3 operator *(float a, Vector3 b)
Parameters
Type Name Description
float a
Vector3 b
Returns
Type Description
Vector3

operator -(Vector3, Vector3)

Declaration
public static Vector3 operator -(Vector3 a, Vector3 b)
Parameters
Type Name Description
Vector3 a
Vector3 b
Returns
Type Description
Vector3

operator -(Vector3)

Declaration
public static Vector3 operator -(Vector3 a)
Parameters
Type Name Description
Vector3 a
Returns
Type Description
Vector3
In this article
Back to top Generated by DocFX