Surface in which textures can be used to control the values of the parameters stiffness, damping, staticFriction and dynamicFriction. More...
#include <H3D/HapticTexturesSurface.h>
Classes | |
| class | SetImagePtr |
| Field class used to transfer the routed image to the HAPISurfaceObject. More... | |
| class | SFImageObjectNode |
| An SFNode where we make sure the type of the nodes contained is a subclass of H3DImageObject. More... | |
| class | UpdateMinMaxParamValue |
| Field class used to set the min and max values of the different parameters in the HAPISurfaceObject. More... | |
Public Member Functions | |
| HapticTexturesSurface (Inst< UpdateStiffness > _stiffness=0, Inst< UpdateDamping > _damping=0, Inst< UpdateStaticFriction > _staticFriction=0, Inst< UpdateDynamicFriction > _dynamicFriction=0, Inst< SFBool > _useRelativeValues=0, Inst< SFImageObjectNode > _stiffnessMap=0, Inst< UpdateMinMaxParamValue > _maxStiffness=0, Inst< UpdateMinMaxParamValue > _minStiffness=0, Inst< SFImageObjectNode > _dampingMap=0, Inst< UpdateMinMaxParamValue > _maxDamping=0, Inst< UpdateMinMaxParamValue > _minDamping=0, Inst< SFImageObjectNode > _staticFrictionMap=0, Inst< UpdateMinMaxParamValue > _maxStaticFriction=0, Inst< UpdateMinMaxParamValue > _minStaticFriction=0, Inst< SFImageObjectNode > _dynamicFrictionMap=0, Inst< UpdateMinMaxParamValue > _maxDynamicFriction=0, Inst< UpdateMinMaxParamValue > _minDynamicFriction=0) | |
| Constructor. | |
| void | initialize () |
| Initialize the variables. More... | |
 Public Member Functions inherited from H3D::H3DFrictionalSurfaceNode | |
