Class Sphere

A sphere, represented by its center and radius.

record

Hierarchy

Sphere

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Sphere(): Sphere

Returns Sphere

Properties

Static name

name: string

Methods

containsPoint

containsPoint(point: Point3D): boolean

- Defined in Graphene-1.0.d.ts:2504
Checks whether the given point is contained in the volume of a #graphene_sphere_t.

Parameters
- point: Point3D
  
  a #graphene_point3d_t
Returns boolean

distance

distance(point: Point3D): number

- Defined in Graphene-1.0.d.ts:2510
Computes the distance of the given point from the surface of a #graphene_sphere_t.

Parameters
- point: Point3D
  
  a #graphene_point3d_t
Returns number

equal

equal(b: Sphere): boolean

- Defined in Graphene-1.0.d.ts:2515
Checks whether two #graphene_sphere_t are equal.

Parameters
- b: Sphere
  
  a #graphene_sphere_t
Returns boolean

free

free(): void

- Defined in Graphene-1.0.d.ts:2519
Frees the resources allocated by graphene_sphere_alloc().

Returns void

getBoundingBox

getBoundingBox(): Graphene.Box

- Defined in Graphene-1.0.d.ts:2524
Computes the bounding box capable of containing the given #graphene_sphere_t.

Returns Graphene.Box

getCenter

getCenter(): Point3D

- Defined in Graphene-1.0.d.ts:2528
Retrieves the coordinates of the center of a #graphene_sphere_t.

Returns Point3D

getRadius

getRadius(): number

- Defined in Graphene-1.0.d.ts:2532
Retrieves the radius of a #graphene_sphere_t.

Returns number

init

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

- Defined in Graphene-1.0.d.ts:2538
Initializes the given #graphene_sphere_t 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

initFromPoints

initFromPoints(points: Point3D[], center: Point3D): Sphere

- Defined in Graphene-1.0.d.ts:2548
Initializes the given #graphene_sphere_t 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_t
- center: Point3D
  
  the center of the sphere
Returns Sphere

initFromVectors

initFromVectors(vectors: Graphene.Vec3[], center: Point3D): Sphere

- Defined in Graphene-1.0.d.ts:2558
Initializes the given #graphene_sphere_t 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: Graphene.Vec3[]
  
  an array of #graphene_vec3_t
- center: Point3D
  
  the center of the sphere
Returns Sphere

isEmpty

isEmpty(): boolean

- Defined in Graphene-1.0.d.ts:2562
Checks whether the sphere has a zero radius.

Returns boolean

translate

translate(point: Point3D): Sphere

- Defined in Graphene-1.0.d.ts:2568
Translates the center of the given #graphene_sphere_t using the point coordinates as the delta of the translation.

Parameters
- point: Point3D
  
  the coordinates of the translation
Returns Sphere

Static alloc

alloc(): Sphere

- Defined in Graphene-1.0.d.ts:2589
Allocates a new #graphene_sphere_t.

The contents of the newly allocated structure are undefined.

Returns Sphere