Graphene-1.0 ▶ Graphene ▶ PlaneSince 1.2

constructor

• new Plane(properties?: Partial<{}>): Plane

  Parameters

  • Optionalproperties: Partial<{}>

  Returns Plane

Static$gtype

distance

• distance(point: Point3D): number

  Computes the distance of point from a Graphene.Plane.

  Parameters

  • point: Point3D

    a Graphene.Point3D

  Returns number

  the distance of the given Graphene.Point3D from the plane

equal

• equal(b: Plane): boolean

  Checks whether the two given Graphene.Plane are equal.

  Parameters

  • b: Plane

    a Graphene.Plane

  Returns boolean

  true if the given planes are equal

free

• free(): void

  Frees the resources allocated by graphene_plane_alloc().

  Returns void

get_constant

• get_constant(): number

  Retrieves the distance along the normal vector of the given Graphene.Plane from the origin.

  Returns number

  the constant value of the plane

get_normal

• get_normal(): Vec3

  Retrieves the normal vector pointing towards the origin of the given Graphene.Plane.

  Returns Vec3

init

• init(normal: Vec3, constant: number): Plane

  Initializes the given Graphene.Plane using the given normal vector and constant values.

  Parameters

  • normal: 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

  the initialized plane

init_from_plane

• init_from_plane(src: Plane): Plane

  Initializes the given Graphene.Plane using the normal vector and constant of another Graphene.Plane.

  Parameters

  • src: Plane

    a Graphene.Plane

  Returns Plane

  the initialized plane

init_from_point

• init_from_point(normal: Vec3, point: Point3D): Plane

  Initializes the given Graphene.Plane using the given normal vector and an arbitrary co-planar point.

  Parameters

  • normal: Vec3

    a normal vector defining the plane pointing towards the origin

  • point: Point3D

    a Graphene.Point3D

  Returns Plane

  the initialized plane

init_from_points

• init_from_points(a: Point3D, b: Point3D, c: Point3D): Plane

  Initializes the given Graphene.Plane using the 3 provided co-planar points.

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

  Parameters

  • a: Point3D

    a Graphene.Point3D

  • b: Point3D

    a Graphene.Point3D

  • c: Point3D

    a Graphene.Point3D

  Returns Plane

  the initialized plane

init_from_vec4

• init_from_vec4(src: Vec4): Plane

  Initializes the given Graphene.Plane using the components of the given Graphene.Vec4 vector.

  Parameters

  • src: Vec4

    a Graphene.Vec4 containing the normal vector in its first three components, and the distance in its fourth component

  Returns Plane

  the initialized plane

negate

• negate(): Plane

  Negates the normal vector and constant of a Graphene.Plane, effectively mirroring the plane across the origin.

  Returns Plane

normalize

• normalize(): Plane

  Normalizes the vector of the given Graphene.Plane, and adjusts the constant accordingly.

  Returns Plane

transform

• transform(matrix: Graphene.Matrix, normal_matrix: Graphene.Matrix): Plane

  Transforms a Graphene.Plane 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

  • matrix: Graphene.Matrix

    a Graphene.Matrix

  • normal_matrix: Graphene.Matrix

    a Graphene.Matrix

  Returns Plane

Staticalloc

• alloc(): Plane

  Returns Plane