Falco Engine 3.9.0.1 (beta)
FalcoEngine.Vector4 Struct Reference

Public Member Functions

 Vector4 (float x, float y, float z, float w)
 
 Vector4 (float x, float y, float z)
 
 Vector4 (float x, float y)
 
void Set (float newX, float newY, float newZ, float newW)
 
void Scale (Vector4 scale)
 
override int GetHashCode ()
 
override bool Equals (object other)
 
bool Equals (Vector4 other)
 
void Normalize ()
 
override string ToString ()
 
string ToString (string format)
 
float SqrMagnitude ()
 

Static Public Member Functions

static Vector4 Lerp (Vector4 a, Vector4 b, float t)
 
static Vector4 LerpUnclamped (Vector4 a, Vector4 b, float t)
 
static Vector4 MoveTowards (Vector4 current, Vector4 target, float maxDistanceDelta)
 
static Vector4 Scale (Vector4 a, Vector4 b)
 
static Vector4 Normalize (Vector4 a)
 
static float Dot (Vector4 a, Vector4 b)
 
static Vector4 Project (Vector4 a, Vector4 b)
 
static float Distance (Vector4 a, Vector4 b)
 
static float Magnitude (Vector4 a)
 
static Vector4 Min (Vector4 lhs, Vector4 rhs)
 
static Vector4 Max (Vector4 lhs, Vector4 rhs)
 
static Vector4 operator+ (Vector4 a, Vector4 b)
 
static Vector4 operator- (Vector4 a, Vector4 b)
 
static Vector4 operator- (Vector4 a)
 
static Vector4 operator* (Vector4 a, float d)
 
static Vector4 operator* (float d, Vector4 a)
 
static Vector4 operator/ (Vector4 a, float d)
 
static bool operator== (Vector4 lhs, Vector4 rhs)
 
static bool operator!= (Vector4 lhs, Vector4 rhs)
 
static implicit operator Vector4 (Vector3 v)
 
static implicit operator Vector3 (Vector4 v)
 
static implicit operator Vector4 (Vector2 v)
 
static implicit operator Vector2 (Vector4 v)
 
static float SqrMagnitude (Vector4 a)
 

Public Attributes

float x
 
float y
 
float z
 
float w
 

Properties

float this[int index] [getset]
 
Vector4 normalized [get]
 
float magnitude [get]
 
float sqrMagnitude [get]
 
static Vector4 zero [get]
 
static Vector4 one [get]
 
static Vector4 positiveInfinity [get]
 
static Vector4 negativeInfinity [get]
 

Detailed Description

Definition at line 7 of file Vector4.cs.

Constructor & Destructor Documentation

◆ Vector4() [1/3]

FalcoEngine.Vector4.Vector4 ( float  x,
float  y,
float  z,
float  w 
)

Creates a new vector with given x, y, z, w components.

Parameters
x
y
z
w

Definition at line 21 of file Vector4.cs.

◆ Vector4() [2/3]

FalcoEngine.Vector4.Vector4 ( float  x,
float  y,
float  z 
)

Creates a new vector with given x, y, z components and sets w to zero.

Parameters
x
y
z

Definition at line 35 of file Vector4.cs.

◆ Vector4() [3/3]

FalcoEngine.Vector4.Vector4 ( float  x,
float  y 
)

Creates a new vector with given x, y components and sets z and w to zero.

Parameters
x
y

Definition at line 48 of file Vector4.cs.

Member Function Documentation

◆ Distance()

static float FalcoEngine.Vector4.Distance ( Vector4  a,
Vector4  b 
)
static

Returns the distance between a and b.

Parameters
a
b

Definition at line 298 of file Vector4.cs.

◆ Dot()

static float FalcoEngine.Vector4.Dot ( Vector4  a,
Vector4  b 
)
static

Dot Product of two vectors.

Parameters
a
b

Definition at line 278 of file Vector4.cs.

◆ Equals() [1/2]

override bool FalcoEngine.Vector4.Equals ( object  other)

Returns true if the given vector is exactly equal to this vector.

