Vector4 | Babylon.js API documentation

Class Vector4

Vector4 class created for EulerAngle class conversion to Quaternion

Implements

Vector<Tuple<number, 4>, IVector4Like>
IVector4Like

Index

Constructors

constructor

new Vector4(x?: number, y?: number, z?: number, w?: number): Vector4
Creates a Vector4 object from the given floats.
Parameters
- Optionalx: number
  x value of the vector
- Optionaly: number
  y value of the vector
- Optionalz: number
  z value of the vector
- Optionalw: number
  w value of the vector
Returns Vector4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63856

Properties

`Readonly`dimension

dimension: readonly [4]

See

Tensor.dimension

`Readonly`rank

rank: 1

See

Tensor.rank

w

w: number

[0] w value of the vector

x

x: number

[0] x value of the vector

y

y: number

[0] y value of the vector

z

z: number

[0] z value of the vector

`Static`_V8PerformanceHack

_V8PerformanceHack: DeepImmutableObject<Vector4>

If the first vector is flagged with integers (as everything is 0,0,0,0), V8 stores all of the properties as integers internally because it doesn't know any better yet. If subsequent vectors are created with non-integer values, V8 determines that it would be best to represent these properties as doubles instead of integers, and henceforth it will use floating-point representation for all Vector4 instances that it creates. But the original Vector4 instances are unchanged and has a "deprecated map". If we keep using the Vector4 instances from step 1, it will now be a poison pill which will mess up optimizations in any code it touches.

Accessors

`Static`ZeroReadOnly

get ZeroReadOnly(): DeepImmutableObject<Vector4>
Gets a zero Vector4 that must not be updated

Returns DeepImmutableObject<Vector4>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64297

Methods

add

add(otherVector: DeepImmutableObject<IVector4Like>): Vector4
Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to add
Returns Vector4
the resulting vector
Implementation of Vector.add
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63919

addInPlace

addInPlace(otherVector: DeepImmutableObject<Vector4>): this
Adds the given vector to the current Vector4.
Parameters
- otherVector: DeepImmutableObject<Vector4>
  the vector to add
Returns this
the updated Vector4.
Implementation of Vector.addInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63904

addInPlaceFromFloats

addInPlaceFromFloats(x: number, y: number, z: number, w: number): this
Adds the given coordinates to the current Vector4
Parameters
- x: number
  defines the x coordinate of the operand
- y: number
  defines the y coordinate of the operand
- z: number
  defines the z coordinate of the operand
- w: number
  defines the w coordinate of the operand
Returns this
the current updated Vector4
Implementation of Vector.addInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63913

addToRef

addToRef<T extends IVector4Like>(
otherVector: DeepImmutableObject<IVector4Like>,
result: T,
): T
Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
Type Parameters
- T extends IVector4Like
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to add
- result: T
  the vector to store the result
Returns T
result input
Implementation of Vector.addToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63926

asArray

asArray(): [number, number, number, number]
Returns a new array populated with 4 elements : the Vector4 coordinates.

Returns [number, number, number, number]
the resulting array
Implementation of Vector.asArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63884

clone

clone(): Vector4
Returns a new Vector4 copied from the current one.

Returns Vector4
the new cloned vector
Implementation of Vector.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64170

copyFrom

copyFrom(source: DeepImmutableObject<IVector4Like>): this
Updates the current Vector4 with the given one coordinates.
Parameters
- source: DeepImmutableObject<IVector4Like>
  the source vector to copy from
Returns this
the updated Vector4.
Implementation of Vector.copyFrom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64176

copyFromFloats

copyFromFloats(x: number, y: number, z: number, w: number): this
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 this
the updated Vector4.
Implementation of Vector.copyFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64185

divide

divide(otherVector: DeepImmutableObject<IVector4Like>): Vector4
Returns a new Vector4 set with the division result of the current Vector4 by the given one.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to devide with
Returns Vector4
resulting new vector
Implementation of Vector.divide
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64062

divideInPlace

divideInPlace(otherVector: DeepImmutableObject<IVector4Like>): this
Divides the current Vector3 coordinates by the given ones.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to devide with
Returns this
the updated Vector3.
Implementation of Vector.divideInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64075

divideToRef

divideToRef<T extends IVector4Like>(
otherVector: DeepImmutableObject<IVector4Like>,
result: T,
): T
Updates the given vector "result" with the division result of the current Vector4 by the given one.
Type Parameters
- T extends IVector4Like
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to devide with
- result: T
  vector to store the result
