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

Base class for surfaces with friction. More...

#include <H3D/H3DFrictionalSurfaceNode.h>

Inheritance diagram for H3D::H3DFrictionalSurfaceNode:
Inheritance graph

Classes

class  UpdateDynamicFriction
 Specialized field which sets the dynamic_friction variable in H3DFrictionalSurfaceNode when the dynamicFriction field of H3DFrictonalSurface is changed. More...
 
class  UpdateStaticFriction
 Specialized field which sets the static_friction variable in H3DFrictionalSurfaceNode when the staticFriction field of H3DFrictionalSurfaceNode is changed. More...
 

Public Member Functions

 H3DFrictionalSurfaceNode (Inst< UpdateStiffness > _stiffness=0, Inst< UpdateDamping > _damping=0, Inst< UpdateStaticFriction > _staticFriction=0, Inst< UpdateDynamicFriction > _dynamicFriction=0, Inst< SFBool > _useRelativeValues=0)
 Constructor.
 
- Public Member Functions inherited from H3D::H3DStiffnessSurfaceNode
 H3DStiffnessSurfaceNode (Inst< UpdateStiffness > _stiffness=0, Inst< UpdateDamping > _damping=0, Inst< SFBool > _useRelativeValues=0)
 Constructor.
 
- Public Member Functions inherited from H3D::H3DSurfaceNode
 H3DSurfaceNode ()
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
virtual HAPI::HAPISurfaceObject * getSurface (unsigned int=0)
 Get the surface to use for the haptics device with the specified index.
 
- 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 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 Attributes

H3DUniquePtr< UpdateStaticFrictionstaticFriction
 The friction that is experienced upon initial movement when resting on the surface. More...
 
H3DUniquePtr< UpdateDynamicFrictiondynamicFriction
 The friction that is experienced when moving along the surface the surface. More...
 
- Public Attributes inherited from H3D::H3DStiffnessSurfaceNode
H3DUniquePtr< UpdateStiffnessstiffness
 The stiffness of the surface. More...
 
H3DUniquePtr< UpdateDampingdamping
 The velocity based damping of the surface. More...
 
H3DUniquePtr< SFBooluseRelativeValues
 If false then values (such as stiffness) is in absolute values with SI units or equivalent. More...
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 
- Static Public Attributes inherited from H3D::H3DStiffnessSurfaceNode
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...
 

Detailed Description

Base class for surfaces with friction.

Member Data Documentation

◆ dynamicFriction

H3DUniquePtr< UpdateDynamicFriction > H3D::H3DFrictionalSurfaceNode::dynamicFriction

The friction that is experienced when moving along the surface the surface.

Access type: inputOutput
Default value: 0.4
Value range: [0-1]

Referenced by H3DFrictionalSurfaceNode(), H3D::DepthMapSurface::initialize(), and H3D::HapticTexturesSurface::initialize().

◆ staticFriction

H3DUniquePtr< UpdateStaticFriction > H3D::H3DFrictionalSurfaceNode::staticFriction

The friction that is experienced upon initial movement when resting on the surface.

Access type: inputOutput
Default value: 0.1
Value range: [0-1]

Referenced by H3DFrictionalSurfaceNode(), H3D::DepthMapSurface::initialize(), and H3D::HapticTexturesSurface::initialize().


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