Graphene-1.0 ▶ Graphene ▶ Point3DSince 1.0

constructor

• new Point3D(properties?: Partial<{ x: number; y: number; z: number }>): Point3D

  Parameters

  • Optionalproperties: Partial<{ x: number; y: number; z: number }>

  Returns Point3D

x

y

z

Static$gtype

cross

• cross(b: Point3D): Point3D

  Computes the cross product of the two given Graphene.Point3D.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  Returns Point3D

distance

• distance(b: Point3D): [number, Vec3]

  Computes the distance between the two given Graphene.Point3D.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  Returns [number, Vec3]

  the distance between two points

dot

• dot(b: Point3D): number

  Computes the dot product of the two given Graphene.Point3D.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  Returns number

  the value of the dot product

equal

• equal(b: Point3D): boolean

  Checks whether two given points are equal.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  Returns boolean

  true if the points are equal

free

• free(): void

  Frees the resources allocated via graphene_point3d_alloc().

  Returns void

init

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

  Initializes a Graphene.Point3D 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

  the initialized Graphene.Point3D

init_from_point

• init_from_point(src: Point3D): Point3D

  Initializes a Graphene.Point3D using the coordinates of another Graphene.Point3D.

  Parameters

  • src: Point3D

    a Graphene.Point3D

  Returns Point3D

  the initialized point

init_from_vec3

• init_from_vec3(v: Vec3): Point3D

  Initializes a Graphene.Point3D using the components of a Graphene.Vec3.

  Parameters

  • v: Vec3

    a Graphene.Vec3

  Returns Point3D

  the initialized Graphene.Point3D

interpolate

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

  Linearly interpolates each component of a and b using the provided factor, and places the result in res.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  • factor: number

    the interpolation factor

  Returns Point3D

length

• length(): number

  Computes the length of the vector represented by the coordinates of the given Graphene.Point3D.

  Returns number

  the length of the vector represented by the point

near

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

  Checks whether the two points are near each other, within an epsilon factor.

  Parameters

  • b: Point3D

    a Graphene.Point3D

  • epsilon: number

    fuzzyness factor

  Returns boolean

  true if the points are near each other

normalize

• normalize(): Point3D

  Computes the normalization of the vector represented by the coordinates of the given Graphene.Point3D.

  Returns Point3D

normalize_viewport

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

  Normalizes the coordinates of a Graphene.Point3D using the given viewport and clipping planes.

  The coordinates of the resulting Graphene.Point3D will be in the [ -1, 1 ] range.

  Parameters

  • viewport: Graphene.Rect

    a Graphene.Rect 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

  Scales the coordinates of the given Graphene.Point3D by the given factor.

  Parameters

  • factor: number

    the scaling factor

  Returns Point3D

to_vec3

• to_vec3(): Vec3

  Stores the coordinates of a Graphene.Point3D into a Graphene.Vec3.

  Returns Vec3

Staticalloc

• alloc(): Point3D

  Returns Point3D

Staticzero

• zero(): Point3D

  Retrieves a constant point with all three coordinates set to 0.

  Returns Point3D