graphene/org.gtkkn.bindings.graphene/Box

Box

class Box(pointer: <Error class: unknown class><<Error class: unknown class>>)

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

Skipped during bindings generation

parameter vertices: vertices: Out parameter is not supported
parameter points: Point3D
parameter vectors: Vec3
field min: Record field min is private
field max: Record field max is private

Since

1.2

Constructors

Box

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

grapheneBoxPointer

val grapheneBoxPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

containsBox

fun containsBox(b: Box): Boolean

Checks whether the #graphene_box_t @a contains the given #graphene_box_t @b.

containsPoint

fun containsPoint(point: Point3D): Boolean

Checks whether @box contains the given @point.

equal

fun equal(b: Box): Boolean

Checks whether the two given boxes are equal.

expand

fun expand(point: Point3D, res: Box)

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

expandScalar

fun expandScalar(scalar: Float, res: Box)

Expands the dimensions of @box by the given @scalar value.

expandVec3

fun expandVec3(vec: Vec3, res: Box)

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

free

fun free()

Frees the resources allocated by graphene_box_alloc().

getBoundingSphere

fun getBoundingSphere(sphere: Sphere)

Computes the bounding #graphene_sphere_t capable of containing the given #graphene_box_t.

getCenter

fun getCenter(center: Point3D)

Retrieves the coordinates of the center of a #graphene_box_t.

getDepth

fun getDepth(): Float

Retrieves the size of the @box on the Z axis.

getHeight

fun getHeight(): Float

Retrieves the size of the @box on the Y axis.

getMax

fun getMax(max: Point3D)

Retrieves the coordinates of the maximum point of the given #graphene_box_t.

getMin

fun getMin(min: Point3D)

Retrieves the coordinates of the minimum point of the given #graphene_box_t.

getSize

fun getSize(size: Vec3)

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

getWidth

fun getWidth(): Float

Retrieves the size of the @box on the X axis.

init

fun init(min: Point3D? = null, max: Point3D? = null): Box

Initializes the given #graphene_box_t with two vertices.

initFromBox

fun initFromBox(src: Box): Box

Initializes the given #graphene_box_t with the vertices of another #graphene_box_t.

initFromVec3

fun initFromVec3(min: Vec3? = null, max: Vec3? = null): Box

Initializes the given #graphene_box_t with two vertices stored inside #graphene_vec3_t.

intersection

fun intersection(b: Box, res: Box?): Boolean

Intersects the two given #graphene_box_t.

union

fun union(b: Box, res: Box)

Unions the two given #graphene_box_t.