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

A H3DStiffnessSurfaceNode is the base class for surfaces that have stiffness and damping. More...

#include <H3D/H3DStiffnessSurfaceNode.h>

Inheritance diagram for H3D::H3DStiffnessSurfaceNode:
Inheritance graph

Classes

class  UpdateDamping
 Specialized field which sets the damping variable in H3DStiffnessSurfaceNode when the damping field of H3DStiffnessSurfaceNode is changed. More...
 
class  UpdateStiffness
 Specialized field which sets the stiffness variable in H3DStiffnessSurfaceNode when the stiffness field of H3DStiffnessSurfaceNode is changed. More...
 

Public Member Functions

 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< 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.
 

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

A H3DStiffnessSurfaceNode is the base class for surfaces that have stiffness and damping.

If the field useRelativeValues is true then stiffness is specified as a value between 0 and 1 where 1 is the maximum stiffness the device can handle. Otherwise the stiffness is in N/m.

Member Data Documentation

◆ damping

H3DUniquePtr< UpdateDamping > H3D::H3DStiffnessSurfaceNode::damping

The velocity based damping of the surface.

Access type: inputOutput
Default value: 0

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

◆ stiffness

H3DUniquePtr< UpdateStiffness > H3D::H3DStiffnessSurfaceNode::stiffness

The stiffness of the surface.

Access type: inputOutput
Default value: 0.5

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

◆ useRelativeValues

H3DUniquePtr< SFBool > H3D::H3DStiffnessSurfaceNode::useRelativeValues

If false then values (such as stiffness) is in absolute values with SI units or equivalent.

If true the units are relative to the maximum values that the haptics device, on which the surface is rendered on, can handle.

Access type: initializeOnly
Default value: true

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


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