Vector3WithInfo | Babylon.js API documentation

Class Vector3WithInfo

Class used to transport BABYLON.Vector3 information for pointer events

Hierarchy (View Summary)

Vector3
- Vector3WithInfo

Index

Constructors

constructor

new Vector3WithInfo(source: Vector3, buttonIndex?: number): Vector3WithInfo
Creates a new Vector3WithInfo
Parameters
- source: Vector3
  defines the vector3 data to transport
- OptionalbuttonIndex: number
  defines the current mouse button index
Returns Vector3WithInfo
Overrides Vector3.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:146401

Properties

buttonIndex

buttonIndex: number

defines the current mouse button index

`Readonly`dimension

dimension: readonly [3]

See

Tensor.dimension

`Readonly`rank

rank: 1

See

Tensor.rank

`Static`_V8PerformanceHack

_V8PerformanceHack: DeepImmutableObject<Vector3>

If the first vector is flagged with integers (as everything is 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 Vector3 instances that it creates. But the original Vector3 instances are unchanged and has a "deprecated map". If we keep using the Vector3 instances from step 1, it will now be a poison pill which will mess up optimizations in any code it touches.

Accessors

hasAZeroComponent

get hasAZeroComponent(): boolean
Gets a boolean indicating if the vector contains a zero in one of its components Example Playground https://playground.babylonjs.com/#R1F8YU#1

Returns boolean
Inherited from BABYLON.Vector3.hasAZeroComponent
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63121

isNonUniform

get isNonUniform(): boolean
Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same

Returns boolean
Inherited from BABYLON.Vector3.isNonUniform
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63080

x

get x(): number
Gets or sets the x coordinate

Returns number
Inherited from BABYLON.Vector3.x
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62730
set x(value: number): void
Parameters
- value: number
Returns void
Inherited from BABYLON.Vector3.x
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62731

y

get y(): number
Gets or sets the y coordinate

Returns number
Inherited from BABYLON.Vector3.y
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62733
set y(value: number): void
Parameters
- value: number
Returns void
Inherited from BABYLON.Vector3.y
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62734

z

get z(): number
Gets or sets the z coordinate

Returns number
Inherited from BABYLON.Vector3.z
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62736
set z(value: number): void
Parameters
- value: number
Returns void
Inherited from BABYLON.Vector3.z
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62737

`Static`DownReadOnly

get DownReadOnly(): DeepImmutableObject<Vector3>
Gets a down Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.DownReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63357

`Static`LeftHandedBackwardReadOnly

get LeftHandedBackwardReadOnly(): DeepImmutableObject<Vector3>
Gets a backward Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.LeftHandedBackwardReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63377

`Static`LeftHandedForwardReadOnly

get LeftHandedForwardReadOnly(): DeepImmutableObject<Vector3>
Gets a forward Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.LeftHandedForwardReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63369

`Static`LeftReadOnly

get LeftReadOnly(): DeepImmutableObject<Vector3>
Gets a left Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.LeftReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63365

`Static`OneReadOnly

get OneReadOnly(): DeepImmutableObject<Vector3>
Gets a one Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.OneReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63389

`Static`RightHandedBackwardReadOnly

get RightHandedBackwardReadOnly(): DeepImmutableObject<Vector3>
Gets a backward Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.RightHandedBackwardReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63381

`Static`RightHandedForwardReadOnly

get RightHandedForwardReadOnly(): DeepImmutableObject<Vector3>
Gets a forward Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.RightHandedForwardReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63373

`Static`RightReadOnly

get RightReadOnly(): DeepImmutableObject<Vector3>
Gets a right Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.RightReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63361

`Static`UpReadOnly

get UpReadOnly(): DeepImmutableObject<Vector3>
Gets an up Vector3 that must not be updated

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.UpReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63353

`Static`ZeroReadOnly

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

Returns DeepImmutableObject<Vector3>
Inherited from BABYLON.Vector3.ZeroReadOnly
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63385

Methods

add

add(otherVector: DeepImmutableObject<IVector3LikeInternal>): Vector3
Gets a new Vector3, result of the addition the current Vector3 and the given vector Example Playground https://playground.babylonjs.com/#R1F8YU#3
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns Vector3
the resulting Vector3
Inherited from Vector3.add
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62811

addInPlace

addInPlace(otherVector: DeepImmutableObject<Vector3>): this
Adds the given vector to the current Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#4
Parameters
- otherVector: DeepImmutableObject<Vector3>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.addInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62795

addInPlaceFromFloats

addInPlaceFromFloats(x: number, y: number, z: number): this
Adds the given coordinates to the current Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#5
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
Returns this
the current updated Vector3
Inherited from Vector3.addInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62804

addToRef

addToRef<T extends IVector3LikeInternal>(
otherVector: DeepImmutableObject<IVector3LikeInternal>,
result: T,
): T
Adds the current Vector3 to the given one and stores the result in the vector "result" Example Playground https://playground.babylonjs.com/#R1F8YU#6
Type Parameters
- T extends IVector3LikeInternal
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.addToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62819

applyRotationQuaternion

applyRotationQuaternion(q: Quaternion): Vector3
Rotates the vector using the given unit quaternion and returns the new vector Example Playground https://playground.babylonjs.com/#R1F8YU#7
Parameters
- q: Quaternion
  the unit quaternion representing the rotation
Returns Vector3
a new Vector3
Inherited from Vector3.applyRotationQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62935

applyRotationQuaternionInPlace

applyRotationQuaternionInPlace(q: Quaternion): this
Rotates the vector in place using the given unit quaternion Example Playground https://playground.babylonjs.com/#R1F8YU#8
Parameters
- q: Quaternion
  the unit quaternion representing the rotation
Returns this
the current updated Vector3
Inherited from Vector3.applyRotationQuaternionInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62928

applyRotationQuaternionToRef

applyRotationQuaternionToRef<T extends Vector3>(q: Quaternion, result: T): T
Rotates the vector using the given unit quaternion and stores the new vector in result Example Playground https://playground.babylonjs.com/#R1F8YU#9
Type Parameters
- T extends Vector3
Parameters
- q: Quaternion
  the unit quaternion representing the rotation
- result: T
  the output vector
Returns T
the result
Inherited from Vector3.applyRotationQuaternionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62921

asArray

asArray(): [number, number, number]
Creates an array containing three elements : the coordinates of the Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#10

Returns [number, number, number]
a new array of numbers
Inherited from Vector3.asArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62766

clone

clone(): Vector3
Creates a new Vector3 copied from the current Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#11

Returns Vector3
the new Vector3
Inherited from Vector3.clone
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63187

copyFrom

copyFrom(source: DeepImmutableObject<Vector3>): this
Copies the given vector coordinates to the current Vector3 ones Example Playground https://playground.babylonjs.com/#R1F8YU#12
Parameters
- source: DeepImmutableObject<Vector3>
  defines the source Vector3
Returns this
the current updated Vector3
Inherited from Vector3.copyFrom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63194

copyFromFloats

copyFromFloats(x: number, y: number, z: number): this
Copies the given floats to the current Vector3 coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#13
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
Returns this
the current updated Vector3
Inherited from Vector3.copyFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63203

cross

cross(other: Vector3): Vector3
Returns a new Vector3 as the cross product of the current vector and the "other" one The cross product is then orthogonal to both current and "other" Example Playground https://playground.babylonjs.com/#R1F8YU#14
Parameters
- other: Vector3
  defines the right operand
Returns Vector3
the cross product
Inherited from Vector3.cross
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63160

divide

divide(otherVector: DeepImmutableObject<IVector3LikeInternal>): Vector3
Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones Example Playground https://playground.babylonjs.com/#R1F8YU#16
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns Vector3
the new Vector3
Inherited from Vector3.divide
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63022

divideInPlace

divideInPlace(otherVector: DeepImmutableObject<IVector3LikeInternal>): this
Divides the current Vector3 coordinates by the given ones. Example Playground https://playground.babylonjs.com/#R1F8YU#17
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.divideInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63037

divideToRef

divideToRef<T extends IVector3LikeInternal>(
otherVector: DeepImmutableObject<IVector3LikeInternal>,
result: T,
): T
Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result" Example Playground https://playground.babylonjs.com/#R1F8YU#18
Type Parameters
- T extends IVector3LikeInternal
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.divideToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63030

dot

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

equals

equals(otherVector: DeepImmutableObject<Vector3>): boolean
Returns true if the current Vector3 and the given vector coordinates are strictly equal Example Playground https://playground.babylonjs.com/#R1F8YU#19
Parameters
- otherVector: DeepImmutableObject<Vector3>
  defines the second operand
Returns boolean
true if both vectors are equals
Inherited from Vector3.equals
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62967

equalsToFloats

equalsToFloats(x: number, y: number, z: number): boolean
Returns true if the current Vector3 coordinates equals the given floats Example Playground https://playground.babylonjs.com/#R1F8YU#20
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
Returns boolean
true if both vectors are equal
Inherited from Vector3.equalsToFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62984

equalsWithEpsilon

equalsWithEpsilon(
otherVector: DeepImmutableObject<Vector3>,
epsilon?: number,
): boolean
Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon Example Playground https://playground.babylonjs.com/#R1F8YU#21
Parameters
- otherVector: DeepImmutableObject<Vector3>
  defines the second operand
- Optionalepsilon: number
  defines the minimal distance to define values as equals
Returns boolean
true if both vectors are distant less than epsilon
Inherited from Vector3.equalsWithEpsilon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62975

floor

floor(): Vector3
Gets a new Vector3 from current Vector3 floored values Example Playground https://playground.babylonjs.com/#R1F8YU#22

Returns Vector3
a new Vector3
Inherited from Vector3.floor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63092

floorToRef

floorToRef<T extends IVector3LikeInternal>(result: T): T
Gets the current Vector3's floored values and stores them in result
Type Parameters
- T extends IVector3LikeInternal
Parameters
- result: T
  the vector to store the result in
Returns T
the result vector
Inherited from Vector3.floorToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63086

fract

fract(): Vector3
Gets a new Vector3 from current Vector3 fractional values Example Playground https://playground.babylonjs.com/#R1F8YU#23

Returns Vector3
a new Vector3
Inherited from Vector3.fract
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63104

fractToRef

fractToRef<T extends IVector3LikeInternal>(result: T): T
Gets the current Vector3's fractional values and stores them in result
Type Parameters
- T extends IVector3LikeInternal
Parameters
- result: T
  the vector to store the result in
Returns T
the result vector
Inherited from Vector3.fractToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63098

fromArray

fromArray(
array: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>,
offset?: number,
): this
Update the current vector from an array Example Playground https://playground.babylonjs.com/#R1F8YU#24
Parameters
- array: DeepImmutableArray<number> | DeepImmutableObject<Float32Array>
  defines the destination array
- Optionaloffset: number
  defines the offset in the destination array
Returns this
the current Vector3
Inherited from Vector3.fromArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62782

getClassName

getClassName(): string
Gets the class name

Returns string
the string "Vector3"
Inherited from Vector3.getClassName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62755

getHashCode

getHashCode(): number
Creates the Vector3 hash code

Returns number
a number which tends to be unique between Vector3 instances
Inherited from Vector3.getHashCode
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62760

getNormalToRef

getNormalToRef(result: Vector3): Vector3
Creates a vector normal (perpendicular) to the current Vector3 and stores the result in the given vector Out of the infinite possibilities the normal chosen is the one formed by rotating the current vector 90 degrees about an axis which lies perpendicular to the current vector and its projection on the xz plane. In the case of a current vector in the xz plane the normal is calculated to be along the y axis. Example Playground https://playground.babylonjs.com/#R1F8YU#230 Example Playground https://playground.babylonjs.com/#R1F8YU#231
Parameters
- result: Vector3
  defines the Vector3 object where to store the resultant normal
Returns Vector3
the result
Inherited from Vector3.getNormalToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62913

isNonUniformWithinEpsilon

isNonUniformWithinEpsilon(epsilon: number): boolean
Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction Check if is non uniform within a certain amount of decimal places to account for this
Parameters
- epsilon: number
  the amount the values can differ
Returns boolean
if the vector is non uniform to a certain number of decimal places
Inherited from Vector3.isNonUniformWithinEpsilon
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63076

length

length(): number
Gets the length of the Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#25

Returns number
the length of the Vector3
Inherited from Vector3.length
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63110

lengthSquared

lengthSquared(): number
Gets the squared length of the Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#26

Returns number
squared length of the Vector3
Inherited from Vector3.lengthSquared
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63116

maximizeInPlace

maximizeInPlace(other: DeepImmutableObject<IVector3LikeInternal>): this
Updates the current Vector3 with the maximal coordinate values between its and the given vector ones. Example Playground https://playground.babylonjs.com/#R1F8YU#27
Parameters
- other: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.maximizeInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63051

maximizeInPlaceFromFloats

maximizeInPlaceFromFloats(x: number, y: number, z: number): this
Updates the current Vector3 with the maximal coordinate values between its and the given coordinates. Example Playground https://playground.babylonjs.com/#R1F8YU#28
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
Returns this
the current updated Vector3
Inherited from Vector3.maximizeInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63069

minimizeInPlace

minimizeInPlace(other: DeepImmutableObject<IVector3LikeInternal>): this
Updates the current Vector3 with the minimal coordinate values between its and the given vector ones Example Playground https://playground.babylonjs.com/#R1F8YU#29
Parameters
- other: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.minimizeInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63044

minimizeInPlaceFromFloats

minimizeInPlaceFromFloats(x: number, y: number, z: number): this
Updates the current Vector3 with the minimal coordinate values between its and the given coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#30
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
Returns this
the current updated Vector3
Inherited from Vector3.minimizeInPlaceFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63060

multiply

multiply(otherVector: DeepImmutableObject<IVector3LikeInternal>): Vector3
Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector Example Playground https://playground.babylonjs.com/#R1F8YU#31
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns Vector3
the new Vector3
Inherited from Vector3.multiply
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62998

multiplyByFloats

multiplyByFloats(x: number, y: number, z: number): Vector3
Returns a new Vector3 set with the result of the multiplication of the current Vector3 coordinates by the given floats Example Playground https://playground.babylonjs.com/#R1F8YU#34
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
Returns Vector3
the new Vector3
Inherited from Vector3.multiplyByFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63015

multiplyInPlace

multiplyInPlace(otherVector: DeepImmutableObject<IVector3LikeInternal>): this
Multiplies the current Vector3 coordinates by the given ones Example Playground https://playground.babylonjs.com/#R1F8YU#32
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.multiplyInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62991

multiplyToRef

multiplyToRef<T extends IVector3LikeInternal>(
otherVector: DeepImmutableObject<IVector3LikeInternal>,
result: T,
): T
Multiplies the current Vector3 by the given one and stores the result in the given vector "result" Example Playground https://playground.babylonjs.com/#R1F8YU#33
Type Parameters
- T extends IVector3LikeInternal
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.multiplyToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63006

negate

negate(): Vector3
Gets a new Vector3 set with the current Vector3 negated coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#35

Returns Vector3
a new Vector3
Inherited from Vector3.negate
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62866

negateInPlace

negateInPlace(): this
Negate this vector in place Example Playground https://playground.babylonjs.com/#R1F8YU#36

Returns this
this
Inherited from Vector3.negateInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62872

negateToRef

negateToRef<T extends IVector3LikeInternal>(result: T): T
Negate the current Vector3 and stores the result in the given vector "result" coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#37
Type Parameters
- T extends IVector3LikeInternal
Parameters
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.negateToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62879

normalize

normalize(): this
Normalize the current Vector3. Please note that this is an in place operation. Example Playground https://playground.babylonjs.com/#R1F8YU#122

Returns this
the current updated Vector3
Inherited from Vector3.normalize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63128

normalizeFromLength

normalizeFromLength(len: number): this
Normalize the current Vector3 with the given input length. Please note that this is an in place operation. Example Playground https://playground.babylonjs.com/#R1F8YU#123
Parameters
- len: number
  the length of the vector
Returns this
the current updated Vector3
Inherited from Vector3.normalizeFromLength
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63168

normalizeToNew

normalizeToNew(): Vector3
Normalize the current Vector3 to a new vector Example Playground https://playground.babylonjs.com/#R1F8YU#124

Returns Vector3
the new Vector3
Inherited from Vector3.normalizeToNew
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63174

normalizeToRef

normalizeToRef<T extends IVector3LikeInternal>(result: T): T
Normalize the current Vector3 to the reference Example Playground https://playground.babylonjs.com/#R1F8YU#125
Type Parameters
- T extends IVector3LikeInternal
Parameters
- result: T
  define the Vector3 to update
Returns T
the updated Vector3
Inherited from Vector3.normalizeToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63181

projectOnPlane

projectOnPlane(plane: Plane, origin: Vector3): Vector3
Projects the current point Vector3 to a plane along a ray starting from a specified origin and passing through the current point Vector3. Example Playground https://playground.babylonjs.com/#R1F8YU#48
Parameters
- plane: Plane
  defines the plane to project to
- origin: Vector3
  defines the origin of the projection ray
Returns Vector3
the projected vector3
Inherited from Vector3.projectOnPlane
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62951

projectOnPlaneToRef

projectOnPlaneToRef<T extends Vector3>(
    plane: Plane,
    origin: Vector3,
    result: T,
): T
Projects the current point Vector3 to a plane along a ray starting from a specified origin and passing through the current point Vector3. Example Playground https://playground.babylonjs.com/#R1F8YU#49
Type Parameters
- T extends Vector3
Parameters
- plane: Plane
  defines the plane to project to
- origin: Vector3
  defines the origin of the projection ray
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.projectOnPlaneToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62960

reorderInPlace

reorderInPlace(order: string): this
Reorders the x y z properties of the vector in place Example Playground https://playground.babylonjs.com/#R1F8YU#44
Parameters
- order: string
  new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
Returns this
the current updated vector
Inherited from Vector3.reorderInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63135

rotateByQuaternionAroundPointToRef

rotateByQuaternionAroundPointToRef<T extends Vector3>(
    quaternion: Quaternion,
    point: Vector3,
    result: T,
): T
Rotates a vector around a given point Example Playground https://playground.babylonjs.com/#R1F8YU#46
Type Parameters
- T extends Vector3
Parameters
- quaternion: Quaternion
  the rotation quaternion
- point: Vector3
  the point to rotate around
- result: T
  vector to store the result
Returns T
the resulting vector
Inherited from Vector3.rotateByQuaternionAroundPointToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63152

rotateByQuaternionToRef

rotateByQuaternionToRef<T extends Vector3>(quaternion: Quaternion, result: T): T
Rotates the vector around 0,0,0 by a quaternion Example Playground https://playground.babylonjs.com/#R1F8YU#47
Type Parameters
- T extends Vector3
Parameters
- quaternion: Quaternion
  the rotation quaternion
- result: T
  vector to store the result
Returns T
the resulting vector
Inherited from Vector3.rotateByQuaternionToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63143

scale

scale(scale: number): Vector3
Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale" Example Playground https://playground.babylonjs.com/#R1F8YU#53
Parameters
- scale: number
  defines the multiplier factor
Returns Vector3
a new Vector3
Inherited from Vector3.scale
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62893

scaleAndAddToRef

scaleAndAddToRef<T extends IVector3LikeInternal>(scale: number, result: T): T
Scale the current Vector3 values by a factor and add the result to a given Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#55
Type Parameters
- T extends IVector3LikeInternal
Parameters
- scale: number
  defines the scale factor
- result: T
  defines the Vector3 object where to store the result
Returns T
result input
Inherited from Vector3.scaleAndAddToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62943

scaleInPlace

scaleInPlace(scale: number): this
Multiplies the Vector3 coordinates by the float "scale" Example Playground https://playground.babylonjs.com/#R1F8YU#56
Parameters
- scale: number
  defines the multiplier factor
Returns this
the current updated Vector3
Inherited from Vector3.scaleInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62886

scaleToRef

scaleToRef<T extends IVector3LikeInternal>(scale: number, result: T): T
Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#57
Type Parameters
- T extends IVector3LikeInternal
Parameters
- scale: number
  defines the multiplier factor
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.scaleToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62901

set

set(x: number, y: number, z: number): this
Copies the given floats to the current Vector3 coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#58
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
Returns this
the current updated Vector3
Inherited from Vector3.set
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63212

setAll

setAll(v: number): this
Copies the given float to the current Vector3 coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#59
Parameters
- v: number
  defines the x, y and z coordinates of the operand
Returns this
the current updated Vector3
Inherited from Vector3.setAll
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63219

subtract

subtract(otherVector: DeepImmutableObject<IVector3LikeInternal>): Vector3
Returns a new Vector3, result of the subtraction of the given vector from the current Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#60
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns Vector3
the resulting Vector3
Inherited from Vector3.subtract
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62833

subtractFromFloats

subtractFromFloats(x: number, y: number, z: number): Vector3
Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates Example Playground https://playground.babylonjs.com/#R1F8YU#62
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
Returns Vector3
the resulting Vector3
Inherited from Vector3.subtractFromFloats
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62850

subtractFromFloatsToRef

subtractFromFloatsToRef<T extends IVector3LikeInternal>(
    x: number,
    y: number,
    z: number,
    result: T,
): T
Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result Example Playground https://playground.babylonjs.com/#R1F8YU#64
Type Parameters
- T extends IVector3LikeInternal
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
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.subtractFromFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62860

subtractInPlace

subtractInPlace(otherVector: DeepImmutableObject<IVector3LikeInternal>): this
Subtract the given vector from the current Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#61
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
Returns this
the current updated Vector3
Inherited from Vector3.subtractInPlace
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62826

subtractToRef

subtractToRef<T extends IVector3LikeInternal>(
otherVector: DeepImmutableObject<IVector3LikeInternal>,
result: T,
): T
Subtracts the given vector from the current Vector3 and stores the result in the vector "result". Example Playground https://playground.babylonjs.com/#R1F8YU#63
Type Parameters
- T extends IVector3LikeInternal
Parameters
- otherVector: DeepImmutableObject<IVector3LikeInternal>
  defines the second operand
- result: T
  defines the Vector3 object where to store the result
Returns T
the result
Inherited from Vector3.subtractToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62841

toArray

toArray(array: FloatArray, index?: number): this
Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#65
Parameters
- array: FloatArray
  defines the destination array
- Optionalindex: number
  defines the offset in the destination array
Returns this
the current Vector3
Inherited from Vector3.toArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62774

toQuaternion

toQuaternion(): Quaternion
Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation) Example Playground https://playground.babylonjs.com/#R1F8YU#66

