Graphene-1.0 ▶ Graphene ▶ BoxSince 1.2

constructor

• new Box(properties?: Partial<{}>): Graphene.Box

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Graphene.Box

Static$gtype

Since 1.2contains_box

• contains_box(b: Graphene.Box): boolean

  Checks whether the Graphene.Box a contains the given Graphene.Box b.

  Parameters

  • b: Graphene.Box

    a Graphene.Box

  Returns boolean

  true if the box is contained in the given box

  Since

  1.2

Since 1.2contains_point

• contains_point(point: Point3D): boolean

  Checks whether box contains the given point.

  Parameters

  • point: Point3D

    the coordinates to check

  Returns boolean

  true if the point is contained in the given box

  Since

  1.2

Since 1.2equal

• equal(b: Graphene.Box): boolean

  Checks whether the two given boxes are equal.

  Parameters

  • b: Graphene.Box

    a Graphene.Box

  Returns boolean

  true if the boxes are equal

  Since

  1.2

Since 1.2expand

• expand(point: Point3D): Graphene.Box

  Expands the dimensions of box to include the coordinates at point.

  Parameters

  • point: Point3D

    the coordinates of the point to include

  Returns Graphene.Box

  Since

  1.2

Since 1.2expand_scalar

• expand_scalar(scalar: number): Graphene.Box

  Expands the dimensions of box by the given scalar value.

  If scalar is positive, the Graphene.Box will grow; if scalar is negative, the Graphene.Box will shrink.

  Parameters

  • scalar: number

    a scalar value

  Returns Graphene.Box

  Since

  1.2

Since 1.2expand_vec3

• expand_vec3(vec: Vec3): Graphene.Box

  Expands the dimensions of box to include the coordinates of the given vector.

  Parameters

  • vec: Vec3

    the coordinates of the point to include, as a Graphene.Vec3

  Returns Graphene.Box

  Since

  1.2

Since 1.2free

• free(): void

  Frees the resources allocated by graphene_box_alloc().

  Returns void

  Since

  1.2

Since 1.2get_bounding_sphere

• get_bounding_sphere(): Sphere

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

  Returns Sphere

  Since

  1.2

Since 1.2get_center

• get_center(): Point3D

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

  Returns Point3D

  Since

  1.2

Since 1.2get_depth

• get_depth(): number

  Retrieves the size of the box on the Z axis.

  Returns number

  the depth of the box

  Since

  1.2

Since 1.2get_height

• get_height(): number

  Retrieves the size of the box on the Y axis.

  Returns number

  the height of the box

  Since

  1.2

Since 1.2get_max

• get_max(): Point3D

  Retrieves the coordinates of the maximum point of the given Graphene.Box.

  Returns Point3D

  Since

  1.2

Since 1.2get_min

• get_min(): Point3D

  Retrieves the coordinates of the minimum point of the given Graphene.Box.

  Returns Point3D

  Since

  1.2

Since 1.2get_size

• get_size(): Vec3

  Retrieves the size of the box on all three axes, and stores it into the given size vector.

  Returns Vec3

  Since

  1.2

Since 1.2get_vertices

• get_vertices(): Vec3[]

  Computes the vertices of the given Graphene.Box.

  Returns Vec3[]

  Since

  1.2

Since 1.2get_width

• get_width(): number

  Retrieves the size of the box on the X axis.

  Returns number

  the width of the box

  Since

  1.2

Since 1.2init

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

  Initializes the given Graphene.Box with two vertices.

  Parameters

  • min: Point3D

    the coordinates of the minimum vertex

  • max: Point3D

    the coordinates of the maximum vertex

  Returns Graphene.Box

  the initialized Graphene.Box

  Since

  1.2

Since 1.2init_from_box

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

  Initializes the given Graphene.Box with the vertices of another Graphene.Box.

  Parameters

  • src: Graphene.Box

    a Graphene.Box

  Returns Graphene.Box

  the initialized Graphene.Box

  Since

  1.2

Since 1.2init_from_points

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

  Initializes the given Graphene.Box 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

  Returns Graphene.Box

  the initialized Graphene.Box

  Since

  1.2

Since 1.2init_from_vec3

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

  Initializes the given Graphene.Box with two vertices stored inside Graphene.Vec3.

  Parameters

  • min: Vec3

    the coordinates of the minimum vertex

  • max: Vec3

    the coordinates of the maximum vertex

  Returns Graphene.Box

  the initialized Graphene.Box

  Since

  1.2

Since 1.2init_from_vectors

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

  Initializes the given Graphene.Box with the given array of vertices.

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

  Parameters

  • vectors: Vec3[]

    an array of Graphene.Vec3

  Returns Graphene.Box

  the initialized Graphene.Box

  Since

  1.2

Since 1.2intersection

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

  Intersects the two given Graphene.Box.

  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

  Returns [boolean, Graphene.Box]

  true if the two boxes intersect

  Since

  1.2

Since 1.2union

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

  Unions the two given Graphene.Box.

  Parameters

  • b: Graphene.Box

    the box to union to a

  Returns Graphene.Box

  Since

  1.2

Staticalloc

• alloc(): Graphene.Box

  Returns Graphene.Box

StaticSince 1.2empty

• empty(): Graphene.Box

  A degenerate Graphene.Box that can only be expanded.

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

  Returns Graphene.Box

  Since

  1.2

StaticSince 1.2infinite

• infinite(): Graphene.Box

  A degenerate Graphene.Box that cannot be expanded.

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

  Returns Graphene.Box

  Since

  1.2

StaticSince 1.2minus_one

• minus_one(): Graphene.Box

  A Graphene.Box 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

  Since

  1.2

StaticSince 1.2one

• one(): Graphene.Box

  A Graphene.Box 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

  Since

  1.2

StaticSince 1.2one_minus_one

• one_minus_one(): Graphene.Box

  A Graphene.Box 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

  Since

  1.2

StaticSince 1.2zero

• zero(): Graphene.Box

  A Graphene.Box 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

  Since

  1.2