vrplane

Module: Maths

A plane.

#include <lua_api.h>

Public Functions

Type	Name
Any	copy() (vrCopy) Returns a copy of a Vector, Matrix, Ray, Sphere, AABBox, Quaternion or Plane
number	getDistance(vrvec3](../classes/vrvec3.mdx) point) (vrPlaneGetPointDistance) Returns the distance a point is from the plane. A negative value means that the point is behind the plane. A positive value means the point is in front. A zero means it is on the plane.
boolean	lineIntersect(vrvec3](../classes/vrvec3.mdx) point1, vrvec3 point2) (vrPlaneLineIntersect) Returns whether or not a line made of two points will intersect a plane.
Any	operator=()
number	rayIntersect(vrray](../classes/vrray.mdx) ray) (vrPlaneRayIntersect) Returns how far along the ray an intersection point with this plane is.
vrplane	transform(vrmatrix4](../classes/vrmatrix4.mdx) mat) (vrPlaneTransform) Returns a plane transformed by a matrix.

Public Attributes

Type	Name
number	distance Dot product of any point on the plane with its normal.
vrvec3	normal Normal of the plane.

Public Functions Documentation

copy

Any copy()

(vrCopy) Returns a copy of a Vector, Matrix, Ray, Sphere, AABBox, Quaternion or Plane

getDistance

number getDistance(
    vrvec3 point
)

(vrPlaneGetPointDistance) Returns the distance a point is from the plane. A negative value means that the point is behind the plane. A positive value means the point is in front. A zero means it is on the plane.

lineIntersect

boolean lineIntersect(
    vrvec3 point1,
    vrvec3 point2
)

(vrPlaneLineIntersect) Returns whether or not a line made of two points will intersect a plane.

Return: true if the line intersects the plane

operator=

Any operator=()

rayIntersect

number rayIntersect(
    vrray ray
)

(vrPlaneRayIntersect) Returns how far along the ray an intersection point with this plane is.

transform

vrplane transform(
    vrmatrix4 mat
)

(vrPlaneTransform) Returns a plane transformed by a matrix.

Public Attributes Documentation

distance

number distance;

Dot product of any point on the plane with its normal.

normal

vrvec3 normal;

Normal of the plane.