Class Point3D

A point with three components: X, Y, and Z.

record

Hierarchy

Point3D

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Point3D(): Point3D

Returns Point3D

Properties

x

x: number

the X coordinate

field

y

y: number

the Y coordinate

field

z

z: number

the Z coordinate

field

Static name

name: string

Methods

cross

cross(b: Point3D): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1625
Computes the cross product of the two given #graphene_point3d_t.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
Returns Point3D

distance

distance(b: Point3D): [number, Graphene.Vec3]

- Defined in @types/Gjs/Graphene-1.0.d.ts:1630
Computes the distance between the two given #graphene_point3d_t.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
Returns [number, Graphene.Vec3]

dot

dot(b: Point3D): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:1635
Computes the dot product of the two given #graphene_point3d_t.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
Returns number

equal

equal(b: Point3D): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:1640
Checks whether two given points are equal.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
Returns boolean

free

free(): void

- Defined in @types/Gjs/Graphene-1.0.d.ts:1644
Frees the resources allocated via graphene_point3d_alloc().

Returns void

init

init(x: number, y: number, z: number): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1651
Initializes a #graphene_point3d_t with the given coordinates.

Parameters
- x: number
  
  the X coordinate of the point
- y: number
  
  the Y coordinate of the point
- z: number
  
  the Z coordinate of the point
Returns Point3D

init_from_point

init_from_point(src: Point3D): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1657
Initializes a #graphene_point3d_t using the coordinates of another #graphene_point3d_t.

Parameters
- src: Point3D
  
  a #graphene_point3d_t
Returns Point3D

init_from_vec3

init_from_vec3(v: Graphene.Vec3): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1663
Initializes a #graphene_point3d_t using the components of a #graphene_vec3_t.

Parameters
- v: Graphene.Vec3
  
  a #graphene_vec3_t
Returns Point3D

interpolate

interpolate(b: Point3D, factor: number): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1670
Linearly interpolates each component of a and b using the provided factor, and places the result in res.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
- factor: number
  
  the interpolation factor
Returns Point3D

length

length(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:1675
Computes the length of the vector represented by the coordinates of the given #graphene_point3d_t.

Returns number

near

near(b: Point3D, epsilon: number): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:1682
Checks whether the two points are near each other, within an epsilon factor.

Parameters
- b: Point3D
  
  a #graphene_point3d_t
- epsilon: number
  
  fuzzyness factor
Returns boolean

normalize

normalize(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1687
Computes the normalization of the vector represented by the coordinates of the given #graphene_point3d_t.

Returns Point3D

normalize_viewport

normalize_viewport(viewport: Graphene.Rect, z_near: number, z_far: number): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1698
Normalizes the coordinates of a #graphene_point3d_t using the given viewport and clipping planes.

The coordinates of the resulting #graphene_point3d_t will be in the [ -1, 1 ] range.

Parameters
- viewport: Graphene.Rect
  
  a #graphene_rect_t representing a viewport
- z_near: number
  
  the coordinate of the near clipping plane, or 0 for the default near clipping plane
- z_far: number
  
  the coordinate of the far clipping plane, or 1 for the default far clipping plane
Returns Point3D

scale

scale(factor: number): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1704
Scales the coordinates of the given #graphene_point3d_t by the given factor.

Parameters
- factor: number
  
  the scaling factor
Returns Point3D

to_vec3

to_vec3(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:1709
Stores the coordinates of a #graphene_point3d_t into a #graphene_vec3_t.

Returns Graphene.Vec3

Static alloc

alloc(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1728
Allocates a #graphene_point3d_t structure.

Returns Point3D

Static zero

zero(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:1732
Retrieves a constant point with all three coordinates set to 0.

Returns Point3D