Returns T
result input
Implementation of Vector.divideToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64069

dot

dot(otherVector: DeepImmutableObject<IVector4Like>): number
Returns the dot product (float) between the current vectors and "otherVector"
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  defines the right operand
Returns number
the dot product
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64206

equals

equals(otherVector: DeepImmutableObject<IVector4Like>): boolean
Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to compare against
Returns boolean
true if they are equal
Implementation of Vector.equals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64012

equalsToFloats

equalsToFloats(x: number, y: number, z: number, w: number): boolean
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
Implementation of Vector.equalsToFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64028

equalsWithEpsilon

equalsWithEpsilon(
otherVector: DeepImmutableObject<IVector4Like>,
epsilon?: number,
): boolean
Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to compare against
- Optionalepsilon: number
  (Default: very small number)
Returns boolean
true if they are equal
Implementation of Vector.equalsWithEpsilon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64019

floor

floor(): Vector4
Gets a new Vector4 from current Vector4 floored values

Returns Vector4
a new Vector4
Implementation of Vector.floor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64116

floorToRef

floorToRef<T extends IVector4Like>(result: T): T
Gets the current Vector4's floored values and stores them in result
Type Parameters
- T extends IVector4Like
Parameters
- result: T
  the vector to store the result in
Returns T
the result vector
Implementation of Vector.floorToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64111

fract

fract(): Vector4
Gets a new Vector4 from current Vector4 fractional values

Returns Vector4
a new Vector4
Implementation of Vector.fract
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64127

fractToRef

fractToRef<T extends IVector4Like>(result: T): T
Gets the current Vector4's fractional values and stores them in result
Type Parameters
- T extends IVector4Like
Parameters
- result: T
  the vector to store the result in
Returns T
the result vector
Implementation of Vector.fractToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64122

fromArray

fromArray(array: FloatArray, offset?: number): this
Update the current vector from an array
Parameters
- array: FloatArray
  defines the destination array
- Optionaloffset: number
  defines the offset in the destination array
Returns this
the current Vector3
Implementation of Vector.fromArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63898

getClassName

getClassName(): string
Returns the string "Vector4".

Returns string
"Vector4"
Implementation of Vector.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63874

getHashCode

getHashCode(): number
Returns the Vector4 hash code.

Returns number
a unique hash code
Implementation of Vector.getHashCode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63879

length

length(): number
Returns the Vector4 length (float).

Returns number
the length
Implementation of Vector.length
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64132

lengthSquared

lengthSquared(): number
Returns the Vector4 squared length (float).

Returns number
the length squared
Implementation of Vector.lengthSquared
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64137

maximizeInPlace

maximizeInPlace(other: DeepImmutableObject<IVector4Like>): this
Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
Parameters
- other: DeepImmutableObject<IVector4Like>
  defines the second operand
Returns this
the current updated Vector4
Implementation of Vector.maximizeInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64087

maximizeInPlaceFromFloats

maximizeInPlaceFromFloats(x: number, y: number, z: number, w: number): this
Updates the current Vector4 with the maximal coordinate values between its and the given coordinates.
Parameters
- x: number
  defines the x coordinate of the operand
- y: number
  defines the y coordinate of the operand
- z: number
  defines the z coordinate of the operand
- w: number
  defines the w coordinate of the operand
Returns this
the current updated Vector4
Implementation of Vector.maximizeInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64105

minimizeInPlace

minimizeInPlace(other: DeepImmutableObject<IVector4Like>): this
Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
Parameters
- other: DeepImmutableObject<IVector4Like>
  defines the second operand
Returns this
the current updated Vector4
Implementation of Vector.minimizeInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64081

minimizeInPlaceFromFloats

minimizeInPlaceFromFloats(x: number, y: number, z: number, w: number): this
Updates the current Vector4 with the minimal coordinate values between its and the given coordinates
Parameters
- x: number
  defines the x coordinate of the operand
- y: number
  defines the y coordinate of the operand
- z: number
  defines the z coordinate of the operand
- w: number
  defines the w coordinate of the operand
Returns this
the current updated Vector4
Implementation of Vector.minimizeInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64096

multiply

multiply(otherVector: DeepImmutableObject<IVector4Like>): Vector4
Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to multiple with
Returns Vector4
resulting new vector
Implementation of Vector.multiply
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64040

multiplyByFloats

multiplyByFloats(x: number, y: number, z: number, w: number): Vector4
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
Implementation of Vector.multiplyByFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64056

