Class (GI Struct)

Graphene-1.0 ▶ Graphene ▶ Frustum`Since 1.2`

A 3D volume delimited by 2D clip planes.

The contents of the graphene_frustum_t are private, and should not be modified directly.

Since

1.2

Index

Constructors

Properties

Methods

contains_point equal free get_planes init init_from_frustum init_from_matrix intersects_box intersects_sphere alloc

Constructors

constructor

new Frustum(properties?: Partial<{}>): Frustum
Parameters
- Optionalproperties: Partial<{}>
Returns Frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:839

Properties

`Static`$gtype

$gtype: GType<Frustum>

Methods

contains_point

contains_point(point: Point3D): boolean
Checks whether a point is inside the volume defined by the given Graphene.Frustum.
Parameters
- point: Point3D
  a Graphene.Point3D
Returns boolean
true if the point is inside the frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:851

equal

equal(b: Frustum): boolean
Checks whether the two given Graphene.Frustum are equal.
Parameters
- b: Frustum
  a Graphene.Frustum
Returns boolean
true if the given frustums are equal
- Defined in graphene-1.0/graphene-1.0.d.ts:857

free

free(): void
Frees the resources allocated by graphene_frustum_alloc().

Returns void
- Defined in graphene-1.0/graphene-1.0.d.ts:861

get_planes

get_planes(): Plane[]
Retrieves the planes that define the given Graphene.Frustum.

Returns Plane[]
- Defined in graphene-1.0/graphene-1.0.d.ts:865

init

init(p0: Plane, p1: Plane, p2: Plane, p3: Plane, p4: Plane, p5: Plane): Frustum
Initializes the given Graphene.Frustum using the provided clipping planes.
Parameters
- p0: Plane
  a clipping plane
- p1: Plane
  a clipping plane
- p2: Plane
  a clipping plane
- p3: Plane
  a clipping plane
- p4: Plane
  a clipping plane
- p5: Plane
  a clipping plane
Returns Frustum
the initialized frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:877

init_from_frustum

init_from_frustum(src: Frustum): Frustum
Initializes the given Graphene.Frustum using the clipping planes of another Graphene.Frustum.
Parameters
- src: Frustum
  a Graphene.Frustum
Returns Frustum
the initialized frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:884

init_from_matrix

init_from_matrix(matrix: Graphene.Matrix): Frustum
Initializes a Graphene.Frustum using the given matrix.
Parameters
- matrix: Graphene.Matrix
  a Graphene.Matrix
Returns Frustum
the initialized frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:890

intersects_box

intersects_box(box: Graphene.Box): boolean
Checks whether the given box intersects a plane of a Graphene.Frustum.
Parameters
- box: Graphene.Box
  a Graphene.Box
Returns boolean
true if the box intersects the frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:897

intersects_sphere

intersects_sphere(sphere: Sphere): boolean
Checks whether the given sphere intersects a plane of a Graphene.Frustum.
Parameters
- sphere: Sphere
  a Graphene.Sphere
Returns boolean
true if the sphere intersects the frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:904

`Static`alloc

alloc(): Frustum
Returns Frustum
- Defined in graphene-1.0/graphene-1.0.d.ts:841