Class Vector4
Hierarchy
- Vector4
Index
Constructors
Properties
Methods
- add
- add
InPlace - add
ToRef - as
Array - clone
- copy
From - copy
From Floats - divide
- divide
InPlace - divide
ToRef - equals
- equals
ToFloats - equals
With Epsilon - floor
- fract
- from
Array - get
Class Name - get
Hash Code - length
- length
Squared - maximize
InPlace - minimize
InPlace - multiply
- multiply
ByFloats - multiply
InPlace - multiply
ToRef - negate
- negate
InPlace - negate
ToRef - normalize
- scale
- scale
And Add ToRef - scale
InPlace - scale
ToRef - set
- set
All - subtract
- subtract
From Floats - subtract
From Floats ToRef - subtract
InPlace - subtract
ToRef - to
Array - to
String - to
Vector3 - Center
- Center
ToRef - Distance
- Distance
Squared - From
Array - From
Array ToRef - From
Float Array ToRef - From
Floats ToRef - From
Vector3 - Maximize
- Minimize
- Normalize
- Normalize
ToRef - One
- Transform
Normal - Transform
Normal From Floats ToRef - Transform
Normal ToRef - Zero
Constructors
constructor
-
Creates a Vector4 object from the given floats.
Parameters
-
x: number
x value of the vector
-
y: number
y value of the vector
-
z: number
z value of the vector
-
w: number
w value of the vector
Returns Vector4
-
Properties
wSearch playground for w
w value of the vector
xSearch playground for x
x value of the vector
ySearch playground for y
y value of the vector
zSearch playground for z
z value of the vector
Methods
addSearch playground for add
-
Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to add
Returns Vector4
the resulting vector
-
add InPlaceSearch playground for addInPlace
-
Adds the given vector to the current Vector4.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to add
Returns Vector4
the updated Vector4.
-
add ToRefSearch playground for addToRef
-
Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to add
-
result: Vector4
the vector to store the result
Returns Vector4
the current Vector4.
-
as ArraySearch playground for asArray
-
Returns a new array populated with 4 elements : the Vector4 coordinates.
Returns number[]
the resulting array
cloneSearch playground for clone
-
Returns a new Vector4 copied from the current one.
Returns Vector4
the new cloned vector
copy FromSearch playground for copyFrom
-
Updates the current Vector4 with the given one coordinates.
Parameters
-
source: DeepImmutable<Vector4>
the source vector to copy from
Returns Vector4
the updated Vector4.
-
copy From FloatsSearch playground for copyFromFloats
-
Updates the current Vector4 coordinates with the given floats.
Parameters
-
x: number
float to copy from
-
y: number
float to copy from
-
z: number
float to copy from
-
w: number
float to copy from
Returns Vector4
the updated Vector4.
-
divideSearch playground for divide
-
Returns a new Vector4 set with the division result of the current Vector4 by the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to devide with
Returns Vector4
resulting new vector
-
divide InPlaceSearch playground for divideInPlace
-
Divides the current Vector3 coordinates by the given ones.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to devide with
Returns Vector4
the updated Vector3.
-
divide ToRefSearch playground for divideToRef
-
Updates the given vector "result" with the division result of the current Vector4 by the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to devide with
-
result: Vector4
vector to store the result
Returns Vector4
the current Vector4.
-
equalsSearch playground for equals
-
Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to compare against
Returns boolean
true if they are equal
-
equals ToFloatsSearch playground for equalsToFloats
-
Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
Parameters
-
x: number
x value to compare against
-
y: number
y value to compare against
-
z: number
z value to compare against
-
w: number
w value to compare against
Returns boolean
true if equal
-
equals With EpsilonSearch playground for equalsWithEpsilon
-
Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to compare against
-
Optional epsilon: number
(Default: very small number)
Returns boolean
true if they are equal
-
floorSearch playground for floor
-
Gets a new Vector4 from current Vector4 floored values
Returns Vector4
a new Vector4
fractSearch playground for fract
-
Gets a new Vector4 from current Vector3 floored values
Returns Vector4
a new Vector4
from ArraySearch playground for fromArray
-
Update the current vector from an array
Parameters
-
array: FloatArray
defines the destination array
-
Optional index: number
defines the offset in the destination array
Returns Vector4
the current Vector3
-
get Class NameSearch playground for getClassName
-
Returns the string "Vector4".
Returns string
"Vector4"
get Hash CodeSearch playground for getHashCode
-
Returns the Vector4 hash code.
Returns number
a unique hash code
lengthSearch playground for length
-
Returns the Vector4 length (float).
Returns number
the length
length SquaredSearch playground for lengthSquared
-
Returns the Vector4 squared length (float).
Returns number
the length squared
maximize InPlaceSearch playground for maximizeInPlace
-
Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
Parameters
-
other: DeepImmutable<Vector4>
defines the second operand
Returns Vector4
the current updated Vector4
-
minimize InPlaceSearch playground for minimizeInPlace
-
Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
Parameters
-
other: DeepImmutable<Vector4>
defines the second operand
Returns Vector4
the current updated Vector4
-
multiplySearch playground for multiply
-
Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to multiple with
Returns Vector4
resulting new vector
-
multiply ByFloatsSearch playground for multiplyByFloats
-
Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
Parameters
-
x: number
x value multiply with
-
y: number
y value multiply with
-
z: number
z value multiply with
-
w: number
w value multiply with
Returns Vector4
resulting new vector
-
multiply InPlaceSearch playground for multiplyInPlace
multiply ToRefSearch playground for multiplyToRef
-
Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
Parameters
-
otherVector: DeepImmutable<Vector4>
vector to multiple with
-
result: Vector4
vector to store the result
Returns Vector4
the current Vector4.
-
negateSearch playground for negate
-
Returns a new Vector4 set with the current Vector4 negated coordinates.
Returns Vector4
a new vector with the negated values
negate InPlaceSearch playground for negateInPlace
-
Negate this vector in place
Returns Vector4
this
negate ToRefSearch playground for negateToRef
normalizeSearch playground for normalize
-
Normalizes in place the Vector4.
Returns Vector4
the updated Vector4.
scaleSearch playground for scale
-
Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
Parameters
-
scale: number
the number to scale with
Returns Vector4
a new vector with the result
-
scale And Add ToRefSearch playground for scaleAndAddToRef
scale InPlaceSearch playground for scaleInPlace
-
Multiplies the current Vector4 coordinates by scale (float).
Parameters
-
scale: number
the number to scale with
Returns Vector4
the updated Vector4.
-
scale ToRefSearch playground for scaleToRef
setSearch playground for set
-
Updates the current Vector4 coordinates with the given floats.
Parameters
-
x: number
float to set from
-
y: number
float to set from
-
z: number
float to set from
-
w: number
float to set from
Returns Vector4
the updated Vector4.
-
set AllSearch playground for setAll
-
Copies the given float to the current Vector3 coordinates
Parameters
-
v: number
defines the x, y, z and w coordinates of the operand
Returns Vector4
the current updated Vector3
-
subtractSearch playground for subtract
-
Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to add
Returns Vector4
the new vector with the result
-
subtract From FloatsSearch playground for subtractFromFloats
-
Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
Parameters
-
x: number
value to subtract
-
y: number
value to subtract
-
z: number
value to subtract
-
w: number
value to subtract
Returns Vector4
new vector containing the result
-
subtract From Floats ToRefSearch playground for subtractFromFloatsToRef
-
Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
Parameters
-
x: number
value to subtract
-
y: number
value to subtract
-
z: number
value to subtract
-
w: number
value to subtract
-
result: Vector4
the vector to store the result in
Returns Vector4
the current Vector4.
-
subtract InPlaceSearch playground for subtractInPlace
-
Subtract in place the given vector from the current Vector4.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to subtract
Returns Vector4
the updated Vector4.
-
subtract ToRefSearch playground for subtractToRef
-
Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
Parameters
-
otherVector: DeepImmutable<Vector4>
the vector to subtract
-
result: Vector4
the vector to store the result
Returns Vector4
the current Vector4.
-
to ArraySearch playground for toArray
-
Populates the given array from the given index with the Vector4 coordinates.
Parameters
-
array: FloatArray
array to populate
-
Optional index: number
index of the array to start at (default: 0)
Returns Vector4
the Vector4.
-
to StringSearch playground for toString
-
Returns the string with the Vector4 coordinates.
Returns string
a string containing all the vector values
to Vector3Search playground for toVector3
-
Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
Returns Vector3
this converted to a new vector3
Static CenterSearch playground for Center
-
Returns a new Vector4 located at the center between the vectors "value1" and "value2".
Parameters
-
value1: DeepImmutable<Vector4>
value to calulate the center between
-
value2: DeepImmutable<Vector4>
value to calulate the center between
Returns Vector4
the center between the two vectors
-
Static Center ToRefSearch playground for CenterToRef
-
Gets the center of the vectors "value1" and "value2" and stores the result in the vector "ref"
Parameters
-
value1: DeepImmutable<Vector4>
defines first vector
-
value2: DeepImmutable<Vector4>
defines second vector
-
ref: DeepImmutable<Vector4>
defines third vector
Returns Vector4
ref
-
Static DistanceSearch playground for Distance
-
Returns the distance (float) between the vectors "value1" and "value2".
Parameters
-
value1: DeepImmutable<Vector4>
value to calulate the distance between
-
value2: DeepImmutable<Vector4>
value to calulate the distance between
Returns number
the distance between the two vectors
-
Static Distance SquaredSearch playground for DistanceSquared
-
Returns the squared distance (float) between the vectors "value1" and "value2".
Parameters
-
value1: DeepImmutable<Vector4>
value to calulate the distance between
-
value2: DeepImmutable<Vector4>
value to calulate the distance between
Returns number
the distance between the two vectors squared
-
Static From ArraySearch playground for FromArray
-
Returns a new Vector4 set from the starting index of the given array.
Parameters
-
array: DeepImmutable<ArrayLike<number>>
the array to pull values from
-
Optional offset: number
the offset into the array to start at
Returns Vector4
the new vector
-
Static From Array ToRefSearch playground for FromArrayToRef
-
Updates the given vector "result" from the starting index of the given array.
Parameters
-
array: DeepImmutable<ArrayLike<number>>
the array to pull values from
-
offset: number
the offset into the array to start at
-
result: Vector4
the vector to store the result in
Returns void
-
Static From Float Array ToRefSearch playground for FromFloatArrayToRef
-
Updates the given vector "result" from the starting index of the given Float32Array.
Parameters
-
array: DeepImmutable<Float32Array>
the array to pull values from
-
offset: number
the offset into the array to start at
-
result: Vector4
the vector to store the result in
Returns void
-
Static From Floats ToRefSearch playground for FromFloatsToRef
-
Updates the given vector "result" coordinates from the given floats.
Parameters
-
x: number
float to set from
-
y: number
float to set from
-
z: number
float to set from
-
w: number
float to set from
-
result: Vector4
the vector to the floats in
Returns void
-
Static From Vector3Search playground for FromVector3
Static MaximizeSearch playground for Maximize
-
Returns a vector with the maximum values from the left and right vectors
Parameters
-
left: DeepImmutable<Vector4>
left vector to maximize
-
right: DeepImmutable<Vector4>
right vector to maximize
Returns Vector4
a new vector with the maximum of the left and right vector values
-
Static MinimizeSearch playground for Minimize
-
Returns a vector with the minimum values from the left and right vectors
Parameters
-
left: DeepImmutable<Vector4>
left vector to minimize
-
right: DeepImmutable<Vector4>
right vector to minimize
Returns Vector4
a new vector with the minimum of the left and right vector values
-
Static NormalizeSearch playground for Normalize
-
Returns a new normalized Vector4 from the given one.
Parameters
-
vector: DeepImmutable<Vector4>
the vector to normalize
Returns Vector4
the vector
-
Static Normalize ToRefSearch playground for NormalizeToRef
-
Updates the given vector "result" from the normalization of the given one.
Parameters
-
vector: DeepImmutable<Vector4>
the vector to normalize
-
result: Vector4
the vector to store the result in
Returns void
-
Static OneSearch playground for One
-
Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
Returns Vector4
the new vector
Static Transform NormalSearch playground for TransformNormal
-
Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector. This methods computes transformed normalized direction vectors only.
Parameters
-
vector: DeepImmutable<Vector4>
the vector to transform
-
transformation: DeepImmutable<Matrix>
the transformation matrix to apply
Returns Vector4
the new vector
-
Static Transform Normal From Floats ToRefSearch playground for TransformNormalFromFloatsToRef
-
Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w). This methods computes transformed normalized direction vectors only.
Parameters
-
x: number
value to transform
-
y: number
value to transform
-
z: number
value to transform
-
w: number
value to transform
-
transformation: DeepImmutable<Matrix>
the transformation matrix to apply
-
result: Vector4
the vector to store the results in
Returns void
-
Static Transform Normal ToRefSearch playground for TransformNormalToRef
-
Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector. This methods computes transformed normalized direction vectors only.
Parameters
-
vector: DeepImmutable<Vector4>
the vector to transform
-
transformation: DeepImmutable<Matrix>
the transformation matrix to apply
-
result: Vector4
the vector to store the result in
Returns void
-
Static ZeroSearch playground for Zero
-
Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
Returns Vector4
the new vector
Vector4 class created for EulerAngle class conversion to Quaternion