Gjsify LogoGjsify Logo

A 2D plane that extends infinitely in a 3D volume.

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

record

Hierarchy

  • Plane

Index

Constructors

Properties

name: string

Methods

  • Computes the distance of point from a #graphene_plane_t.

    Parameters

    • point: Point3D

      a #graphene_point3d_t

    Returns number

  • Checks whether the two given #graphene_plane_t are equal.

    Parameters

    • b: Plane

      a #graphene_plane_t

    Returns boolean

  • free(): void
  • getConstant(): number
  • Retrieves the distance along the normal vector of the given #graphene_plane_t from the origin.

    Returns number

  • Initializes the given #graphene_plane_t using the given normal vector and constant values.

    Parameters

    • normal: Graphene.Vec3

      a unit length normal vector defining the plane pointing towards the origin; if unset, we use the X axis by default

    • constant: number

      the distance from the origin to the plane along the normal vector; the sign determines the half-space occupied by the plane

    Returns Plane

  • Initializes the given #graphene_plane_t using the normal vector and constant of another #graphene_plane_t.

    Parameters

    • src: Plane

      a #graphene_plane_t

    Returns Plane

  • Initializes the given #graphene_plane_t using the given normal vector and an arbitrary co-planar point.

    Parameters

    • normal: Graphene.Vec3

      a normal vector defining the plane pointing towards the origin

    • point: Point3D

      a #graphene_point3d_t

    Returns Plane

  • Initializes the given #graphene_plane_t using the 3 provided co-planar points.

    The winding order is counter-clockwise, and determines which direction the normal vector will point.

    Parameters

    Returns Plane

  • Initializes the given #graphene_plane_t using the components of the given #graphene_vec4_t vector.

    Parameters

    • src: Vec4

      a #graphene_vec4_t containing the normal vector in its first three components, and the distance in its fourth component

    Returns Plane

  • Negates the normal vector and constant of a #graphene_plane_t, effectively mirroring the plane across the origin.

    Returns Plane

  • Normalizes the vector of the given #graphene_plane_t, and adjusts the constant accordingly.

    Returns Plane

  • Transforms a #graphene_plane_t p using the given matrix and normal_matrix.

    If normal_matrix is %NULL, a transformation matrix for the plane normal will be computed from matrix. If you are transforming multiple planes using the same matrix it's recommended to compute the normal matrix beforehand to avoid incurring in the cost of recomputing it every time.

    Parameters

    Returns Plane

  • Allocates a new #graphene_plane_t structure.

    The contents of the returned structure are undefined.

    Returns Plane

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method