PositionFunctionEffect takes as input three functions that controls the force in x, y and z direction. More...
#include <H3D/PositionFunctionEffect.h>
Public Member Functions | |
| PositionFunctionEffect (Inst< SFFunctionNode > _xFunction=0, Inst< SFFunctionNode > _yFunction=0, Inst< SFFunctionNode > _zFunction=0, Inst< MFInt32 > _deviceIndex=0, Inst< SFNode > _metadata=0) | |
| Constructor. | |
| virtual void | traverseSG (TraverseInfo &ti) |
| Adds the force effect. | |
 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< SFFunctionNode > | xFunction |
| This function controls the force in the x-direction. More... | |
| H3DUniquePtr< SFFunctionNode > | yFunction |
| This function controls the force in the y-direction. More... | |
| H3DUniquePtr< SFFunctionNode > | zFunction |
| This function controls the force in the z-direction. 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
PositionFunctionEffect takes as input three functions that controls the force in x, y and z direction.
The functions must depend on three variables, but of course not all of them have to be used in the function expression. That is, a function can be "0" and depend on the variables "r,s,t". The input to the functions will be the position of the haptics device (x, y, z).
A simple example. xFunction, yFunction and zFunction all depends on the variables "x,y,z". xFunction evaluates according to the expression "y". yFunction and zFunction always evaluates to 0. This will give the effect that when the haptics device position is (x1, y1, z1) there will be a force (y1, 0, 0) rendered on the haptics device provided that the haptics device is only affected by the PositionFunctionEffect.
Examples:
Member Data Documentation
◆ xFunction
| H3DUniquePtr< SFFunctionNode > H3D::PositionFunctionEffect::xFunction |
This function controls the force in the x-direction.
Input to the function will be the position of the haptics device (x, y, z).
Access type: inputOutput
Referenced by traverseSG().
◆ yFunction
| H3DUniquePtr< SFFunctionNode > H3D::PositionFunctionEffect::yFunction |
This function controls the force in the y-direction.
Input to the function will be the position of the haptics device (x, y, z).
Access type: inputOutput
Referenced by traverseSG().
◆ zFunction
| H3DUniquePtr< SFFunctionNode > H3D::PositionFunctionEffect::zFunction |
This function controls the force in the z-direction.
Input to the function will be the position of the haptics device (x, y, z).
Access type: inputOutput
Referenced by traverseSG().
The documentation for this class was generated from the following files:
