Class Point3D

Represents a point in 3D space.

Hierarchy

ObservablePoint
- Point3D

Implements

IPoint3DData

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Point3D(x?: number, y?: number, z?: number, cb?: () => void, scope?: any): Point3D

Overrides ObservablePoint.constructor
- Defined in src/transform/point.ts:31
Creates a new observable point.

Parameters
- x: number = 0
  
  The position on the x axis.
- y: number = 0
  
  The position on the y axis.
- z: number = 0
  
  The position on the z axis.
- cb: () => void = ...
  
  The callback when changed.
  - - (): void
    - Returns void
- scope: any = undefined
  
  The owner of callback.
Returns Point3D

Properties

_x

_x: number

_y

_y: number

cb

cb: () => any

Type declaration

- (): any
- The callback function triggered when x and/or y are changed
  
  Returns any

scope

scope: any

The owner of the callback

Accessors

array

get array(): Float32Array
set array(value: Float32Array): void

- Defined in src/transform/point.ts:15
Array containing the x, y, z values.

Returns Float32Array
- Defined in src/transform/point.ts:19
Array containing the x, y, z values.

Parameters
- value: Float32Array
Returns void

magnitude

get magnitude(): number

- Defined in src/transform/point.ts:136
Calculates the length of the point.

Returns number

x

get x(): number
set x(value: number): void

Implementation of IPoint3DData.x
Overrides ObservablePoint.x
- Defined in src/transform/point.ts:39
Position on the x axis relative to the local coordinates of the parent.

Returns number
Implementation of IPoint3DData.x
Overrides ObservablePoint.x
- Defined in src/transform/point.ts:43
Position on the x axis relative to the local coordinates of the parent.

Parameters
- value: number
Returns void

y

get y(): number
set y(value: number): void

Implementation of IPoint3DData.y
Overrides ObservablePoint.y
- Defined in src/transform/point.ts:53
Position on the y axis relative to the local coordinates of the parent.

Returns number
Implementation of IPoint3DData.y
Overrides ObservablePoint.y
- Defined in src/transform/point.ts:57
Position on the y axis relative to the local coordinates of the parent.

Parameters
- value: number
Returns void

z

get z(): number
set z(value: number): void

Implementation of IPoint3DData.z
- Defined in src/transform/point.ts:67
Position on the z axis relative to the local coordinates of the parent.

Returns number
Implementation of IPoint3DData.z
- Defined in src/transform/point.ts:71
Position on the z axis relative to the local coordinates of the parent.

Parameters
- value: number
Returns void

Methods

clone

clone(cb?: () => any, scope?: any): Point3D

Overrides ObservablePoint.clone
- Defined in src/transform/point.ts:78
Parameters
- cb: () => any = ...
  - - (): any
    - The callback function triggered when x and/or y are changed
      
      Returns any
- scope: any = ...
Returns Point3D

copyFrom

copyFrom(p: IPoint3DData): Point3D

Overrides ObservablePoint.copyFrom
- Defined in src/transform/point.ts:82
Parameters
- p: IPoint3DData
Returns Point3D

copyTo

copyTo<T>(p: T): T

Overrides ObservablePoint.copyTo
- Defined in src/transform/point.ts:92
Type parameters
- T: IPoint<T>
Parameters
- p: T
Returns T

equals

equals(p: Point3D): boolean

Overrides ObservablePoint.equals
- Defined in src/transform/point.ts:99
Parameters
- p: Point3D
Returns boolean

normalize

normalize(out?: Point3D): Point3D

- Defined in src/transform/point.ts:131
Normalize the point.

Parameters
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

set

set(x: number, y?: number, z?: number): Point3D

Overrides ObservablePoint.set
- Defined in src/transform/point.ts:109
Sets the point to a new x, y and z position.

Parameters
- x: number
  
  The position on the x axis.
- y: number = x
  
  The position on the y axis.
- z: number = x
  
  The position on the z axis.
Returns Point3D

setFrom

setFrom(array: ArrayLike<number>): Point3D

- Defined in src/transform/point.ts:123
Sets the point to a new x, y and z position.

Parameters
- array: ArrayLike<number>
  
  The array containing x, y and z, expected length is 3.
Returns Point3D

toString

toString(): string

Inherited from ObservablePoint.toString
- Defined in node_modules/@pixi/math/index.d.ts:573
Returns string

Static add

add(a: Point3D, b: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:155
Adds two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static cross

cross(a: Point3D, b: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:175
Computes the cross product of two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static distance

distance(a: Point3D, b: Point3D): number

- Defined in src/transform/point.ts:193
Calculates the euclidian distance between two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
Returns number

Static dot

dot(a: Point3D, b: Point3D): number

- Defined in src/transform/point.ts:145
Calculates the dot product of two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
Returns number

Static inverse

inverse(a: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:184
Inverts of the components of a point.

Parameters
- a: Point3D
  
  The point to invert.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static lerp

lerp(a: Point3D, b: Point3D, t: number, out?: Point3D): Point3D

- Defined in src/transform/point.ts:245
Performs a linear interpolation between two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
- t: number
  
  The interpolation amount, in the range [0-1], between the two inputs.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static multiply

multiply(a: Point3D, b: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:212
Multiplies two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static negate

negate(a: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:221
Negates the components of a point.

Parameters
- a: Point3D
  
  The point to negate.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static scale

scale(a: Point3D, b: number, out?: Point3D): Point3D

- Defined in src/transform/point.ts:255
Scales a point by a scalar number.

Parameters
- a: Point3D
  
  The point to scale.
- b: number
  
  The amount to scale the point by.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static squaredDistance

squaredDistance(a: Point3D, b: Point3D): number

- Defined in src/transform/point.ts:202
Calculates the squared euclidian distance between two points.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
Returns number

Static subtract

subtract(a: Point3D, b: Point3D, out?: Point3D): Point3D

- Defined in src/transform/point.ts:165
Subtracts the second point from the first point.

Parameters
- a: Point3D
  
  The first point.
- b: Point3D
  
  The second point.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Static transform

transform(a: Point3D, m: Matrix4x4 | Quaternion, out?: Point3D): Point3D

- Defined in src/transform/point.ts:231
Transforms a point with a matrix or quaternion.

Parameters
- a: Point3D
  
  The point to transform.
- m: Matrix4x4 | Quaternion
  
  The matrix or quaternion to transform with.
- out: Point3D = ...
  
  The receiving point. If not supplied, a new point will be created.
Returns Point3D

Generated using TypeDoc