multiplyInPlace

multiplyInPlace(otherVector: DeepImmutableObject<IVector4Like>): this
Multiplies in place the current Vector4 by the given one.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to multiple with
Returns this
the updated Vector4.
Implementation of Vector.multiplyInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64034

multiplyToRef

multiplyToRef<T extends IVector4Like>(
otherVector: DeepImmutableObject<IVector4Like>,
result: T,
): T
Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
Type Parameters
- T extends IVector4Like
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  vector to multiple with
- result: T
  vector to store the result
Returns T
result input
Implementation of Vector.multiplyToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64047

negate

negate(): Vector4
Returns a new Vector4 set with the current Vector4 negated coordinates.

Returns Vector4
a new vector with the negated values
Implementation of Vector.negate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63969

negateInPlace

negateInPlace(): this
Negate this vector in place

Returns this
this
Implementation of Vector.negateInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63974

negateToRef

negateToRef<T extends IVector4Like>(result: T): T
Negate the current Vector4 and stores the result in the given vector "result" coordinates
Type Parameters
- T extends IVector4Like
Parameters
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Implementation of Vector.negateToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63980

normalize

normalize(): this
Normalizes in place the Vector4.

Returns this
the updated Vector4.
Implementation of Vector.normalize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64142

normalizeFromLength

normalizeFromLength(len: number): this
Normalize the current Vector4 with the given input length. Please note that this is an in place operation.
Parameters
- len: number
  the length of the vector
Returns this
the current updated Vector4
Implementation of Vector.normalizeFromLength
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64149

normalizeToNew

normalizeToNew(): Vector4
Normalize the current Vector4 to a new vector

Returns Vector4
the new Vector4
Implementation of Vector.normalizeToNew
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64154

normalizeToRef

normalizeToRef<T extends IVector4Like>(reference: T): T
Normalize the current Vector4 to the reference
Type Parameters
- T extends IVector4Like
Parameters
- reference: T
  define the Vector4 to update
Returns T
the updated Vector4
Implementation of Vector.normalizeToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64160

scale

scale(scale: number): Vector4
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
Implementation of Vector.scale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63992

scaleAndAddToRef

scaleAndAddToRef<T extends IVector4Like>(scale: number, result: T): T
Scale the current Vector4 values by a factor and add the result to a given Vector4
Type Parameters
- T extends IVector4Like
Parameters
- scale: number
  defines the scale factor
- result: T
  defines the Vector4 object where to store the result
Returns T
result input
Implementation of Vector.scaleAndAddToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64006

scaleInPlace

scaleInPlace(scale: number): this
Multiplies the current Vector4 coordinates by scale (float).
Parameters
- scale: number
  the number to scale with
Returns this
the updated Vector4.
Implementation of Vector.scaleInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63986

scaleToRef

scaleToRef<T extends IVector4Like>(scale: number, result: T): T
Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
Type Parameters
- T extends IVector4Like
Parameters
- scale: number
  the number to scale with
- result: T
  a vector to store the result in
Returns T
result input
Implementation of Vector.scaleToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63999

set

set(x: number, y: number, z: number, w: number): this
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 this
the updated Vector4.
Implementation of Vector.set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64194

setAll

setAll(v: number): this
Copies the given float to the current Vector4 coordinates
Parameters
- v: number
  defines the x, y, z and w coordinates of the operand
Returns this
the current updated Vector4
Implementation of Vector.setAll
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64200

subtract

subtract(otherVector: DeepImmutableObject<IVector4Like>): Vector4
Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to add
Returns Vector4
the new vector with the result
Implementation of Vector.subtract
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63938

subtractFromFloats

subtractFromFloats(x: number, y: number, z: number, w: number): Vector4
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
Implementation of Vector.subtractFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63954

subtractFromFloatsToRef

subtractFromFloatsToRef<T extends IVector4Like>(
    x: number,
    y: number,
    z: number,
    w: number,
    result: T,
): T
Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
Type Parameters
- T extends IVector4Like
Parameters
- x: number
  value to subtract
- y: number
  value to subtract
- z: number
  value to subtract
- w: number
  value to subtract
- result: T
  the vector to store the result in
Returns T
result input
Implementation of Vector.subtractFromFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63964

subtractInPlace

subtractInPlace(otherVector: DeepImmutableObject<IVector4Like>): this
Subtract in place the given vector from the current Vector4.
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to subtract
Returns this
the updated Vector4.
Implementation of Vector.subtractInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63932

