Class Box

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

record

Hierarchy

Box

Index

Constructors

constructor

new Box(): Graphene.Box

Returns Graphene.Box

Properties

Static name

name: string

Methods

containsBox

containsBox(b: Graphene.Box): boolean

- Defined in Graphene-1.0.d.ts:378
Checks whether the #graphene_box_t a contains the given #graphene_box_t b.

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

containsPoint

containsPoint(point: Point3D): boolean

- Defined in Graphene-1.0.d.ts:383
Checks whether box contains the given point.

Parameters
- point: Point3D
  
  the coordinates to check
Returns boolean

equal

equal(b: Graphene.Box): boolean

- Defined in Graphene-1.0.d.ts:388
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 Graphene-1.0.d.ts:393
Expands the dimensions of box to include the coordinates at point.

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

expandScalar

expandScalar(scalar: number): Graphene.Box

- Defined in Graphene-1.0.d.ts:401
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

expandVec3

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

- Defined in Graphene-1.0.d.ts:407
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 Graphene-1.0.d.ts:411
Frees the resources allocated by graphene_box_alloc().

Returns void

getBoundingSphere

getBoundingSphere(): Sphere

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

Returns Sphere

getCenter

getCenter(): Point3D

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

Returns Point3D

getDepth

getDepth(): number

- Defined in Graphene-1.0.d.ts:424
Retrieves the size of the box on the Z axis.

Returns number

getHeight

getHeight(): number

- Defined in Graphene-1.0.d.ts:428
Retrieves the size of the box on the Y axis.

Returns number

getMax

getMax(): Point3D

- Defined in Graphene-1.0.d.ts:433
Retrieves the coordinates of the maximum point of the given #graphene_box_t.

Returns Point3D

getMin

getMin(): Point3D

- Defined in Graphene-1.0.d.ts:438
Retrieves the coordinates of the minimum point of the given #graphene_box_t.

Returns Point3D

getSize

getSize(): Graphene.Vec3

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

Returns Graphene.Vec3

getVertices

getVertices(): Graphene.Vec3[]

- Defined in Graphene-1.0.d.ts:447
Computes the vertices of the given #graphene_box_t.

Returns Graphene.Vec3[]

getWidth

getWidth(): number

- Defined in Graphene-1.0.d.ts:451
Retrieves the size of the box on the X axis.

Returns number

init

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

- Defined in Graphene-1.0.d.ts:457
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

initFromBox

initFromBox(src: Graphene.Box): Graphene.Box

- Defined in Graphene-1.0.d.ts:463
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

initFromPoints

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

- Defined in Graphene-1.0.d.ts:472
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

initFromVec3

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

- Defined in Graphene-1.0.d.ts:479
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

initFromVectors

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

- Defined in Graphene-1.0.d.ts:488
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 Graphene-1.0.d.ts:496
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 Graphene-1.0.d.ts:501
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 Graphene-1.0.d.ts:523
Allocates a new #graphene_box_t.

The contents of the returned structure are undefined.

Returns Graphene.Box

Static empty

empty(): Graphene.Box

- Defined in Graphene-1.0.d.ts:529
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 Graphene-1.0.d.ts:535
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 minusOne

minusOne(): Graphene.Box

- Defined in Graphene-1.0.d.ts:542
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 Graphene-1.0.d.ts:549
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 oneMinusOne

oneMinusOne(): Graphene.Box

- Defined in Graphene-1.0.d.ts:556
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 Graphene-1.0.d.ts:562
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