Graphene-1.0 ▶ Graphene ▶ PointSince 1.0

constructor

• new Point(properties?: Partial<{ x: number; y: number }>): Graphene.Point

  Parameters

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

  Returns Graphene.Point

x

y

Static$gtype

distance

• distance(b: Graphene.Point): [number, number, number]

  Computes the distance between a and b.

  Parameters

  • b: Graphene.Point

    a Graphene.Point

  Returns [number, number, number]

  the distance between the two points

distance_squared

• distance_squared(b: Graphene.Point): number

  Computes the squared distance between a and b.

  Parameters

  • b: Graphene.Point

    a Graphene.Point

  Returns number

  the distance between the two points, squared

equal

• equal(b: Graphene.Point): boolean

  Checks if the two points a and b point to the same coordinates.

  This function accounts for floating point fluctuations; if you want to control the fuzziness of the match, you can use graphene_point_near() instead.

  Parameters

  • b: Graphene.Point

    a Graphene.Point

  Returns boolean

  true if the points have the same coordinates

free

• free(): void

  Frees the resources allocated by graphene_point_alloc().

  Returns void

init

• init(x: number, y: number): Graphene.Point

  Initializes p to the given x and y coordinates.

  It's safe to call this function multiple times.

  Parameters

  • x: number

    the X coordinate

  • y: number

    the Y coordinate

  Returns Graphene.Point

  the initialized point

init_from_point

• init_from_point(src: Graphene.Point): Graphene.Point

  Initializes p with the same coordinates of src.

  Parameters

  • src: Graphene.Point

    the Graphene.Point to use

  Returns Graphene.Point

  the initialized point

init_from_vec2

• init_from_vec2(src: Vec2): Graphene.Point

  Initializes p with the coordinates inside the given Graphene.Vec2.

  Parameters

  • src: Vec2

    a Graphene.Vec2

  Returns Graphene.Point

  the initialized point

interpolate

• interpolate(b: Graphene.Point, factor: number): Graphene.Point

  Linearly interpolates the coordinates of a and b using the given factor.

  Parameters

  • b: Graphene.Point

    a Graphene.Point

  • factor: number

    the linear interpolation factor

  Returns Graphene.Point

near

• near(b: Graphene.Point, epsilon: number): boolean

  Checks whether the two points a and b are within the threshold of epsilon.

  Parameters

  • b: Graphene.Point

    a Graphene.Point

  • epsilon: number

    threshold between the two points

  Returns boolean

  true if the distance is within epsilon

to_vec2

• to_vec2(): Vec2

  Stores the coordinates of the given Graphene.Point into a Graphene.Vec2.

  Returns Vec2

Staticalloc

• alloc(): Graphene.Point

  Returns Graphene.Point

Staticzero

• zero(): Graphene.Point

  Returns a point fixed at (0, 0).

  Returns Graphene.Point