| 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 Node * | clone (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. | |
| X3DPrototypeInstance * | getProtoInstanceParent () |
| 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 Field * | getField (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< SFImageObjectNode > | stiffnessMap |
| The texture used to map stiffness values. More... | |
| H3DUniquePtr< SFImageObjectNode > | dampingMap |
| The texture used to map damping values. More... | |
| H3DUniquePtr< SFImageObjectNode > | staticFrictionMap |
| The texture used to map static friction values. More... | |
| H3DUniquePtr< SFImageObjectNode > | dynamicFrictionMap |
| The texture used to map dynamic friction values. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | maxStiffness |
| The maximum allowed value of the stiffness. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | maxDamping |
| The maximum allowed value of the damping. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | maxStaticFriction |
| The maximum allowed value of the static friction. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | maxDynamicFriction |
| The maximum allowed value of the dynamic friction. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | minStiffness |
| The minimum allowed value of the stiffness. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | minDamping |
| The minimum allowed value of the damping. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | minStaticFriction |
| The minimum allowed value of the static friction. More... | |
| H3DUniquePtr< UpdateMinMaxParamValue > | minDynamicFriction |
| The minimum allowed value of the dynamic friction. More... | |
| Public Attributes inherited from H3D::H3DFrictionalSurfaceNode | |
| H3DUniquePtr< UpdateStaticFriction > | staticFriction |
| The friction that is experienced upon initial movement when resting on the surface. More... | |
| H3DUniquePtr< UpdateDynamicFriction > | dynamicFriction |
| The friction that is experienced when moving along the surface the surface. More... | |
| Public Attributes inherited from H3D::H3DStiffnessSurfaceNode | |
| H3DUniquePtr< UpdateStiffness > | stiffness |
| The stiffness of the surface. More... | |
| H3DUniquePtr< UpdateDamping > | damping |
| The velocity based damping of the surface. More... | |
| H3DUniquePtr< SFBool > | useRelativeValues |
| 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::H3DFrictionalSurfaceNode | |
| 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 Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
Surface in which textures can be used to control the values of the parameters stiffness, damping, staticFriction and dynamicFriction.
It is optimized for one channel gray scale images using unsigned integers from 0 to 255. Black (0) corresponds to the lowest allowed value and White(255) corresponds to the highest allowed value.
Examples:
- Surfaces.x3d ( Source )
- Internal routes:
Member Function Documentation
◆ initialize()
|
virtual |
Initialize the variables.
Creates the HAPISurfaceObject used for this this node.
Reimplemented from H3DUtil::RefCountedClass.
References H3D::H3DStiffnessSurfaceNode::damping, dampingMap, H3D::H3DFrictionalSurfaceNode::dynamicFriction, dynamicFrictionMap, H3D::H3DImageObject::image, H3DUtil::RefCountedClass::initialize(), maxDamping, maxDynamicFriction, maxStaticFriction, maxStiffness, minDamping, minDynamicFriction, minStaticFriction, minStiffness, H3DUtil::AutoRef< class >::reset(), H3D::H3DFrictionalSurfaceNode::staticFriction, staticFrictionMap, H3D::H3DStiffnessSurfaceNode::stiffness, stiffnessMap, and H3D::H3DStiffnessSurfaceNode::useRelativeValues.
Member Data Documentation
◆ dampingMap
| H3DUniquePtr< SFImageObjectNode > H3D::HapticTexturesSurface::dampingMap |
The texture used to map damping values.
Access type: inputOutput
Referenced by HapticTexturesSurface(), and initialize().
◆ dynamicFrictionMap
| H3DUniquePtr< SFImageObjectNode > H3D::HapticTexturesSurface::dynamicFrictionMap |
The texture used to map dynamic friction values.
Access type: inputOutput
Referenced by HapticTexturesSurface(), and initialize().
◆ maxDamping
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::maxDamping |
The maximum allowed value of the damping.
Only used to calculate the damping if dampingMap is not null. The white in the texture will correspond to this value.
Access type: inputOutput Default value: 1
Referenced by HapticTexturesSurface(), and initialize().
◆ maxDynamicFriction
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::maxDynamicFriction |
The maximum allowed value of the dynamic friction.
Only used to calculate the dynamic friction if dynamicFrictionMap is not null. The white in the texture will correspond to this value.
Access type: inputOutput Default value: 1
Referenced by HapticTexturesSurface(), and initialize().
◆ maxStaticFriction
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::maxStaticFriction |
The maximum allowed value of the static friction.
Only used to calculate the static friction if staticFrictionMap is not null. The white in the texture will correspond to this value.
Access type: inputOutput Default value: 1
Referenced by HapticTexturesSurface(), and initialize().
◆ maxStiffness
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::maxStiffness |
The maximum allowed value of the stiffness.
Only used to calculate the stiffness if stiffnessMap is not null. The white in the texture will correspond to this value.
Access type: inputOutput Default value: 1
Referenced by HapticTexturesSurface(), and initialize().
◆ minDamping
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::minDamping |
The minimum allowed value of the damping.
Only used to calculate the damping if dampingMap is not null. The black in the texture will correspond to this value.
Access type: inputOutput Default value: 0
Referenced by HapticTexturesSurface(), and initialize().
◆ minDynamicFriction
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::minDynamicFriction |
The minimum allowed value of the dynamic friction.
Only used to calculate the dynamic friction if dynamicFrictionMap is not null. The black in the texture will correspond to this value.
Access type: inputOutput Default value: 0
Referenced by HapticTexturesSurface(), and initialize().
◆ minStaticFriction
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::minStaticFriction |
The minimum allowed value of the static friction.
Only used to calculate the static friction if staticFrictionMap is not null. The black in the texture will correspond to this value.
Access type: inputOutput Default value: 0
Referenced by HapticTexturesSurface(), and initialize().
◆ minStiffness
| H3DUniquePtr< UpdateMinMaxParamValue > H3D::HapticTexturesSurface::minStiffness |
The minimum allowed value of the stiffness.
Only used to calculate the stiffness if stiffnessMap is not null. The black in the texture will correspond to this value.
Access type: inputOutput Default value: 0
Referenced by HapticTexturesSurface(), and initialize().
◆ staticFrictionMap
| H3DUniquePtr< SFImageObjectNode > H3D::HapticTexturesSurface::staticFrictionMap |
The texture used to map static friction values.
Access type: inputOutput
Referenced by HapticTexturesSurface(), and initialize().
◆ stiffnessMap
| H3DUniquePtr< SFImageObjectNode > H3D::HapticTexturesSurface::stiffnessMap |
The texture used to map stiffness values.
Access type: inputOutput
Referenced by HapticTexturesSurface(), and initialize().
The documentation for this class was generated from the following files:
