API Docs for: 2.0.0
Show:

math Class

Defined in: src/viewer/math/math.js:1
Module: math
Parent Module: BIMSURFER

Math functions, used within BIMSURFER, but also available for you to use in your application code.

Methods

addVec3

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:170

Adds one three-element vector to another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Second vector

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

addVec4

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:132

Adds one four-element vector to another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Second vector

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

addVec4Scalar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:151

Adds a scalar value to each element of a four-element vector.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

addVec4Scalar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:188

Adds a scalar value to each element of a three-element vector.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

createUUID

() static

Defined in src/viewer/math/math.js:42

Returns a new UUID.

Returns:

string The new UUID

divVec3

(
  • u
  • v
  • [dest]
)
Array(Number) static

Defined in src/viewer/math/math.js:371

Divides one three-element vector by another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Second vector

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

divVec4

(
  • u
  • v
  • [dest]
)
Array(Number) static

Defined in src/viewer/math/math.js:390

Divides one four-element vector by another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Second vector

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

mulVec2Scalar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:354

Multiplies each element of a two-element vector by a scalar.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

mulVec3

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:298

Multiplies one three-element vector by another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Second vector

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

mulVec34calar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:317

Multiplies each element of a four-element vector by a scalar.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

mulVec3Scalar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:336

Multiplies each element of a three-element vector by a scalar.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

negateVec4

(
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:114

Negates a four-element vector.

Parameters:

  • v Array(Number)

    Vector to negate

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

subScalarVec4

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:279

Sets each element of a 4-element vector to a scalar value minus the value of that element.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise

subVec2

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:243

Subtracts one two-element vector from another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Vector to subtract

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

subVec3

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:225

Subtracts one three-element vector from another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Vector to subtract

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

subVec4

(
  • u
  • v
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:206

Subtracts one four-element vector from another.

Parameters:

  • u Array(Number)

    First vector

  • v Array(Number)

    Vector to subtract

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, u otherwise

subVec4Scalar

(
  • v
  • s
  • [dest]
)
Array(Number)

Defined in src/viewer/math/math.js:260

Subtracts a scalar value from each element of a four-element vector.

Parameters:

  • v Array(Number)

    The vector

  • s Number

    The scalar

  • [dest] Array(Number) optional

    Destination vector

Returns:

Array(Number):

dest if specified, v otherwise