Plane

clay. Plane

# new Plane(normalopt, distanceopt)

Source:
Parameters:
Name Type Attributes Description
normal clay.Vector3 <optional>
distance number <optional>

Members

# distance :number

Source:

Constant of the plane equation, used as distance to the origin

Type:
  • number

# normal :clay.Vector3

Source:

Normal of the plane

Type:

Methods

# applyTransform() → {clay.Matrix4}

Source:

Apply an affine transform matrix to plane

Returns:
Type
clay.Matrix4

# clone() → {clay.Plane}

Source:

Clone a new plane

Returns:
Type
clay.Plane

# copy(plane)

Source:

Copy from another plane

Parameters:
Name Type Description
plane clay.Vector3

# distanceToPoint(point) → {number}

Source:

Distance from a given point to the plane

Parameters:
Name Type Description
point clay.Vector3
Returns:
Type
number

# intersectFrustum(Frustum) → {boolean}

Source:

If the plane intersect a frustum

Parameters:
Name Type Description
Frustum clay.Frustum
Returns:
Type
boolean

# intersectLine(start, end, outopt) → {clay.Vector3}

Source:

Calculate the intersection point between plane and a given line

Parameters:
Name Type Attributes Description
start clay.Vector3

start point of line

end clay.Vector3

end point of line

out clay.Vector3 <optional>
Returns:
Type
clay.Vector3

# normalize()

Source:

Normalize the plane's normal and calculate the distance

# projectPoint(point, out) → {clay.Vector3}

Source:

Calculate the projection point on the plane

Parameters:
Name Type Description
point clay.Vector3
out clay.Vector3
Returns:
Type
clay.Vector3