Graphene-1.0 ▶ Graphene ▶ SphereSince 1.2

constructor

• new Sphere(properties?: Partial<{}>): Sphere

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Sphere

Static$gtype

Since 1.2contains_point

• contains_point(point: Point3D): boolean

  Checks whether the given point is contained in the volume of a Graphene.Sphere.

  Parameters

  • point: Point3D

    a Graphene.Point3D

  Returns boolean

  true if the sphere contains the point

  Since

  1.2

Since 1.2distance

• distance(point: Point3D): number

  Computes the distance of the given point from the surface of a Graphene.Sphere.

  Parameters

  • point: Point3D

    a Graphene.Point3D

  Returns number

  the distance of the point

  Since

  1.2

Since 1.2equal

• equal(b: Sphere): boolean

  Checks whether two Graphene.Sphere are equal.

  Parameters

  • b: Sphere

    a Graphene.Sphere

  Returns boolean

  true if the spheres are equal

  Since

  1.2

Since 1.2free

• free(): void

  Frees the resources allocated by graphene_sphere_alloc().

  Returns void

  Since

  1.2

Since 1.2get_bounding_box

• get_bounding_box(): Graphene.Box

  Computes the bounding box capable of containing the given Graphene.Sphere.

  Returns Graphene.Box

  Since

  1.2

Since 1.2get_center

• get_center(): Point3D

  Retrieves the coordinates of the center of a Graphene.Sphere.

  Returns Point3D

  Since

  1.2

Since 1.2get_radius

• get_radius(): number

  Retrieves the radius of a Graphene.Sphere.

  Returns number

  Since

  1.2

Since 1.2init

• init(center: Point3D, radius: number): Sphere

  Initializes the given Graphene.Sphere with the given center and radius.

  Parameters

  • center: Point3D

    the coordinates of the center of the sphere, or null for a center in (0, 0, 0)

  • radius: number

    the radius of the sphere

  Returns Sphere

  the initialized Graphene.Sphere

  Since

  1.2

Since 1.2init_from_points

• init_from_points(points: Point3D[], center: Point3D): Sphere

  Initializes the given Graphene.Sphere using the given array of 3D coordinates so that the sphere includes them.

  The center of the sphere can either be specified, or will be center of the 3D volume that encompasses all points.

  Parameters

  • points: Point3D[]

    an array of Graphene.Point3D

  • center: Point3D

    the center of the sphere

  Returns Sphere

  the initialized Graphene.Sphere

  Since

  1.2

Since 1.2init_from_vectors

• init_from_vectors(vectors: Vec3[], center: Point3D): Sphere

  Initializes the given Graphene.Sphere using the given array of 3D coordinates so that the sphere includes them.

  The center of the sphere can either be specified, or will be center of the 3D volume that encompasses all vectors.

  Parameters

  • vectors: Vec3[]

    an array of Graphene.Vec3

  • center: Point3D

    the center of the sphere

  Returns Sphere

  the initialized Graphene.Sphere

  Since

  1.2

Since 1.2is_empty

• is_empty(): boolean

  Checks whether the sphere has a zero radius.

  Returns boolean

  true if the sphere is empty

  Since

  1.2

Since 1.2translate

• translate(point: Point3D): Sphere

  Translates the center of the given Graphene.Sphere using the point coordinates as the delta of the translation.

  Parameters

  • point: Point3D

    the coordinates of the translation

  Returns Sphere

  Since

  1.2

Staticalloc

• alloc(): Sphere

  Returns Sphere