Open Inventor Reference
Public Member Functions | Static Public Member Functions | Protected Member Functions
SoClipPlane Class Reference
Nodes

Clipping plane node. More...

#include <Inventor/nodes/SoClipPlane.h>

Inheritance diagram for SoClipPlane:
SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

 SoClipPlane ()
 Creates a clip plane node with default settings.
virtual void doAction (SoAction *action)
 This method performs the "typical" operation of a node for any action.
virtual void GLRender (SoGLRenderAction *action)
 These virtual functions implement all of the actions for nodes, Most of the default implementations do nothing.
virtual void callback (SoCallbackAction *action)
virtual void pick (SoPickAction *action)

Static Public Member Functions

static void initClass ()
 Initializes base node class.

Public Attributes

Fields
SoSFPlane plane
 Plane defining half-space.
SoSFBool on
 Whether clipping plane is active.

Protected Member Functions

virtual ~SoClipPlane ()

Detailed Description

This node clips all subsequent shapes in the scene graph to the half-space defined by the plane field. The half-space is the side of the plane in the direction of the plane normal. For example, if the plane is positioned at the origin and the normal is pointing down the positive X axis, everything in the negative X space will be clipped away.

Any number of clipping planes may be active simultaneously, although the graphics library may place a limit on this number during rendering.

File Format/Default
ClipPlane {
  plane 1 0 0 0
  on TRUE
}
Action Behavior
SoGLRenderAction, SoCallbackAction, SoRayPickAction
Adds the plane to the current list of clipping planes in the state.
See Also
SoCamera, SoShapeHints

Definition at line 100 of file SoClipPlane.h.

Constructor & Destructor Documentation

SoClipPlane::SoClipPlane ( )
virtual SoClipPlane::~SoClipPlane ( ) [protected, virtual]

Member Function Documentation

virtual void SoClipPlane::callback ( SoCallbackAction *  action) [virtual]

Reimplemented from SoNode.

virtual void SoClipPlane::doAction ( SoAction *  action) [virtual]

The default implementation does nothing.

Reimplemented from SoNode.

virtual void SoClipPlane::GLRender ( SoGLRenderAction *  action) [virtual]

Reimplemented from SoNode.

static void SoClipPlane::initClass ( ) [static]

Reimplemented from SoNode.

virtual void SoClipPlane::pick ( SoPickAction *  action) [virtual]

Reimplemented from SoNode.

Member Data Documentation

SoSFBool SoClipPlane::on

Definition at line 112 of file SoClipPlane.h.

SoSFPlane SoClipPlane::plane

Definition at line 109 of file SoClipPlane.h.

The documentation for this class was generated from the following file: