SoClipPlane: The soclipplane class is a node type for specifying clipping planes. a scene graph without any soclipplane nodes uses six clipping planes to define the viewing frustum: top, bottom, left, right, near and far. if you want extra clipping planes for 'slicing' the visible geometry, you can do that by using nodes of this type. geometry on the back side of the clipping plane is clipped away.

SYNOPSIS

#include <Inventor/nodes/SoClipPlane.h>

Inherits SoNode.

Inherited by SoClipPlaneManip.

Public Member Functions

virtual SoType getTypeId (void) const

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. SoClipPlane (void)

virtual void doAction (SoAction *action)

virtual void GLRender (SoGLRenderAction *action)

virtual void callback (SoCallbackAction *action)

virtual void pick (SoPickAction *action)

Static Public Member Functions

static SoType getClassTypeId (void)

static void initClass (void)

Public Attributes

SoSFPlane plane

SoSFBool on

Protected Member Functions

virtual const SoFieldData * getFieldData (void) const

virtual ~SoClipPlane ()

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)

Additional Inherited Members

Detailed Description

The SoClipPlane class is a node type for specifying clipping planes.

A scene graph without any SoClipPlane nodes uses six clipping planes to define the viewing frustum: top, bottom, left, right, near and far. If you want extra clipping planes for 'slicing' the visible geometry, you can do that by using nodes of this type. Geometry on the back side of the clipping plane is clipped away.

Note that OpenGL implementations have a fixed maximum number of clipping planes available. To find out what this number is, you can use the following code:

#include <Inventor/elements/SoGLClipPlaneElement.h>
// ...[snip]...
int maxplanes = SoGLClipPlaneElement::getMaxGLPlanes();

Below is a simple, basic scene graph usage example of SoClipPlane. It connects an SoClipPlane to an SoCenterballDragger, for end-user control over the orientation and position of the clipping plane:

#Inventor V2.1 ascii

Separator {
   Separator {
      Translation { translation -6 0 0 }
      DEF cbdragger CenterballDragger { }
   }

   TransformSeparator {
      Transform {
         rotation 0 0 1 0 = USE cbdragger . rotation
         translation 0 0 0 = USE cbdragger . center
      }
      ClipPlane { }
   }

   Sphere { }
}

Note that SoClipPlane is a state-changing appearance node, and as such, it will only assert its effects under the current SoSeparator node (as the SoSeparator pops the state stack when traversal returns above it), as can be witnessed by loading this simple example file into a Coin viewer:

#Inventor V2.1 ascii

Separator {
   ClipPlane { }
   Cube { }
}

Separator {
   Translation { translation -3 0 0 }
   Cube { }
}

FILE FORMAT/DEFAULTS:

ClipPlane {
    plane 1 0 0  0
    on TRUE
}

Constructor & Destructor Documentation

SoClipPlane::SoClipPlane (void)

Constructor.

SoClipPlane::~SoClipPlane ()\fC [protected]\fP, \fC [virtual]\fP

Destructor.

Member Function Documentation

\fBSoType\fP SoClipPlane::getTypeId (void) const\fC [virtual]\fP

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and 'downward' casting. Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.