Class Box

A 3D box, described as the volume between a minimum and a maximum vertices.

record

Hierarchy

Box

Constructors

constructor

new Box(): Graphene.Box

Returns Graphene.Box

Properties

Static name

name: string

Methods

contains_box

contains_box(b: Graphene.Box): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:379
Checks whether the #graphene_box_t a contains the given #graphene_box_t b.

Parameters
- b: Graphene.Box
  
  a #graphene_box_t
Returns boolean

contains_point

contains_point(point: Point3D): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:384
Checks whether box contains the given point.

Parameters
- point: Point3D
  
  the coordinates to check
Returns boolean

equal

equal(b: Graphene.Box): boolean

- Defined in @types/Gjs/Graphene-1.0.d.ts:389
Checks whether the two given boxes are equal.

Parameters
- b: Graphene.Box
  
  a #graphene_box_t
Returns boolean

expand

expand(point: Point3D): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:394
Expands the dimensions of box to include the coordinates at point.

Parameters
- point: Point3D
  
  the coordinates of the point to include
Returns Graphene.Box

expand_scalar

expand_scalar(scalar: number): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:402
Expands the dimensions of box by the given scalar value.

If scalar is positive, the #graphene_box_t will grow; if scalar is negative, the #graphene_box_t will shrink.

Parameters
- scalar: number
  
  a scalar value
Returns Graphene.Box

expand_vec3

expand_vec3(vec: Graphene.Vec3): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:408
Expands the dimensions of box to include the coordinates of the given vector.

Parameters
- vec: Graphene.Vec3
  
  the coordinates of the point to include, as a #graphene_vec3_t
Returns Graphene.Box

free

free(): void

- Defined in @types/Gjs/Graphene-1.0.d.ts:412
Frees the resources allocated by graphene_box_alloc().

Returns void

get_bounding_sphere

get_bounding_sphere(): Sphere

- Defined in @types/Gjs/Graphene-1.0.d.ts:417
Computes the bounding #graphene_sphere_t capable of containing the given #graphene_box_t.

Returns Sphere

get_center

get_center(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:421
Retrieves the coordinates of the center of a #graphene_box_t.

Returns Point3D

get_depth

get_depth(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:425
Retrieves the size of the box on the Z axis.

Returns number

get_height

get_height(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:429
Retrieves the size of the box on the Y axis.

Returns number

get_max

get_max(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:434
Retrieves the coordinates of the maximum point of the given #graphene_box_t.

Returns Point3D

get_min

get_min(): Point3D

- Defined in @types/Gjs/Graphene-1.0.d.ts:439
Retrieves the coordinates of the minimum point of the given #graphene_box_t.

Returns Point3D

get_size

get_size(): Graphene.Vec3

- Defined in @types/Gjs/Graphene-1.0.d.ts:444
Retrieves the size of the box on all three axes, and stores it into the given size vector.

Returns Graphene.Vec3

get_vertices

get_vertices(): Graphene.Vec3[]

- Defined in @types/Gjs/Graphene-1.0.d.ts:448
Computes the vertices of the given #graphene_box_t.

Returns Graphene.Vec3[]

get_width

get_width(): number

- Defined in @types/Gjs/Graphene-1.0.d.ts:452
Retrieves the size of the box on the X axis.

Returns number

init

init(min: Point3D, max: Point3D): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:458
Initializes the given #graphene_box_t with two vertices.

Parameters
- min: Point3D
  
  the coordinates of the minimum vertex
- max: Point3D
  
  the coordinates of the maximum vertex
Returns Graphene.Box

init_from_box

init_from_box(src: Graphene.Box): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:464
Initializes the given #graphene_box_t with the vertices of another #graphene_box_t.

Parameters
- src: Graphene.Box
  
  a #graphene_box_t
Returns Graphene.Box

init_from_points

init_from_points(points: Point3D[]): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:473
Initializes the given #graphene_box_t with the given array of vertices.

If n_points is 0, the returned box is initialized with graphene_box_empty().

Parameters
- points: Point3D[]
  
  an array of #graphene_point3d_t
Returns Graphene.Box

init_from_vec3

init_from_vec3(min: Graphene.Vec3, max: Graphene.Vec3): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:480
Initializes the given #graphene_box_t with two vertices stored inside #graphene_vec3_t.

Parameters
- min: Graphene.Vec3
  
  the coordinates of the minimum vertex
- max: Graphene.Vec3
  
  the coordinates of the maximum vertex
Returns Graphene.Box

init_from_vectors

init_from_vectors(vectors: Graphene.Vec3[]): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:489
Initializes the given #graphene_box_t with the given array of vertices.

If n_vectors is 0, the returned box is initialized with graphene_box_empty().

Parameters
- vectors: Graphene.Vec3[]
  
  an array of #graphene_vec3_t
Returns Graphene.Box

intersection

intersection(b: Graphene.Box): [boolean, Graphene.Box]

- Defined in @types/Gjs/Graphene-1.0.d.ts:497
Intersects the two given #graphene_box_t.

If the two boxes do not intersect, res will contain a degenerate box initialized with graphene_box_empty().

Parameters
- b: Graphene.Box
  
  a #graphene_box_t
Returns [boolean, Graphene.Box]

union

union(b: Graphene.Box): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:502
Unions the two given #graphene_box_t.

Parameters
- b: Graphene.Box
  
  the box to union to a
Returns Graphene.Box

Static alloc

alloc(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:524
Allocates a new #graphene_box_t.

The contents of the returned structure are undefined.

Returns Graphene.Box

Static empty

empty(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:530
A degenerate #graphene_box_t that can only be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box

Static infinite

infinite(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:536
A degenerate #graphene_box_t that cannot be expanded.

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box

Static minus_one

minus_one(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:543
A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box

Static one

one(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:550
A #graphene_box_t with the minimum vertex set at (0, 0, 0) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box

Static one_minus_one

one_minus_one(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:557
A #graphene_box_t with the minimum vertex set at (-1, -1, -1) and the maximum vertex set at (1, 1, 1).

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box

Static zero

zero(): Graphene.Box

- Defined in @types/Gjs/Graphene-1.0.d.ts:563
A #graphene_box_t with both the minimum and maximum vertices set at (0, 0, 0).

The returned value is owned by Graphene and should not be modified or freed.

Returns Graphene.Box