Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: GrapheneFrustum

[13:7] extends: object

A 3D volume delimited by 2D clip planes. The contents of the graphene_frustum_t are private, and should not be modified directly.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • GrapheneFrustum (Handle = null)

    Allocates a new #graphene_frustum_t structure. The contents of the returned structure are undefined.

    • @p Handle is an optional native handle or wrapper whose handle to adopt; when the native constructor is called.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • contains_point (object point)

    Checks whether a point is inside the volume defined by the given #graphene_frustum_t.

    • @p point is a #graphene_point3d_t.
    • @r true if the point is inside the frustum.
  • equal (object b)

    Checks whether the two given #graphene_frustum_t are equal.

    • @p b is a #graphene_frustum_t.
    • @r true if the given frustums are equal.
  • free ()

    Frees the resources allocated by graphene_frustum_alloc().

    • @r None.
  • get_planes ()

    Retrieves the planes that define the given #graphene_frustum_t.

    • @p planes is return location for an array of 6 #graphene_plane_t.
    • @r None.
  • init (object p0, object p1, object p2, object p3, object p4, object p5)

    Initializes the given #graphene_frustum_t using the provided clipping planes.

    • @p p0 is a clipping plane.
    • @p p1 is a clipping plane.
    • @p p2 is a clipping plane.
    • @p p3 is a clipping plane.
    • @p p4 is a clipping plane.
    • @p p5 is a clipping plane.
    • @r the initialized frustum.
  • init_from_frustum (object src)

    Initializes the given #graphene_frustum_t using the clipping planes of another #graphene_frustum_t.

    • @p src is a #graphene_frustum_t.
    • @r the initialized frustum.
  • init_from_matrix (object matrix)

    Initializes a #graphene_frustum_t using the given @matrix.

    • @p matrix is a #graphene_matrix_t.
    • @r the initialized frustum.
  • intersects_box (object box)

    Checks whether the given @box intersects a plane of a #graphene_frustum_t.

    • @p box is a #graphene_box_t.
    • @r true if the box intersects the frustum.
  • intersects_sphere (object sphere)

    Checks whether the given @sphere intersects a plane of a #graphene_frustum_t.

    • @p sphere is a #graphene_sphere_t.
    • @r true if the sphere intersects the frustum.