subtractToRef

subtractToRef<T extends IVector4Like>(
otherVector: DeepImmutableObject<IVector4Like>,
result: T,
): T
Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
Type Parameters
- T extends IVector4Like
Parameters
- otherVector: DeepImmutableObject<IVector4Like>
  the vector to subtract
- result: T
  the vector to store the result
Returns T
result input
Implementation of Vector.subtractToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63945

toArray

toArray(array: FloatArray, index?: number): this
Populates the given array from the given index with the Vector4 coordinates.
Parameters
- array: FloatArray
  array to populate
- Optionalindex: number
  index of the array to start at (default: 0)
Returns this
the Vector4.
Implementation of Vector.toArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63891

toString

toString(): string
Returns the string with the Vector4 coordinates.

Returns string
a string containing all the vector values
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63869

toVector3

toVector3(): Vector3
Returns a new Vector3 from the Vector4 (x, y, z) coordinates.

Returns Vector3
this converted to a new vector3
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64165

`Static`Center

Center(
value1: DeepImmutableObject<IVector4Like>,
value2: DeepImmutableObject<IVector4Like>,
): Vector4
Returns a new Vector4 located at the center between the vectors "value1" and "value2".
Parameters
- value1: DeepImmutableObject<IVector4Like>
  value to calulate the center between
- value2: DeepImmutableObject<IVector4Like>
  value to calulate the center between
Returns Vector4
the center between the two vectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64345

`Static`CenterToRef

CenterToRef<T extends IVector4Like>(
    value1: DeepImmutableObject<IVector4Like>,
    value2: DeepImmutableObject<IVector4Like>,
    ref: T,
): T
Gets the center of the vectors "value1" and "value2" and stores the result in the vector "ref"
Type Parameters
- T extends IVector4Like
Parameters
- value1: DeepImmutableObject<IVector4Like>
  defines first vector
- value2: DeepImmutableObject<IVector4Like>
  defines second vector
- ref: T
  defines third vector
Returns T
ref
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64353

`Static`CheckExtends

CheckExtends(v: IVector4Like, min: Vector4, max: Vector4): void
Checks if a given vector is inside a specific range Example Playground https://playground.babylonjs.com/#R1F8YU#75
Parameters
- v: IVector4Like
  defines the vector to test
- min: Vector4
  defines the minimum range
- max: Vector4
  defines the maximum range
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64293

`Static`Clamp

Clamp(
    value: DeepImmutableObject<IVector4Like>,
    min: DeepImmutableObject<IVector4Like>,
    max: DeepImmutableObject<IVector4Like>,
): Vector4
Returns a new Vector4 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max" If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
Parameters
- value: DeepImmutableObject<IVector4Like>
  defines the current value
- min: DeepImmutableObject<IVector4Like>
  defines the lower range value
- max: DeepImmutableObject<IVector4Like>
  defines the upper range value
Returns Vector4
the new Vector4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64274

`Static`ClampToRef

ClampToRef<T extends IVector4Like>(
    value: DeepImmutableObject<IVector4Like>,
    min: DeepImmutableObject<IVector4Like>,
    max: DeepImmutableObject<IVector4Like>,
    result: T,
): T
Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max" If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
Type Parameters
- T extends IVector4Like
Parameters
- value: DeepImmutableObject<IVector4Like>
  defines the current value
- min: DeepImmutableObject<IVector4Like>
  defines the lower range value
- max: DeepImmutableObject<IVector4Like>
  defines the upper range value
- result: T
  defines the Vector4 where to store the result
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64285

`Static`Distance

Distance(
value1: DeepImmutableObject<IVector4Like>,
value2: DeepImmutableObject<IVector4Like>,
): number
Returns the distance (float) between the vectors "value1" and "value2".
Parameters
- value1: DeepImmutableObject<IVector4Like>
  value to calulate the distance between
- value2: DeepImmutableObject<IVector4Like>
  value to calulate the distance between
Returns number
the distance between the two vectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64331

`Static`DistanceSquared

DistanceSquared(
value1: DeepImmutableObject<IVector4Like>,
value2: DeepImmutableObject<IVector4Like>,
): number
Returns the squared distance (float) between the vectors "value1" and "value2".
Parameters
- value1: DeepImmutableObject<IVector4Like>
  value to calulate the distance between
- value2: DeepImmutableObject<IVector4Like>
  value to calulate the distance between
Returns number
the distance between the two vectors squared
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64338

`Static`Dot

Dot(
left: DeepImmutableObject<IVector4Like>,
right: DeepImmutableObject<IVector4Like>,
): number
Returns the dot product (float) between the vectors "left" and "right"
Parameters
- left: DeepImmutableObject<IVector4Like>
  defines the left operand
- right: DeepImmutableObject<IVector4Like>
  defines the right operand
Returns number
the dot product
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64427

`Static`FromArray

FromArray(
array: DeepImmutableObject<ArrayLike<number>>,
offset?: number,
): Vector4
Returns a new Vector4 set from the starting index of the given array.
Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  the array to pull values from
- Optionaloffset: number
  the offset into the array to start at
Returns Vector4
the new vector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64213

`Static`FromArrayToRef

FromArrayToRef<T extends IVector4Like>(
    array: DeepImmutableObject<ArrayLike<number>>,
    offset: number,
    result: T,
): T
Updates the given vector "result" from the starting index of the given array.
Type Parameters
- T extends IVector4Like
Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  the array to pull values from
- offset: number
  the offset into the array to start at
- result: T
  the vector to store the result in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64221

`Static`FromFloatArrayToRef

FromFloatArrayToRef<T extends IVector4Like>(
    array: DeepImmutableObject<Float32Array>,
    offset: number,
    result: T,
): T
Updates the given vector "result" from the starting index of the given Float32Array.
Type Parameters
- T extends IVector4Like
Parameters
- array: DeepImmutableObject<Float32Array>
  the array to pull values from
- offset: number
  the offset into the array to start at
- result: T
  the vector to store the result in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64229

`Static`FromFloatsToRef

FromFloatsToRef<T extends IVector4Like>(
    x: number,
    y: number,
    z: number,
    w: number,
    result: T,
): T
Updates the given vector "result" coordinates from the given floats.
Type Parameters
- T extends IVector4Like
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: T
  the vector to the floats in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64239

`Static`FromVector3

FromVector3(source: Vector3, w?: number): Vector4
Creates a new Vector4 from a Vector3
Parameters
- source: Vector3
  defines the source data
- Optionalw: number
  defines the 4th component (default is 0)
Returns Vector4
a new Vector4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64420

`Static`Maximize

Maximize(
left: DeepImmutableObject<IVector4Like>,
right: DeepImmutableObject<IVector4Like>,
): Vector4
Returns a vector with the maximum values from the left and right vectors
Parameters
- left: DeepImmutableObject<IVector4Like>
  left vector to maximize
- right: DeepImmutableObject<IVector4Like>
  right vector to maximize
Returns Vector4
a new vector with the maximum of the left and right vector values
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64324

`Static`Minimize

Minimize<T extends Vector4>(
left: DeepImmutable<T>,
right: DeepImmutableObject<Vector4>,
): Vector4
Returns a vector with the minimum values from the left and right vectors
Type Parameters
- T extends Vector4
Parameters
- left: DeepImmutable<T>
  left vector to minimize
- right: DeepImmutableObject<Vector4>
  right vector to minimize
Returns Vector4
a new vector with the minimum of the left and right vector values
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64317

`Static`Normalize

Normalize(vector: DeepImmutableObject<Vector4>): Vector4
Returns a new normalized Vector4 from the given one.
Parameters
- vector: DeepImmutableObject<Vector4>
  the vector to normalize
Returns Vector4
the vector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64303

`Static`NormalizeToRef

NormalizeToRef<T extends IVector4Like>(
vector: DeepImmutableObject<Vector4>,
result: T,
): T
Updates the given vector "result" from the normalization of the given one.
Type Parameters
- T extends IVector4Like
Parameters
- vector: DeepImmutableObject<Vector4>
  the vector to normalize
- result: T
  the vector to store the result in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64310

`Static`One

One(): Vector4
Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)

Returns Vector4
the new vector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64249

`Static`Random

Random(min?: number, max?: number): Vector4
Returns a new Vector4 with random values between min and max
Parameters
- Optionalmin: number
  the minimum random value
- Optionalmax: number
  the maximum random value
Returns Vector4
a Vector4 with random values between min and max
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64256

`Static`RandomToRef

RandomToRef<T extends IVector4Like>(
    min: undefined | number,
    max: undefined | number,
    ref: T,
): T
Sets a Vector4 with random values between min and max
Type Parameters
- T extends IVector4Like
Parameters
- min: undefined | number
  the minimum random value
- max: undefined | number
  the maximum random value
- ref: T
  the ref to store the values in
Returns T
the ref with random values between min and max
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64264