Parameters
other

Definition at line 229 of file Vector4.cs.

◆ Equals() [2/2]

bool FalcoEngine.Vector4.Equals ( Vector4  other)

Definition at line 238 of file Vector4.cs.

◆ GetHashCode()

override int FalcoEngine.Vector4.GetHashCode ( )

Definition at line 220 of file Vector4.cs.

◆ Lerp()

static Vector4 FalcoEngine.Vector4.Lerp ( Vector4  a,
Vector4  b,
float  t 
)
static

Linearly interpolates between two vectors.

Parameters
a
b
t

Definition at line 160 of file Vector4.cs.

◆ LerpUnclamped()

static Vector4 FalcoEngine.Vector4.LerpUnclamped ( Vector4  a,
Vector4  b,
float  t 
)
static

Linearly interpolates between two vectors.

Parameters
a
b
t

Definition at line 172 of file Vector4.cs.

◆ Magnitude()

static float FalcoEngine.Vector4.Magnitude ( Vector4  a)
static

Definition at line 303 of file Vector4.cs.

◆ Max()

static Vector4 FalcoEngine.Vector4.Max ( Vector4  lhs,
Vector4  rhs 
)
static

Returns a vector that is made from the largest components of two vectors.

Parameters
lhs
rhs

Definition at line 323 of file Vector4.cs.

◆ Min()

static Vector4 FalcoEngine.Vector4.Min ( Vector4  lhs,
Vector4  rhs 
)
static

Returns a vector that is made from the smallest components of two vectors.

Parameters
lhs
rhs

Definition at line 313 of file Vector4.cs.

◆ MoveTowards()

static Vector4 FalcoEngine.Vector4.MoveTowards ( Vector4  current,
Vector4  target,
float  maxDistanceDelta 
)
static

Moves a point current towards target.

Parameters
current
target
maxDistanceDelta

Definition at line 183 of file Vector4.cs.

◆ Normalize() [1/2]

void FalcoEngine.Vector4.Normalize ( )

Makes this vector have a magnitude of 1.

Definition at line 260 of file Vector4.cs.

◆ Normalize() [2/2]

static Vector4 FalcoEngine.Vector4.Normalize ( Vector4  a)
static

Parameters
a

Definition at line 247 of file Vector4.cs.

◆ operator Vector2()

static implicit FalcoEngine.Vector4.operator Vector2 ( Vector4  v)
static

Definition at line 388 of file Vector4.cs.

◆ operator Vector3()

static implicit FalcoEngine.Vector4.operator Vector3 ( Vector4  v)
static

Definition at line 378 of file Vector4.cs.

◆ operator Vector4() [1/2]

static implicit FalcoEngine.Vector4.operator Vector4 ( Vector2  v)
static

Definition at line 383 of file Vector4.cs.

◆ operator Vector4() [2/2]

static implicit FalcoEngine.Vector4.operator Vector4 ( Vector3  v)
static

Definition at line 373 of file Vector4.cs.

◆ operator!=()

static bool FalcoEngine.Vector4.operator!= ( Vector4  lhs,
Vector4  rhs 
)
static

Definition at line 368 of file Vector4.cs.

◆ operator*() [1/2]

static Vector4 FalcoEngine.Vector4.operator* ( float  d,
Vector4  a 
)
static

Definition at line 348 of file Vector4.cs.

◆ operator*() [2/2]

static Vector4 FalcoEngine.Vector4.operator* ( Vector4  a,
float  d 
)
static

Definition at line 343 of file Vector4.cs.

◆ operator+()

static Vector4 FalcoEngine.Vector4.operator+ ( Vector4  a,
Vector4  b 
)
static

Definition at line 328 of file Vector4.cs.

◆ operator-() [1/2]

static Vector4 FalcoEngine.Vector4.operator- ( Vector4  a)
static

Definition at line 338 of file Vector4.cs.

◆ operator-() [2/2]

static Vector4 FalcoEngine.Vector4.operator- ( Vector4  a,
Vector4  b 
)
static

Definition at line 333 of file Vector4.cs.