Returns Quaternion
a new Quaternion object, computed from the Vector3 coordinates
Inherited from Vector3.toQuaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62788

toString

toString(): string
Creates a string representation of the Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#67

Returns string
a string with the Vector3 coordinates.
Inherited from Vector3.toString
- Defined in .temp/typedoc/docdirectory/doc.d.ts:62750

`Static`Backward

Backward(rightHandedSystem?: boolean): Vector3
Returns a new Vector3 set to (0.0, 0.0, -1.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71
Parameters
- OptionalrightHandedSystem: boolean
  is the scene right-handed (negative-z)
Returns Vector3
a new Backward Vector3
Inherited from Vector3.Backward
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63409

`Static`CatmullRom

CatmullRom(
    value1: DeepImmutableObject<Vector3>,
    value2: DeepImmutableObject<Vector3>,
    value3: DeepImmutableObject<Vector3>,
    value4: DeepImmutableObject<Vector3>,
    amount: number,
): Vector3
Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4" Example Playground https://playground.babylonjs.com/#R1F8YU#69
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first control point
- value2: DeepImmutableObject<Vector3>
  defines the second control point
- value3: DeepImmutableObject<Vector3>
  defines the third control point
- value4: DeepImmutableObject<Vector3>
  defines the fourth control point
- amount: number
  defines the amount on the spline to use
Returns Vector3
the new Vector3
Inherited from Vector3.CatmullRom
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63509

`Static`Center

Center(
value1: DeepImmutableObject<Vector3>,
value2: DeepImmutableObject<Vector3>,
): Vector3
Returns a new Vector3 located at the center between "value1" and "value2" Example Playground https://playground.babylonjs.com/#R1F8YU#72
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first operand
- value2: DeepImmutableObject<Vector3>
  defines the second operand
Returns Vector3
the new Vector3
Inherited from Vector3.Center
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63786

`Static`CenterToRef

CenterToRef<T extends Vector3>(
    value1: DeepImmutableObject<Vector3>,
    value2: DeepImmutableObject<Vector3>,
    ref: T,
): T
Gets the center of the vectors "value1" and "value2" and stores the result in the vector "ref" Example Playground https://playground.babylonjs.com/#R1F8YU#73
Type Parameters
- T extends Vector3
Parameters
- value1: DeepImmutableObject<Vector3>
  defines first vector
- value2: DeepImmutableObject<Vector3>
  defines second vector
- ref: T
  defines third vector
Returns T
ref
Inherited from Vector3.CenterToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63795

`Static`CheckExtends

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

`Static`Clamp

Clamp(
    value: DeepImmutableObject<Vector3>,
    min: DeepImmutableObject<Vector3>,
    max: DeepImmutableObject<Vector3>,
): Vector3
Returns a new Vector3 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 Example Playground https://playground.babylonjs.com/#R1F8YU#76
Parameters
- value: DeepImmutableObject<Vector3>
  defines the current value
- min: DeepImmutableObject<Vector3>
  defines the lower range value
- max: DeepImmutableObject<Vector3>
  defines the upper range value
Returns Vector3
the new Vector3
Inherited from Vector3.Clamp
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63520

`Static`ClampToRef

ClampToRef<T extends Vector3>(
    value: DeepImmutableObject<Vector3>,
    min: DeepImmutableObject<Vector3>,
    max: DeepImmutableObject<Vector3>,
    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 Example Playground https://playground.babylonjs.com/#R1F8YU#77
Type Parameters
- T extends Vector3
Parameters
- value: DeepImmutableObject<Vector3>
  defines the current value
- min: DeepImmutableObject<Vector3>
  defines the lower range value
- max: DeepImmutableObject<Vector3>
  defines the upper range value
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.ClampToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63532

`Static`Cross

Cross(
left: DeepImmutableObject<Vector3>,
right: DeepImmutableObject<Vector3>,
): Vector3
Returns a new Vector3 as the cross product of the vectors "left" and "right" The cross product is then orthogonal to both "left" and "right" Example Playground https://playground.babylonjs.com/#R1F8YU#15
Parameters
- left: DeepImmutableObject<Vector3>
  defines the left operand
- right: DeepImmutableObject<Vector3>
  defines the right operand
Returns Vector3
the cross product
Inherited from Vector3.Cross
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63616

`Static`CrossToRef

CrossToRef<T extends Vector3>(
    left: DeepImmutableObject<Vector3>,
    right: DeepImmutableObject<Vector3>,
    result: T,
): T
Sets the given vector "result" with the cross product of "left" and "right" The cross product is then orthogonal to both "left" and "right" Example Playground https://playground.babylonjs.com/#R1F8YU#78
Type Parameters
- T extends Vector3
Parameters
- left: DeepImmutableObject<Vector3>
  defines the left operand
- right: DeepImmutableObject<Vector3>
  defines the right operand
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.CrossToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63626

`Static`Distance

Distance(
value1: DeepImmutableObject<Vector3>,
value2: DeepImmutableObject<Vector3>,
): number
Returns the distance between the vectors "value1" and "value2" Example Playground https://playground.babylonjs.com/#R1F8YU#81
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first operand
- value2: DeepImmutableObject<Vector3>
  defines the second operand
Returns number
the distance
Inherited from Vector3.Distance
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63756

`Static`DistanceSquared

DistanceSquared(
value1: DeepImmutableObject<Vector3>,
value2: DeepImmutableObject<Vector3>,
): number
Returns the squared distance between the vectors "value1" and "value2" Example Playground https://playground.babylonjs.com/#R1F8YU#80
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first operand
- value2: DeepImmutableObject<Vector3>
  defines the second operand
Returns number
the squared distance
Inherited from Vector3.DistanceSquared
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63764

`Static`Dot

Dot(
left: DeepImmutableObject<Vector3>,
right: DeepImmutableObject<Vector3>,
): number
Returns the dot product (float) between the vectors "left" and "right" Example Playground https://playground.babylonjs.com/#R1F8YU#82
Parameters
- left: DeepImmutableObject<Vector3>
  defines the left operand
- right: DeepImmutableObject<Vector3>
  defines the right operand
Returns number
the dot product
Inherited from Vector3.Dot
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63601

`Static`Down

Down(): Vector3
Returns a new Vector3 set to (0.0, -1.0, 0.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71

Returns Vector3
a new down Vector3
Inherited from Vector3.Down
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63395

`Static`Forward

Forward(rightHandedSystem?: boolean): Vector3
Returns a new Vector3 set to (0.0, 0.0, 1.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71
Parameters
- OptionalrightHandedSystem: boolean
  is the scene right-handed (negative z)
Returns Vector3
a new forward Vector3
Inherited from Vector3.Forward
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63402

`Static`FromArray

FromArray(
array: DeepImmutableObject<ArrayLike<number>>,
offset?: number,
): Vector3
Returns a new Vector3 set from the index "offset" of the given array Example Playground https://playground.babylonjs.com/#R1F8YU#83
Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  defines the source array
- Optionaloffset: number
  defines the offset in the source array
Returns Vector3
the new Vector3
Inherited from Vector3.FromArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63297

`Static`FromArrayToRef

FromArrayToRef<T extends Vector3>(
    array: DeepImmutableObject<ArrayLike<number>>,
    offset: number,
    result: T,
): T
Sets the given vector "result" with the element values from the index "offset" of the given array Example Playground https://playground.babylonjs.com/#R1F8YU#84
Type Parameters
- T extends Vector3
Parameters
- array: DeepImmutableObject<ArrayLike<number>>
  defines the source array
- offset: number
  defines the offset in the source array
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.FromArrayToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63314

`Static`FromFloatArray

FromFloatArray(
array: DeepImmutableObject<Float32Array>,
offset?: number,
): Vector3
Returns a new Vector3 set from the index "offset" of the given Float32Array
Parameters
- array: DeepImmutableObject<Float32Array>
  defines the source array
- Optionaloffset: number
  defines the offset in the source array
Returns Vector3
the new Vector3

Deprecated
Please use FromArray instead.
Inherited from Vector3.FromFloatArray
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63305

`Static`FromFloatArrayToRef

FromFloatArrayToRef<T extends Vector3>(
    array: DeepImmutableObject<Float32Array>,
    offset: number,
    result: T,
): T
Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
Type Parameters
- T extends Vector3
Parameters
- array: DeepImmutableObject<Float32Array>
  defines the source array
- offset: number
  defines the offset in the source array
- result: T
  defines the Vector3 where to store the result
Returns T
result input

Deprecated
Please use FromArrayToRef instead.
Inherited from Vector3.FromFloatArrayToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63323

`Static`FromFloatsToRef

FromFloatsToRef<T extends Vector3 = Vector3>(
    x: number,
    y: number,
    z: number,
    result: T,
): T
Sets the given vector "result" with the given floats. Example Playground https://playground.babylonjs.com/#R1F8YU#85
Type Parameters
- T extends Vector3 = Vector3
Parameters
- x: number
  defines the x coordinate of the source
- y: number
  defines the y coordinate of the source
- z: number
  defines the z coordinate of the source
- result: T
  defines the Vector3 where to store the result
Returns T
the result vector
Inherited from Vector3.FromFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63333

`Static`GetAngleBetweenVectors

GetAngleBetweenVectors(
    vector0: DeepImmutableObject<Vector3>,
    vector1: DeepImmutableObject<Vector3>,
    normal: DeepImmutableObject<Vector3>,
): number
Get angle between two vectors Example Playground https://playground.babylonjs.com/#R1F8YU#86
Parameters
- vector0: DeepImmutableObject<Vector3>
  the starting point
- vector1: DeepImmutableObject<Vector3>
  the ending point
- normal: DeepImmutableObject<Vector3>
  direction of the normal
Returns number
the angle between vector0 and vector1
Inherited from Vector3.GetAngleBetweenVectors
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63238

`Static`GetAngleBetweenVectorsOnPlane

GetAngleBetweenVectorsOnPlane(
    vector0: DeepImmutableObject<Vector3>,
    vector1: DeepImmutableObject<Vector3>,
    normal: DeepImmutableObject<Vector3>,
): number
Get angle between two vectors projected on a plane Example Playground https://playground.babylonjs.com/#R1F8YU#87 Expectation compute time: 0.01 ms (median) and 0.02 ms (percentile 95%)
Parameters
- vector0: DeepImmutableObject<Vector3>
  angle between vector0 and vector1
- vector1: DeepImmutableObject<Vector3>
  angle between vector0 and vector1
- normal: DeepImmutableObject<Vector3>
  Normal of the projection plane
Returns number
the angle in radians (float) between vector0 and vector1 projected on the plane with the specified normal
Inherited from Vector3.GetAngleBetweenVectorsOnPlane
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63248

`Static`GetClipFactor

GetClipFactor(
    vector0: DeepImmutableObject<Vector3>,
    vector1: DeepImmutableObject<Vector3>,
    axis: DeepImmutableObject<Vector3>,
    size: number,
): number
Get the clip factor between two vectors Example Playground https://playground.babylonjs.com/#R1F8YU#126
Parameters
- vector0: DeepImmutableObject<Vector3>
  defines the first operand
- vector1: DeepImmutableObject<Vector3>
  defines the second operand
- axis: DeepImmutableObject<Vector3>
  defines the axis to use
- size: number
  defines the size along the axis
Returns number
the clip factor
Inherited from Vector3.GetClipFactor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63229

`Static`Hermite

Hermite(
    value1: DeepImmutableObject<Vector3>,
    tangent1: DeepImmutableObject<Vector3>,
    value2: DeepImmutableObject<Vector3>,
    tangent2: DeepImmutableObject<Vector3>,
    amount: number,
): Vector3
Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2" Example Playground https://playground.babylonjs.com/#R1F8YU#89
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first control point
- tangent1: DeepImmutableObject<Vector3>
  defines the first tangent vector
- value2: DeepImmutableObject<Vector3>
  defines the second control point
- tangent2: DeepImmutableObject<Vector3>
  defines the second tangent vector
- amount: number
  defines the amount on the interpolation spline (between 0 and 1)
Returns Vector3
the new Vector3
Inherited from Vector3.Hermite
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63551

`Static`Hermite1stDerivative

Hermite1stDerivative(
    value1: DeepImmutableObject<Vector3>,
    tangent1: DeepImmutableObject<Vector3>,
    value2: DeepImmutableObject<Vector3>,
    tangent2: DeepImmutableObject<Vector3>,
    time: number,
): Vector3
Returns a new Vector3 which is the 1st derivative of the Hermite spline defined by the vectors "value1", "value2", "tangent1", "tangent2". Example Playground https://playground.babylonjs.com/#R1F8YU#90
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first control point
- tangent1: DeepImmutableObject<Vector3>
  defines the first tangent
- value2: DeepImmutableObject<Vector3>
  defines the second control point
- tangent2: DeepImmutableObject<Vector3>
  defines the second tangent
- time: number
  define where the derivative must be done
Returns Vector3
1st derivative
Inherited from Vector3.Hermite1stDerivative
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63562

`Static`Hermite1stDerivativeToRef

Hermite1stDerivativeToRef<T extends Vector3>(
    value1: DeepImmutableObject<Vector3>,
    tangent1: DeepImmutableObject<Vector3>,
    value2: DeepImmutableObject<Vector3>,
    tangent2: DeepImmutableObject<Vector3>,
    time: number,
    result: T,
): T
Update a Vector3 with the 1st derivative of the Hermite spline defined by the vectors "value1", "value2", "tangent1", "tangent2". Example Playground https://playground.babylonjs.com/#R1F8YU#91
Type Parameters
- T extends Vector3
Parameters
- value1: DeepImmutableObject<Vector3>
  defines the first control point
- tangent1: DeepImmutableObject<Vector3>
  defines the first tangent
- value2: DeepImmutableObject<Vector3>
  defines the second control point
- tangent2: DeepImmutableObject<Vector3>
  defines the second tangent
- time: number
  define where the derivative must be done
- result: T
  define where to store the derivative
Returns T
result input
Inherited from Vector3.Hermite1stDerivativeToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63574

`Static`Left

Left(): Vector3
Returns a new Vector3 set to (-1.0, 0.0, 0.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71

Returns Vector3
a new left Vector3
Inherited from Vector3.Left
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63421

`Static`Lerp

Lerp(
    start: DeepImmutableObject<Vector3>,
    end: DeepImmutableObject<Vector3>,
    amount: number,
): Vector3
Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end" Example Playground https://playground.babylonjs.com/#R1F8YU#95
Parameters
- start: DeepImmutableObject<Vector3>
  defines the start value
- end: DeepImmutableObject<Vector3>
  defines the end value
- amount: number
  max defines amount between both (between 0 and 1)
Returns Vector3
the new Vector3
Inherited from Vector3.Lerp
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63583

`Static`LerpToRef

LerpToRef<T extends Vector3>(
    start: DeepImmutableObject<Vector3>,
    end: DeepImmutableObject<Vector3>,
    amount: number,
    result: T,
): T
Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end" Example Playground https://playground.babylonjs.com/#R1F8YU#93
Type Parameters
- T extends Vector3
Parameters
- start: DeepImmutableObject<Vector3>
  defines the start value
- end: DeepImmutableObject<Vector3>
  defines the end value
- amount: number
  max defines amount between both (between 0 and 1)
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.LerpToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63593

`Static`Maximize

Maximize(
left: DeepImmutableObject<Vector3>,
right: DeepImmutableObject<Vector3>,
): Vector3
Gets the maximal coordinate values between two Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#96
Parameters
- left: DeepImmutableObject<Vector3>
  defines the first operand
- right: DeepImmutableObject<Vector3>
  defines the second operand
Returns Vector3
the new Vector3
Inherited from Vector3.Maximize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63748

`Static`Minimize

Minimize(
left: DeepImmutableObject<Vector3>,
right: DeepImmutableObject<Vector3>,
): Vector3
Gets the minimal coordinate values between two Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#97
Parameters
- left: DeepImmutableObject<Vector3>
  defines the first operand
- right: DeepImmutableObject<Vector3>
  defines the second operand
Returns Vector3
the new Vector3
Inherited from Vector3.Minimize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63740

`Static`Normalize

Normalize(vector: DeepImmutableObject<Vector3>): Vector3
Returns a new Vector3 as the normalization of the given vector Example Playground https://playground.babylonjs.com/#R1F8YU#98
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to normalize
Returns Vector3
the new Vector3
Inherited from Vector3.Normalize
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63633

`Static`NormalizeToRef

NormalizeToRef<T extends Vector3>(
vector: DeepImmutableObject<Vector3>,
result: T,
): T
Sets the given vector "result" with the normalization of the given first vector Example Playground https://playground.babylonjs.com/#R1F8YU#98
Type Parameters
- T extends Vector3
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to normalize
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.NormalizeToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63641

`Static`One

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

Returns Vector3
a new Vector3
Inherited from Vector3.One
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63343

`Static`PitchYawRollToMoveBetweenPoints

PitchYawRollToMoveBetweenPoints(start: Vector3, target: Vector3): Vector3
Gets the rotation that aligns the roll axis (Y) to the line joining the start point to the target point Example PG https://playground.babylonjs.com/#R1F8YU#188
Parameters
- start: Vector3
  the starting point
- target: Vector3
  the target point
Returns Vector3
the rotation in the form (pitch, yaw, 0)
Inherited from Vector3.PitchYawRollToMoveBetweenPoints
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63265

`Static`PitchYawRollToMoveBetweenPointsToRef

PitchYawRollToMoveBetweenPointsToRef<T extends Vector3>(
    start: Vector3,
    target: Vector3,
    ref: T,
): T
Gets the rotation that aligns the roll axis (Y) to the line joining the start point to the target point and stores it in the ref Vector3 Example PG https://playground.babylonjs.com/#R1F8YU#189
Type Parameters
- T extends Vector3
Parameters
- start: Vector3
  the starting point
- target: Vector3
  the target point
- ref: T
  the vector3 to store the result
Returns T
ref in the form (pitch, yaw, 0)
Inherited from Vector3.PitchYawRollToMoveBetweenPointsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63257

`Static`Project

Project(
    vector: DeepImmutableObject<Vector3>,
    world: DeepImmutableObject<Matrix>,
    transform: DeepImmutableObject<Matrix>,
    viewport: DeepImmutableObject<Viewport>,
): Vector3
Project a Vector3 onto screen space Example Playground https://playground.babylonjs.com/#R1F8YU#101
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to project
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use
- transform: DeepImmutableObject<Matrix>
  defines the transform (view x projection) matrix to use
- viewport: DeepImmutableObject<Viewport>
  defines the screen viewport to use
Returns Vector3
the new Vector3
Inherited from Vector3.Project
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63651

`Static`ProjectOnTriangleToRef

ProjectOnTriangleToRef(
    vector: DeepImmutableObject<Vector3>,
    p0: DeepImmutableObject<Vector3>,
    p1: DeepImmutableObject<Vector3>,
    p2: DeepImmutableObject<Vector3>,
    ref: Vector3,
): number
Projects "vector" on the triangle determined by its extremities "p0", "p1" and "p2", stores the result in "ref" and returns the distance to the projected point. Example Playground https://playground.babylonjs.com/#R1F8YU#104 From http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.104.4264&rep=rep1&type=pdf
Parameters
- vector: DeepImmutableObject<Vector3>
  the vector to get distance from
- p0: DeepImmutableObject<Vector3>
  extremity of the triangle
- p1: DeepImmutableObject<Vector3>
  extremity of the triangle
- p2: DeepImmutableObject<Vector3>
  extremity of the triangle
- ref: Vector3
  variable to store the result to
Returns number
The distance between "ref" and "vector"
Inherited from Vector3.ProjectOnTriangleToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63778

`Static`ProjectToRef

ProjectToRef<T extends Vector3>(
    vector: DeepImmutableObject<Vector3>,
    world: DeepImmutableObject<Matrix>,
    transform: DeepImmutableObject<Matrix>,
    viewport: DeepImmutableObject<Viewport>,
    result: T,
): T
Project a Vector3 onto screen space to reference Example Playground https://playground.babylonjs.com/#R1F8YU#102
Type Parameters
- T extends Vector3
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to project
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use
- transform: DeepImmutableObject<Matrix>
  defines the transform (view x projection) matrix to use
- viewport: DeepImmutableObject<Viewport>
  defines the screen viewport to use
- result: T
  the vector in which the screen space will be stored
Returns T
result input
Inherited from Vector3.ProjectToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63662

`Static`Random

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

`Static`RandomToRef

RandomToRef<T extends Vector3>(
    min: undefined | number,
    max: undefined | number,
    ref: T,
): T
Sets a Vector3 with random values between min and max
Type Parameters
- T extends Vector3
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
Inherited from Vector3.RandomToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63436

`Static`Reflect

Reflect(
inDirection: DeepImmutableObject<Vector3>,
normal: DeepImmutableObject<Vector3>,
): Vector3
Reflects a vector off the plane defined by a normalized normal
Parameters
- inDirection: DeepImmutableObject<Vector3>
  defines the vector direction
- normal: DeepImmutableObject<Vector3>
  defines the normal - Must be normalized
Returns Vector3
the resulting vector
Inherited from Vector3.Reflect
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63669

`Static`ReflectToRef

ReflectToRef<T extends Vector3>(
    inDirection: DeepImmutableObject<Vector3>,
    normal: DeepImmutableObject<Vector3>,
    ref: T,
): T
Reflects a vector off the plane defined by a normalized normal to reference
Type Parameters
- T extends Vector3
Parameters
- inDirection: DeepImmutableObject<Vector3>
  defines the vector direction
- normal: DeepImmutableObject<Vector3>
  defines the normal - Must be normalized
- ref: T
  defines the Vector3 where to store the result
Returns T
the resulting vector
Inherited from Vector3.ReflectToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63677

`Static`Right

Right(): Vector3
Returns a new Vector3 set to (1.0, 0.0, 0.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71

Returns Vector3
a new right Vector3
Inherited from Vector3.Right
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63415

`Static`RotationFromAxis

RotationFromAxis(
    axis1: DeepImmutableObject<Vector3>,
    axis2: DeepImmutableObject<Vector3>,
    axis3: DeepImmutableObject<Vector3>,
): Vector3
Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system), RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply to something in order to rotate it from its local system to the given target system Note: axis1, axis2 and axis3 are normalized during this operation Example Playground https://playground.babylonjs.com/#R1F8YU#106
Parameters
- axis1: DeepImmutableObject<Vector3>
  defines the first axis
- axis2: DeepImmutableObject<Vector3>
  defines the second axis
- axis3: DeepImmutableObject<Vector3>
  defines the third axis
Returns Vector3
a new Vector3

See
https://doc.babylonjs.com/features/featuresDeepDive/mesh/transforms/center_origin/target_align
Inherited from Vector3.RotationFromAxis
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63808

`Static`RotationFromAxisToRef

RotationFromAxisToRef<T extends Vector3>(
    axis1: DeepImmutableObject<Vector3>,
    axis2: DeepImmutableObject<Vector3>,
    axis3: DeepImmutableObject<Vector3>,
    ref: T,
): T
The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3 Example Playground https://playground.babylonjs.com/#R1F8YU#107
Type Parameters
- T extends Vector3
Parameters
- axis1: DeepImmutableObject<Vector3>
  defines the first axis
- axis2: DeepImmutableObject<Vector3>
  defines the second axis
- axis3: DeepImmutableObject<Vector3>
  defines the third axis
- ref: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.RotationFromAxisToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63818

`Static`SlerpToRef

SlerpToRef<T extends Vector3 = Vector3>(
    vector0: Vector3,
    vector1: Vector3,
    slerp: number,
    result: T,
): T
Slerp between two vectors. See also SmoothToRef Slerp is a spherical linear interpolation giving a slow in and out effect Example Playground 1 https://playground.babylonjs.com/#R1F8YU#108 Example Playground 2 https://playground.babylonjs.com/#R1F8YU#109
Type Parameters
- T extends Vector3 = Vector3
Parameters
- vector0: Vector3
  Start vector
- vector1: Vector3
  End vector
- slerp: number
  amount (will be clamped between 0 and 1)
- result: T
  The slerped vector
Returns T
The slerped vector
Inherited from Vector3.SlerpToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63278

`Static`SmoothToRef

SmoothToRef<T extends Vector3 = Vector3>(
    source: Vector3,
    goal: Vector3,
    deltaTime: number,
    lerpTime: number,
    result: T,
): T
Smooth interpolation between two vectors using Slerp Example Playground https://playground.babylonjs.com/#R1F8YU#110
Type Parameters
- T extends Vector3 = Vector3
Parameters
- source: Vector3
  source vector
- goal: Vector3
  goal vector
- deltaTime: number
  current interpolation frame
- lerpTime: number
  total interpolation time
- result: T
  the smoothed vector
Returns T
the smoothed vector
Inherited from Vector3.SmoothToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63289

`Static`TransformCoordinates

TransformCoordinates(
vector: DeepImmutableObject<Vector3>,
transformation: DeepImmutableObject<Matrix>,
): Vector3
Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector. This method computes transformed coordinates only, not transformed direction vectors (ie. it takes translation in account) Example Playground https://playground.babylonjs.com/#R1F8YU#111
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
Returns Vector3
the transformed Vector3
Inherited from Vector3.TransformCoordinates
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63445

`Static`TransformCoordinatesFromFloatsToRef

TransformCoordinatesFromFloatsToRef<T extends Vector3>(
    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 transformed coordinates only, not transformed direction vectors Example Playground https://playground.babylonjs.com/#R1F8YU#115
Type Parameters
- T extends Vector3
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 Vector3 where to store the result
Returns T
result input
Inherited from Vector3.TransformCoordinatesFromFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63467

`Static`TransformCoordinatesToRef

TransformCoordinatesToRef<T extends Vector3>(
    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 transformed coordinates only, not transformed direction vectors (ie. it takes translation in account) Example Playground https://playground.babylonjs.com/#R1F8YU#113
Type Parameters
- T extends Vector3
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.TransformCoordinatesToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63455

`Static`TransformNormal

TransformNormal(
vector: DeepImmutableObject<Vector3>,
transformation: DeepImmutableObject<Matrix>,
): Vector3
Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector This methods computes transformed normalized direction vectors only (ie. it does not apply translation) Example Playground https://playground.babylonjs.com/#R1F8YU#112
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
Returns Vector3
the new Vector3
Inherited from Vector3.TransformNormal
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63476

`Static`TransformNormalFromFloatsToRef

TransformNormalFromFloatsToRef<T extends Vector3>(
    x: number,
    y: number,
    z: 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) This methods computes transformed normalized direction vectors only (ie. it does not apply translation) Example Playground https://playground.babylonjs.com/#R1F8YU#116
Type Parameters
- T extends Vector3
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 Vector3 where to store the result
Returns T
result input
Inherited from Vector3.TransformNormalFromFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63498

`Static`TransformNormalToRef

TransformNormalToRef<T extends Vector3>(
    vector: DeepImmutableObject<Vector3>,
    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 (ie. it does not apply translation) Example Playground https://playground.babylonjs.com/#R1F8YU#114
Type Parameters
- T extends Vector3
Parameters
- vector: DeepImmutableObject<Vector3>
  defines the Vector3 to transform
- transformation: DeepImmutableObject<Matrix>
  defines the transformation matrix
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.TransformNormalToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63486

`Static`Unproject

Unproject(
    source: DeepImmutableObject<Vector3>,
    viewportWidth: number,
    viewportHeight: number,
    world: DeepImmutableObject<Matrix>,
    view: DeepImmutableObject<Matrix>,
    projection: DeepImmutableObject<Matrix>,
): Vector3
Unproject from screen space to object space Example Playground https://playground.babylonjs.com/#R1F8YU#117
Parameters
- source: DeepImmutableObject<Vector3>
  defines the screen space Vector3 to use
- viewportWidth: number
  defines the current width of the viewport
- viewportHeight: number
  defines the current height of the viewport
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use (can be set to Identity to go to world space)
- view: DeepImmutableObject<Matrix>
  defines the view matrix to use
- projection: DeepImmutableObject<Matrix>
  defines the projection matrix to use
Returns Vector3
the new Vector3
Inherited from Vector3.Unproject
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63704

`Static`UnprojectFloatsToRef

UnprojectFloatsToRef<T extends Vector3>(
    sourceX: number,
    sourceY: number,
    sourceZ: number,
    viewportWidth: number,
    viewportHeight: number,
    world: DeepImmutableObject<Matrix>,
    view: DeepImmutableObject<Matrix>,
    projection: DeepImmutableObject<Matrix>,
    result: T,
): T
Unproject from screen space to object space Example Playground https://playground.babylonjs.com/#R1F8YU#120
Type Parameters
- T extends Vector3
Parameters
- sourceX: number
  defines the screen space x coordinate to use
- sourceY: number
  defines the screen space y coordinate to use
- sourceZ: number
  defines the screen space z coordinate to use
- viewportWidth: number
  defines the current width of the viewport
- viewportHeight: number
  defines the current height of the viewport
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use (can be set to Identity to go to world space)
- view: DeepImmutableObject<Matrix>
  defines the view matrix to use
- projection: DeepImmutableObject<Matrix>
  defines the projection matrix to use
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.UnprojectFloatsToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63732

`Static`UnprojectFromTransform

UnprojectFromTransform(
    source: DeepImmutableObject<Vector3>,
    viewportWidth: number,
    viewportHeight: number,
    world: DeepImmutableObject<Matrix>,
    transform: DeepImmutableObject<Matrix>,
): Vector3
Unproject from screen space to object space Example Playground https://playground.babylonjs.com/#R1F8YU#121
Parameters
- source: DeepImmutableObject<Vector3>
  defines the screen space Vector3 to use
- viewportWidth: number
  defines the current width of the viewport
- viewportHeight: number
  defines the current height of the viewport
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use (can be set to Identity to go to world space)
- transform: DeepImmutableObject<Matrix>
  defines the transform (view x projection) matrix to use
Returns Vector3
the new Vector3
Inherited from Vector3.UnprojectFromTransform
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63692

`Static`UnprojectToRef

UnprojectToRef<T extends Vector3>(
    source: DeepImmutableObject<Vector3>,
    viewportWidth: number,
    viewportHeight: number,
    world: DeepImmutableObject<Matrix>,
    view: DeepImmutableObject<Matrix>,
    projection: DeepImmutableObject<Matrix>,
    result: T,
): T
Unproject from screen space to object space Example Playground https://playground.babylonjs.com/#R1F8YU#119
Type Parameters
- T extends Vector3
Parameters
- source: DeepImmutableObject<Vector3>
  defines the screen space Vector3 to use
- viewportWidth: number
  defines the current width of the viewport
- viewportHeight: number
  defines the current height of the viewport
- world: DeepImmutableObject<Matrix>
  defines the world matrix to use (can be set to Identity to go to world space)
- view: DeepImmutableObject<Matrix>
  defines the view matrix to use
- projection: DeepImmutableObject<Matrix>
  defines the projection matrix to use
- result: T
  defines the Vector3 where to store the result
Returns T
result input
Inherited from Vector3.UnprojectToRef
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63717

`Static`Up

Up(): Vector3
Returns a new Vector3 set to (0.0, 1.0, 0.0) Example Playground https://playground.babylonjs.com/#R1F8YU#71

Returns Vector3
a new up Vector3
Inherited from Vector3.Up
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63349

`Static`Zero

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

Returns Vector3
a new empty Vector3
Inherited from Vector3.Zero
- Defined in .temp/typedoc/docdirectory/doc.d.ts:63338

Class Vector3WithInfo

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Vector3WithInfo

Properties

buttonIndex

Readonlydimension

See

Readonlyrank

See

Static_V8PerformanceHack

Accessors

hasAZeroComponent

Returns boolean

isNonUniform

Returns boolean

x

Returns number

Parameters

Returns void

y

Returns number

Parameters

Returns void

z

Returns number

Parameters

Returns void

StaticDownReadOnly

Returns DeepImmutableObject<Vector3>

StaticLeftHandedBackwardReadOnly

Returns DeepImmutableObject<Vector3>

StaticLeftHandedForwardReadOnly

Returns DeepImmutableObject<Vector3>

StaticLeftReadOnly

Returns DeepImmutableObject<Vector3>

StaticOneReadOnly

Returns DeepImmutableObject<Vector3>

StaticRightHandedBackwardReadOnly

Returns DeepImmutableObject<Vector3>

StaticRightHandedForwardReadOnly

Returns DeepImmutableObject<Vector3>

StaticRightReadOnly

Returns DeepImmutableObject<Vector3>

StaticUpReadOnly

Returns DeepImmutableObject<Vector3>

StaticZeroReadOnly

Returns DeepImmutableObject<Vector3>

Methods

add

Parameters

Returns Vector3

addInPlace

Parameters

Returns this

addInPlaceFromFloats

Parameters

Returns this

addToRef

Type Parameters

Parameters

Returns T

applyRotationQuaternion

Parameters

Returns Vector3

applyRotationQuaternionInPlace

Parameters

Returns this

applyRotationQuaternionToRef

Type Parameters

Parameters

Returns T

asArray

`Readonly`dimension

`Readonly`rank

`Static`_V8PerformanceHack

`Static`DownReadOnly

`Static`LeftHandedBackwardReadOnly

`Static`LeftHandedForwardReadOnly

`Static`LeftReadOnly

`Static`OneReadOnly

`Static`RightHandedBackwardReadOnly

`Static`RightHandedForwardReadOnly

`Static`RightReadOnly

`Static`UpReadOnly

`Static`ZeroReadOnly