Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Point

Hierarchy

Implements

Index

Constructors

  • new Point(v?: V2d | Vector3, id?: string): Point
  • Parameters

    • Optional v: V2d | Vector3
    • Optional id: string

    Returns Point

Properties

id: string
isVector3: true
x: number
default

0

y: number
default

0

z: number
default

0

Methods

  • Adds v to this vector.

    Parameters

    • v: Vector3

    Returns Point

  • addScalar(s: number): Point
  • Parameters

    • s: number

    Returns Point

  • addScaledVector(v: Vector3, s: number): Point
  • Parameters

    • v: Vector3
    • s: number

    Returns Point

  • addVectors(a: Vector3, b: Vector3): Point
  • Sets this vector to a + b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Point

  • angleTo(v: Vector3): number
  • Parameters

    • v: Vector3

    Returns number

  • applyAxisAngle(axis: Vector3, angle: number): Point
  • Parameters

    • axis: Vector3
    • angle: number

    Returns Point

  • applyEuler(euler: Euler): Point
  • Parameters

    • euler: Euler

    Returns Point

  • applyMatrix3(m: Matrix3): Point
  • Parameters

    • m: Matrix3

    Returns Point

  • applyMatrix4(m: Matrix4): Point
  • Parameters

    • m: Matrix4

    Returns Point

  • applyNormalMatrix(m: Matrix3): Point
  • Parameters

    • m: Matrix3

    Returns Point

  • applyQuaternion(q: Quaternion): Point
  • Parameters

    • q: Quaternion

    Returns Point

  • Returns Point

  • clamp(min: Vector3, max: Vector3): Point
  • Parameters

    • min: Vector3
    • max: Vector3

    Returns Point

  • clampLength(min: number, max: number): Point
  • Parameters

    • min: number
    • max: number

    Returns Point

  • clampScalar(min: number, max: number): Point
  • Parameters

    • min: number
    • max: number

    Returns Point

  • clone(): any
  • Returns any

  • Copies value of v to this vector.

    Parameters

    • v: Vector3

    Returns Point

  • Sets this vector to cross product of itself and v.

    Parameters

    • a: Vector3

    Returns Point

  • crossVectors(a: Vector3, b: Vector3): Point
  • Sets this vector to cross product of a and b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Point

  • distanceTo(v: Vector3): number
  • Computes distance of this vector to v.

    Parameters

    • v: Vector3

    Returns number

  • distanceToManhattan(v: Vector3): number
  • deprecated

    Use {@link Vector3#manhattanDistanceTo .manhattanDistanceTo()} instead.

    Parameters

    • v: Vector3

    Returns number

  • distanceToSquared(v: Vector3): number
  • Computes squared distance of this vector to v.

    Parameters

    • v: Vector3

    Returns number

  • divide(v: Vector3): Point
  • Parameters

    • v: Vector3

    Returns Point

  • divideScalar(s: number): Point
  • Divides this vector by scalar s. Set vector to ( 0, 0, 0 ) if s == 0.

    Parameters

    • s: number

    Returns Point

  • dot(v: Vector3): number
  • Computes dot product of this vector and v.

    Parameters

    • v: Vector3

    Returns number

  • equals(v: Vector3): boolean
  • Checks for strict equality of this vector and v.

    Parameters

    • v: Vector3

    Returns boolean

  • Returns Point

  • fromArray(array: number[] | ArrayLike<number>, offset?: number): Point
  • Sets this vector's x, y and z value from the provided array or array-like.

    Parameters

    • array: number[] | ArrayLike<number>

      the source array or array-like.

    • Optional offset: number

      (optional) offset into the array. Default is 0.

    Returns Point

  • fromBufferAttribute(attribute: BufferAttribute | InterleavedBufferAttribute, index: number): Point
  • Parameters

    • attribute: BufferAttribute | InterleavedBufferAttribute
    • index: number

    Returns Point

  • getComponent(index: number): number
  • Parameters

    • index: number

    Returns number

  • length(): number
  • Computes length of this vector.

    Returns number

  • lengthManhattan(): number
  • Computes Manhattan length of this vector. http://en.wikipedia.org/wiki/Taxicab_geometry

    deprecated

    Use {@link Vector3#manhattanLength .manhattanLength()} instead.

    Returns number

  • lengthSq(): number
  • Computes squared length of this vector.

    Returns number

  • lerp(v: Vector3, alpha: number): Point
  • Parameters

    • v: Vector3
    • alpha: number

    Returns Point

  • lerpVectors(v1: Vector3, v2: Vector3, alpha: number): Point
  • Parameters

    • v1: Vector3
    • v2: Vector3
    • alpha: number

    Returns Point

  • manhattanDistanceTo(v: Vector3): number
  • Computes the Manhattan length (distance) from this vector to the given vector v

    Parameters

    • v: Vector3

    Returns number

  • manhattanLength(): number
  • Computes the Manhattan length of this vector.

    Returns number

  • Parameters

    • v: Vector3

    Returns Point

  • Parameters

    • v: Vector3

    Returns Point

  • multiply(v: Vector3): Point
  • Parameters

    • v: Vector3

    Returns Point

  • multiplyScalar(s: number): Point
  • Multiplies this vector by scalar s.

    Parameters

    • s: number

    Returns Point

  • multiplyVectors(a: Vector3, b: Vector3): Point
  • Parameters

    • a: Vector3
    • b: Vector3

    Returns Point

  • Inverts this vector.

    Returns Point

  • Normalizes this vector.

    Returns Point

  • project(camera: Camera): Point
  • Parameters

    • camera: Camera

    Returns Point

  • projectOnPlane(planeNormal: Vector3): Point
  • Parameters

    • planeNormal: Vector3

    Returns Point

  • projectOnVector(v: Vector3): Point
  • Parameters

    • v: Vector3

    Returns Point

  • Sets this vector's x, y and z from Math.random

    Returns Point

  • Returns Point

  • reflect(vector: Vector3): Point
  • Parameters

    • vector: Vector3

    Returns Point

  • Returns Point

  • Returns Point

  • set(x: number, y: number, z: number): Point
  • Sets value of this vector.

    Parameters

    • x: number
    • y: number
    • z: number

    Returns Point

  • setComponent(index: number, value: number): Point
  • Parameters

    • index: number
    • value: number

    Returns Point

  • setFromCylindrical(s: Cylindrical): Point
  • Parameters

    • s: Cylindrical

    Returns Point

  • setFromCylindricalCoords(radius: number, theta: number, y: number): Point
  • Parameters

    • radius: number
    • theta: number
    • y: number

    Returns Point

  • setFromMatrix3Column(matrix: Matrix3, index: number): Point
  • Parameters

    • matrix: Matrix3
    • index: number

    Returns Point

  • setFromMatrixColumn(matrix: Matrix4, index: number): Point
  • Parameters

    • matrix: Matrix4
    • index: number

    Returns Point

  • setFromMatrixPosition(m: Matrix4): Point
  • Parameters

    • m: Matrix4

    Returns Point

  • setFromMatrixScale(m: Matrix4): Point
  • Parameters

    • m: Matrix4

    Returns Point

  • setFromSpherical(s: Spherical): Point
  • Parameters

    • s: Spherical

    Returns Point

  • setFromSphericalCoords(r: number, phi: number, theta: number): Point
  • Parameters

    • r: number
    • phi: number
    • theta: number

    Returns Point

  • setLength(l: number): Point
  • Normalizes this vector and multiplies it by l.

    Parameters

    • l: number

    Returns Point

  • setScalar(scalar: number): Point
  • Sets all values of this vector.

    Parameters

    • scalar: number

    Returns Point

  • Parameters

    Returns Point

  • setX(x: number): Vector3
  • Sets x value of this vector.

    Parameters

    • x: number

    Returns Vector3

  • setY(y: number): Vector3
  • Sets y value of this vector.

    Parameters

    • y: number

    Returns Vector3

  • setZ(z: number): Vector3
  • Sets z value of this vector.

    Parameters

    • z: number

    Returns Vector3

  • Subtracts v from this vector.

    Parameters

    • a: Vector3

    Returns Point

  • subScalar(s: number): Point
  • Parameters

    • s: number

    Returns Point

  • subVectors(a: Vector3, b: Vector3): Point
  • Sets this vector to a - b.

    Parameters

    • a: Vector3
    • b: Vector3

    Returns Point

  • toArray(array?: number[], offset?: number): number[]
  • toArray(array?: Vector3Tuple, offset?: 0): Vector3Tuple
  • toArray(array: ArrayLike<number>, offset?: number): ArrayLike<number>
  • Returns an array [x, y, z], or copies x, y and z into the provided array.

    Parameters

    • Optional array: number[]

      (optional) array to store the vector to. If this is not provided, a new array will be created.

    • Optional offset: number

      (optional) optional offset into the array.

    Returns number[]

    The created or provided array.

  • Copies x, y and z into the provided array-like.

    Parameters

    • Optional array: Vector3Tuple

      array-like to store the vector to.

    • Optional offset: 0

      (optional) optional offset into the array-like.

    Returns Vector3Tuple

    The provided array-like.

  • Copies x, y and z into the provided array-like.

    Parameters

    • array: ArrayLike<number>

      array-like to store the vector to.

    • Optional offset: number

      (optional) optional offset into the array-like.

    Returns ArrayLike<number>

    The provided array-like.

  • toVector3(): Vector3
  • Returns Vector3

  • transformDirection(m: Matrix4): Point
  • Parameters

    • m: Matrix4

    Returns Point

  • unproject(camera: Camera): Point
  • Parameters

    • camera: Camera

    Returns Point

Generated using TypeDoc