`Static`TransformCoordinates

TransformCoordinates(
vector: DeepImmutableObject<Vector3>,
transformation: DeepImmutableObject<Matrix>,
): Vector4
Returns a new Vector4 set with the result of the transformation by the given matrix of the given vector. This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account) The difference with Vector3.TransformCoordinates is that the w component is not used to divide the other coordinates but is returned in the w coordinate instead
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
Returns Vector4
the transformed Vector4
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64362

`Static`TransformCoordinatesFromFloatsToRef

TransformCoordinatesFromFloatsToRef<T extends IVector4Like>(
    x: number,
    y: number,
    z: number,
    transformation: DeepImmutableObject<Matrix>,
    result: T,
): T
Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z) This method computes tranformed coordinates only, not transformed direction vectors The difference with Vector3.TransformCoordinatesFromFloatsToRef is that the w component is not used to divide the other coordinates but is returned in the w coordinate instead
Type Parameters
- T extends IVector4Like
Parameters
- x: number
  define the x coordinate of the source vector
- y: number
  define the y coordinate of the source vector
- z: number
  define the z coordinate of the source vector
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
- result: T
  defines the Vector4 where to store the result
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64384

`Static`TransformCoordinatesToRef

TransformCoordinatesToRef<T extends IVector4Like>(
    vector: DeepImmutableObject<Vector3>,
    transformation: DeepImmutableObject<Matrix>,
    result: T,
): T
Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account) The difference with Vector3.TransformCoordinatesToRef is that the w component is not used to divide the other coordinates but is returned in the w coordinate instead
Type Parameters
- T extends IVector4Like
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
- result: T
  defines the Vector4 where to store the result
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64372

`Static`TransformNormal

TransformNormal(
vector: DeepImmutableObject<IVector4Like>,
transformation: DeepImmutableObject<Matrix>,
): Vector4
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: DeepImmutableObject<IVector4Like>
  the vector to transform
- transformation: DeepImmutableObject<Matrix>
  the transformation matrix to apply
Returns Vector4
the new vector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64392

`Static`TransformNormalFromFloatsToRef

TransformNormalFromFloatsToRef<T extends IVector4Like>(
    x: number,
    y: number,
    z: number,
    w: number,
    transformation: DeepImmutableObject<Matrix>,
    result: T,
): T
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.
Type Parameters
- T extends IVector4Like
Parameters
- x: number
  value to transform
- y: number
  value to transform
- z: number
  value to transform
- w: number
  value to transform
- transformation: DeepImmutableObject<Matrix>
  the transformation matrix to apply
- result: T
  the vector to store the results in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64413

`Static`TransformNormalToRef

TransformNormalToRef<T extends IVector4Like>(
    vector: DeepImmutableObject<IVector4Like>,
    transformation: DeepImmutableObject<Matrix>,
    result: T,
): T
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.
Type Parameters
- T extends IVector4Like
Parameters
- vector: DeepImmutableObject<IVector4Like>
  the vector to transform
- transformation: DeepImmutableObject<Matrix>
  the transformation matrix to apply
- result: T
  the vector to store the result in
Returns T
result input
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64401

`Static`Zero

Zero(): Vector4
Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)

Returns Vector4
the new vector
- Defined in .temp/typedoc/docdirectory/doc.d.ts:64244

Class Vector4

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector4

Properties

Readonlydimension

See

Readonlyrank

See

w

x

y

z

Static_V8PerformanceHack

Accessors

StaticZeroReadOnly

Returns DeepImmutableObject<Vector4>

Methods

add

Parameters

Returns Vector4

addInPlace

Parameters

Returns this

addInPlaceFromFloats

Parameters

Returns this

addToRef

Type Parameters

Parameters

Returns T

asArray

Returns [number, number, number, number]

clone

Returns Vector4

copyFrom

Parameters

Returns this

copyFromFloats

Parameters

Returns this

divide

Parameters

Returns Vector4

divideInPlace

Parameters

Returns this

divideToRef

Type Parameters

Parameters

Returns T

dot

Parameters

Returns number

equals

Parameters

Returns boolean

equalsToFloats

Parameters

Returns boolean

equalsWithEpsilon

Parameters

Returns boolean

floor

Returns Vector4

floorToRef

Type Parameters

Parameters

Returns T

fract

Returns Vector4

fractToRef

Type Parameters

`Readonly`dimension

`Readonly`rank

`Static`_V8PerformanceHack

`Static`ZeroReadOnly