H3D API  2.4.1
Classes | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
H3D::PointNormalClipPlane Class Reference

This is a ClipPlane where the plane is specified with a point and a normal. More...

#include <H3D/PointNormalClipPlane.h>

Inheritance diagram for H3D::PointNormalClipPlane:
Inheritance graph

Classes

class  PlaneEq
 The PlaneEq updates the plane equation from the values of the point and normal fields. More...
 

Public Member Functions

 PointNormalClipPlane (Inst< SFNode > _metadata=0, Inst< SFBool > _enabled=0, Inst< PlaneEq > _plane=0, Inst< SFBool > _clipHaptics=0, Inst< SFBool > _clipGraphics=0, Inst< SFVec3f > _point=0, Inst< SFVec3f > _normal=0)
 Constructor.
 
- Public Member Functions inherited from H3D::ClipPlane
 ClipPlane (Inst< SFNode > _metadata=0, Inst< SFBool > _enabled=0, Inst< SFVec4d > _plane=0, Inst< SFBool > _clipHaptics=0, Inst< SFBool > _clipGraphics=0, Inst< MFBool > _clipHapticsDevice=0)
 Constructor.
 
virtual void enableGraphicsState ()
 Turn the clip plane on.
 
virtual void disableGraphicsState ()
 Turn the clip plane off.
 
virtual void enableHapticsState (TraverseInfo &ti)
 Disable haptics if device position is on the clipped side of the clip plane. More...
 
virtual void disableHapticsState (TraverseInfo &ti)
 Reenable haptics. More...
 
bool truncateLine (const Vec3f &from, const Vec3f &to, Vec3f &result_from, Vec3f &result_to)
 Changes the line defined by [ from, to ] so that only the part of the. More...
 
- Public Member Functions inherited from H3D::X3DChildNode
 X3DChildNode (Inst< SFNode > _metadata=0)
 Constructor.
 
- Public Member Functions inherited from H3D::X3DNode
 X3DNode (Inst< SFNode > _metadata=0)
 Constructor.
 
X3DMetadataObjectgetMetadataByName (const string &_name)
 Given a name, the first X3DMetadataObject in the metadata field that matches that name is returned. More...
 
- Public Member Functions inherited from H3D::Node
 Node ()
 Constructor.
 
virtual Nodeclone (bool deepCopy=true, DeepCopyMap *deepCopyMap=NULL)
 Returns a new instance of this node type with the same state as this one. More...
 
virtual ~Node ()
 Destructor.
 
X3DPrototypeInstancegetProtoInstanceParent ()
 If this node is the root node in the proto body of a X3DPrototypeInstance then this will return that node. More...
 
void setProtoInstanceParent (X3DPrototypeInstance *p)
 Set the X3DPrototypeInstance this node is the the root node if applicaple.
 
virtual void render ()
 the render() function is used for the depth-first rendering traversal of the scene-graph. More...
 
virtual void traverseSG (TraverseInfo &ti)
 traverseSG is called once per scenegraph loop on the scene in order to traverse the scenegraph. More...
 
virtual bool lineIntersect (const Vec3f &from, const Vec3f &to, LineIntersectResult &result)
 Detect intersection between a line segment and the Node. More...
 
virtual void closestPoint (const Vec3f &p, NodeIntersectResult &result)
 Find closest point on Node to p. More...
 
virtual bool movingSphereIntersect (H3DFloat radius, const Vec3f &from, const Vec3f &to, NodeIntersectResult &result)
 Detect collision between a moving sphere and the Node. More...
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual FieldgetField (const string &_name) const
 return a pointer to the field specified by name within this instance
 
int addDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
int removeDestructCallback (void(*func)(Node *, void *), void *args)
 Add a callback function to be run on destruction of node. More...
 
- Public Member Functions inherited from H3D::H3DDisplayListObject
 H3DDisplayListObject (Inst< DisplayList > _displayList=0)
 Constructor.
 
- Public Member Functions inherited from H3D::H3DRenderStateObject
virtual ~H3DRenderStateObject ()
 Destructor.
 

Public Attributes

H3DUniquePtr< SFVec3fpoint
 A point the lies on the plane to be used as clip plane. More...
 
H3DUniquePtr< SFVec3fnormal
 The normal of the plane to be used as clip plane. More...
 
- Public Attributes inherited from H3D::ClipPlane
H3DUniquePtr< SFBoolenabled
 Specifies if the clipping plane should be enabled or not. More...
 
H3DUniquePtr< SFVec4dplane
 The plane equation that will be used to clip the geometry. More...
 
H3DUniquePtr< SFBoolclipHaptics
 Specifies if the clipping plane should clip the haptics if enabled, i.e. More...
 
H3DUniquePtr< MFBoolclipHapticsDevice
 The clipHapticsDevice field provides per haptics device control for clipping. More...
 
H3DUniquePtr< SFBoolclipGraphics
 Specifies if the clipping plane should clip the graphics if enabled. More...
 
- Public Attributes inherited from H3D::X3DNode
H3DUniquePtr< SFNodemetadata
 Meta data about the node. More...
 
- Public Attributes inherited from H3D::H3DDisplayListObject
H3DUniquePtr< DisplayListdisplayList
 The DisplayList instance handling the OpenGL caching of this object.
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::ClipPlane
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
static int nr_active_clip_planes = 0
 The number of clip planes that are currently rendered.
 
- Static Public Attributes inherited from H3D::X3DNode
static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Additional Inherited Members

- Public Types inherited from H3D::Node
typedef std::map< Node *, Node * > DeepCopyMap
 A map type used during a deep copy clone() to map from original nodes to cloned nodes.
 
- Static Public Member Functions inherited from H3D::Node
static unsigned int nrNodesAlive ()
 Returns the nr of nodes currently alive, i.e. nodes created but not destructed.
 
static int nrNodesCreated ()
 Returns the number of nodes created in total since the start of the program.
 
- Protected Member Functions inherited from H3D::Node
void cloneFieldValue (Field &_from, Field &_to, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for the clone() method. More...
 
- Static Protected Member Functions inherited from H3D::Node
static NodegetClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap)
 A helper function for nodes that implement clone() More...
 
- Protected Attributes inherited from H3D::ClipPlane
int plane_index
 The index of the plane when rendered by OpenGL. More...
 
vector< bool > haptics_enabled
 Was haptics enabled in the last call to enableHapticsState()?
 
- Static Protected Attributes inherited from H3D::ClipPlane
static GLint max_nr_clip_planes = -1
 The maximum number of clip planes the graphics hardware supports. More...
 

Detailed Description

This is a ClipPlane where the plane is specified with a point and a normal.

Everything above the plane(in the direction of the normal) will be rendered.

Internal routes:

Examples:

Member Data Documentation

◆ normal

H3DUniquePtr< SFVec3f > H3D::PointNormalClipPlane::normal

The normal of the plane to be used as clip plane.

Access type: inputOutput
Default value: Vec3f( 0, 1, 0 )

Referenced by PointNormalClipPlane().

◆ point

H3DUniquePtr< SFVec3f > H3D::PointNormalClipPlane::point

A point the lies on the plane to be used as clip plane.

Access type: inputOutput
Default value: Vec3f( 0, 0, 0 )

Referenced by PointNormalClipPlane().


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