MagneticGeometryEffect is a localized haptic effect that tries to constrain the haptic device to the surface of the given geometry. More...
#include <H3D/MagneticGeometryEffect.h>
Public Member Functions | |
| MagneticGeometryEffect (Inst< SFBool > _enabled=0, Inst< SFNode > _metadata=0, Inst< SFFloat > _startDistance=0, Inst< SFFloat > _escapeDistance=0, Inst< SFBool > _active=0, Inst< SFFloat > _springConstant=0, Inst< SFGeometry > _geometry=0, Inst< MFInt32 > _deviceIndex=0) | |
| Constructor. | |
| virtual void | traverseSG (TraverseInfo &ti) |
| Adds a forceeffect. More... | |
 Public Member Functions inherited from H3D::H3DForceEffect | |
| H3DForceEffect (Inst< SFNode > _metadata=0, Inst< MFInt32 > _deviceIndex=0) | |
| Constructor. | |
| 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. | |
| X3DMetadataObject * | getMetadataByName (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 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 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 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< SFBool > | enabled |
| Enables or disables the force calculations. More... | |
| H3DUniquePtr< SFFloat > | startDistance |
| When the haptics device comes within this distance of the geometry the constraint is activated. More... | |
| H3DUniquePtr< SFFloat > | escapeDistance |
| If the effect is active, the effect will be deactivated if the haptics device moves outside this distance from the surface. More... | |
| H3DUniquePtr< SFBool > | active |
| Tells whether the effect is active or not. More... | |
| H3DUniquePtr< SFFloat > | springConstant |
| The spring constant of the spring. More... | |
| H3DUniquePtr< SFGeometry > | geometry |
| The geometry whose surface to follow. More... | |
| Public Attributes inherited from H3D::H3DForceEffect | |
| H3DUniquePtr< MFInt32 > | deviceIndex |
| A list of indices that tells which haptics devices to render the force on. More... | |
| Public Attributes inherited from H3D::X3DNode | |
| H3DUniquePtr< SFNode > | metadata |
| Meta data about the node. More... | |
Static Public Attributes | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| Static Public Attributes inherited from H3D::H3DForceEffect | |
| static H3DNodeDatabase | database |
| The H3DNodeDatabase for this node. | |
| 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 Node * | getClonedInstance (Node *original, bool deepCopy, DeepCopyMap &deepCopyMap) |
| A helper function for nodes that implement clone() More... | |
Detailed Description
MagneticGeometryEffect is a localized haptic effect that tries to constrain the haptic device to the surface of the given geometry.
The effect is comparable to MagneticSurface. The given geometry is not rendered visually in the scene. The force is calculated as follows: force = (closest_point_to_surface - device_position) * springConstant
Examples:
Member Function Documentation
◆ traverseSG()
|
virtual |
Adds a forceeffect.
The HapticPrimitiveSet hold a reference to all primitives.
Reimplemented from H3D::Node.
References active, H3D::TraverseInfo::addForceEffect(), H3D::X3DGeometryNode::boundTree, H3D::X3DGeometryNode::closestPoint(), H3D::H3DForceEffect::deviceIndex, enabled, escapeDistance, geometry, H3D::TraverseInfo::getAccForwardMatrix(), H3D::TraverseInfo::getAccInverseMatrix(), H3D::TraverseInfo::getHapticsDevices(), H3D::X3DGeometryNode::getOptionNode(), H3D::H3DHapticsDevice::getPreviousProxyPosition(), H3D::X3D::Convert::getValue(), H3DMax(), H3D::TraverseInfo::hapticsEnabled(), H3D::HapticsOptions::lookAheadFactor, H3D::H3DHapticsDevice::proxyPosition, H3D::Node::NodeIntersectResult::result, springConstant, H3D::H3DHapticsDevice::trackerPosition, and H3D::Node::NodeIntersectResult::transformResult().
Member Data Documentation
◆ active
| H3DUniquePtr< SFBool > H3D::MagneticGeometryEffect::active |
Tells whether the effect is active or not.
Access type: outputOnly
Default value: FALSE
Referenced by MagneticGeometryEffect(), and traverseSG().
◆ enabled
| H3DUniquePtr< SFBool > H3D::MagneticGeometryEffect::enabled |
Enables or disables the force calculations.
Access type: inputOutput
Default value: TRUE
Referenced by MagneticGeometryEffect(), and traverseSG().
◆ escapeDistance
| H3DUniquePtr< SFFloat > H3D::MagneticGeometryEffect::escapeDistance |
If the effect is active, the effect will be deactivated if the haptics device moves outside this distance from the surface.
Access type: inputOutput
Default value: 0.01
Referenced by MagneticGeometryEffect(), and traverseSG().
◆ geometry
| H3DUniquePtr< SFGeometry > H3D::MagneticGeometryEffect::geometry |
The geometry whose surface to follow.
Access type: inputOutput
Default value: NULL
Referenced by MagneticGeometryEffect(), and traverseSG().
◆ springConstant
| H3DUniquePtr< SFFloat > H3D::MagneticGeometryEffect::springConstant |
The spring constant of the spring.
Access type: inputOutput
Default value: 300
Referenced by MagneticGeometryEffect(), and traverseSG().
◆ startDistance
| H3DUniquePtr< SFFloat > H3D::MagneticGeometryEffect::startDistance |
When the haptics device comes within this distance of the geometry the constraint is activated.
Access type: inputOutput
Default value: 0.01
Referenced by MagneticGeometryEffect().
The documentation for this class was generated from the following files:
