Name
gl.ClipPlane -- specify a plane against which all geometry is clipped
Synopsis
gl.ClipPlane(plane, equationArray)
Function
Geometry is always clipped against the boundaries of a six-plane frustum in x, y, and z. gl.ClipPlane() allows the specification of additional planes, not necessarily perpendicular to the x, y, or z axis, against which all geometry is clipped. To determine the maximum number of additional clipping planes, call gl.Get() with argument #GL_MAX_CLIP_PLANES. All implementations support at least six such clipping planes. Because the resulting clipping region is the intersection of the defined half-spaces, it is always convex.

gl.ClipPlane() specifies a half-space using a four-component plane equation. When gl.ClipPlane() is called, equation is transformed by the inverse of the modelview matrix and stored in the resulting eye coordinates. Subsequent changes to the modelview matrix have no effect on the stored plane-equation components. If the dot product of the eye coordinates of a vertex with the stored plane equation components is positive or zero, the vertex is in with respect to that clipping plane. Otherwise, it is out.

To enable and disable clipping planes, call gl.Enable() and gl.Disable() with the argument #GL_CLIP_PLANEi, where i is the plane number.

All clipping planes are initially defined as (0, 0, 0, 0) in eye coordinates and are disabled.

It is always the case that #GL_CLIP_PLANEi = #GL_CLIP_PLANE0 + i.

Please consult an OpenGL reference manual for more information.

Inputs
plane
specifies which clipping plane is being positioned; symbolic names of the form #GL_CLIP_PLANEi, where i is an integer between 0 and #GL_MAX_CLIP_PLANES -1 , are accepted
equationArray
specifies an array of four double-precision floating-point values; these values are interpreted as a plane equation
Errors
#GL_INVALID_ENUM is generated if plane is not an accepted value

#GL_INVALID_OPERATION is generated if gl.ClipPlane() is executed between the execution of gl.Begin() and the corresponding execution of gl.End()

Associated gets
gl.GetClipPlane()

gl.IsEnabled() with argument #GL_CLIP_PLANEi


Show TOC