◆ operator/()

static Vector4 FalcoEngine.Vector4.operator/ ( Vector4  a,
float  d 
)
static

Definition at line 353 of file Vector4.cs.

◆ operator==()

static bool FalcoEngine.Vector4.operator== ( Vector4  lhs,
Vector4  rhs 
)
static

Definition at line 358 of file Vector4.cs.

◆ Project()

static Vector4 FalcoEngine.Vector4.Project ( Vector4  a,
Vector4  b 
)
static

Projects a vector onto another vector.

Parameters
a
b

Definition at line 288 of file Vector4.cs.

◆ Scale() [1/2]

static Vector4 FalcoEngine.Vector4.Scale ( Vector4  a,
Vector4  b 
)
static

Multiplies two vectors component-wise.

Parameters
a
b

Definition at line 203 of file Vector4.cs.

◆ Scale() [2/2]

void FalcoEngine.Vector4.Scale ( Vector4  scale)

Multiplies every component of this vector by the same component of scale.

Parameters
scale

Definition at line 212 of file Vector4.cs.

◆ Set()

void FalcoEngine.Vector4.Set ( float  newX,
float  newY,
float  newZ,
float  newW 
)

Set x, y, z and w components of an existing Vector4.

Parameters
newX
newY
newZ
newW

Definition at line 146 of file Vector4.cs.

◆ SqrMagnitude() [1/2]

float FalcoEngine.Vector4.SqrMagnitude ( )

Definition at line 416 of file Vector4.cs.

◆ SqrMagnitude() [2/2]

static float FalcoEngine.Vector4.SqrMagnitude ( Vector4  a)
static

Definition at line 411 of file Vector4.cs.

◆ ToString() [1/2]

override string FalcoEngine.Vector4.ToString ( )

Returns a nicely formatted string for this vector.

Parameters
format

Definition at line 397 of file Vector4.cs.

◆ ToString() [2/2]

string FalcoEngine.Vector4.ToString ( string  format)

Returns a nicely formatted string for this vector.

Parameters
format

Definition at line 406 of file Vector4.cs.

Member Data Documentation

◆ w

float FalcoEngine.Vector4.w

Definition at line 12 of file Vector4.cs.

◆ x

float FalcoEngine.Vector4.x

Definition at line 9 of file Vector4.cs.

◆ y

float FalcoEngine.Vector4.y

Definition at line 10 of file Vector4.cs.

◆ z

float FalcoEngine.Vector4.z

Definition at line 11 of file Vector4.cs.

Property Documentation

◆ magnitude

float FalcoEngine.Vector4.magnitude
get

Returns the length of this vector (Read Only).

Definition at line 112 of file Vector4.cs.

◆ negativeInfinity

Vector4 FalcoEngine.Vector4.negativeInfinity
staticget

Shorthand for writing Vector4(float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity, float.NegativeInfinity).

Definition at line 137 of file Vector4.cs.

◆ normalized

Vector4 FalcoEngine.Vector4.normalized
get

Returns this vector with a magnitude of 1 (Read Only).

Definition at line 107 of file Vector4.cs.

◆ one

Vector4 FalcoEngine.Vector4.one
staticget

Shorthand for writing Vector4(1,1,1,1).

Definition at line 127 of file Vector4.cs.

◆ positiveInfinity

Vector4 FalcoEngine.Vector4.positiveInfinity
staticget

Shorthand for writing Vector4(float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity, float.PositiveInfinity).

Definition at line 132 of file Vector4.cs.

◆ sqrMagnitude

float FalcoEngine.Vector4.sqrMagnitude
get

Returns the squared length of this vector (Read Only).

Definition at line 117 of file Vector4.cs.

◆ this[int index]

float FalcoEngine.Vector4.this[int index]
getset

Definition at line 64 of file Vector4.cs.

◆ zero

Vector4 FalcoEngine.Vector4.zero
staticget

Shorthand for writing Vector4(0,0,0,0).

Definition at line 122 of file Vector4.cs.


The documentation for this struct was generated from the following file: