H3D::ClipPlane Class Reference
[H3D specific Node classes.]

This node defines a single plane equation that will be used to clip the geometry, i.e. More...

#include <ClipPlane.h>

Inheritance diagram for H3D::ClipPlane:

List of all members.

Public Member Functions
	ClipPlane (Inst< SFNode > _metadata=0, Inst< SFBool > _enabled=0, Inst< SFVec4d > _plane=0, Inst< SFBool > _clipHaptics=0, Inst< SFBool > _clipGraphics=0)
	Constructor.
virtual void	enableGraphicsState ()
	Turn the clip plane on.
virtual void	disableGraphicsState ()
	Turn the clip plane off.
Public Attributes
auto_ptr< SFBool >	enabled
	Specifies if the clipping plane should be enabled or not.
auto_ptr< SFVec4d >	plane
	The plane equation that will be used to clip the geometry.
auto_ptr< SFBool >	clipHaptics
	Specifies if the clipping plane should clip the haptics if enabled, i.e.
auto_ptr< SFBool >	clipGraphics
	Specifies if the clipping plane should clip the graphics if enabled.
Static Public Attributes
static H3DNodeDatabase	database
	The H3DNodeDatabase for this node.
Protected Attributes
int	plane_index
	The index of the plane when rendered by OpenGL.
bool	haptics_enabled
	Was haptics enabled in the last call to enableHapticsState()?
Static Protected Attributes
static GLint	max_nr_clip_planes = -1
	The maximum number of clip planes the graphics hardware supports.
static int	nr_active_clip_planes = 0
	The number of clip planes that are currently rendered.

---

Detailed Description

This node defines a single plane equation that will be used to clip the geometry, i.e.

remove parts of it from rendering.

The plane field defines a plane equation that will be used to clip the geometry. The points that are drawn are the points that satisfy the inequation: plane.x*x+plane.y*y+plane.z*z+plane.w >= 0

Clipping only occurs of the enabled field is 'true'.

The clipHaptics field specifies if the clipping plane should clip the haptics if enabled, i.e. if the haptics device is in a position that is clipped by the plane no haptics will be rendered for the device and the clipGraphics field specifies if the graphics should be clipped when the ClipPlane is enabled.

Internal routes:

---

Member Data Documentation

auto_ptr< SFBool > H3D::ClipPlane::clipGraphics

Specifies if the clipping plane should clip the graphics if enabled. Access type: inputOutput Default value: true

auto_ptr< SFBool > H3D::ClipPlane::clipHaptics

Specifies if the clipping plane should clip the haptics if enabled, i.e. if the haptics device is in a position that is clipped by the plane no haptics will be rendered for the device. Access type: inputOutput Default value: true

auto_ptr< SFBool > H3D::ClipPlane::enabled

Specifies if the clipping plane should be enabled or not. Access type: inputOutput Default value: true

int ClipPlane::max_nr_clip_planes = -1 [static, protected]

The maximum number of clip planes the graphics hardware supports. Set in the first call to enable().

auto_ptr< SFVec4d > H3D::ClipPlane::plane

The plane equation that will be used to clip the geometry. The points that are drawn are the points that satisfy the inequation: plane.x*x+plane.y*y+plane.z*z+plane.w >= 0 Access type: inputOutput Default value: Vec4d( 0, 1, 0, 0 )

int H3D::ClipPlane::plane_index [protected]

The index of the plane when rendered by OpenGL. -1 if currently not rendered.

---