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

Surface type for setting OpenHaptics surface parameters directly. More...

#include <H3D/OpenHapticsSurface.h>

Inheritance diagram for H3D::OpenHapticsSurface:
Inheritance graph

Classes

class  UpdateMagnetic
 Specialized field which sets the magnetic variable in HAPI::OpenHapticsRenderer::OpenHapticsSurface when the magnetic field of OpenHapticsSurface is changed. More...
 

Public Member Functions

 OpenHapticsSurface (Inst< UpdateStiffness > _stiffness=0, Inst< UpdateDamping > _damping=0, Inst< UpdateStaticFriction > _staticFriction=0, Inst< UpdateDynamicFriction > _dynamicFriction=0, Inst< UpdateMagnetic > _magnetic=0, Inst< UpdateSnapDistance > _snapDistance=0)
 Constructor.
 
- Public Member Functions inherited from H3D::MagneticSurface
 MagneticSurface (Inst< UpdateStiffness > _stiffness=0, Inst< UpdateDamping > _damping=0, Inst< UpdateStaticFriction > _staticFriction=0, Inst< UpdateDynamicFriction > _dynamicFriction=0, Inst< UpdateSnapDistance > _snapDistance=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< UpdateMagneticmagnetic
 Specifies if the surface should be magnetic or not. More...
 
- Public Attributes inherited from H3D::MagneticSurface
H3DUniquePtr< UpdateStiffnessstiffness
 The stiffness of the surface. More...
 
H3DUniquePtr< UpdateDampingdamping
 The velocity based damping of the surface. More...
 
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...
 
H3DUniquePtr< UpdateSnapDistancesnapDistance
 The distance from the surface within which forces are generated to pull the proxy towards the surface. More...
 

Static Public Attributes

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

Surface type for setting OpenHaptics surface parameters directly.

Only works when using the OpenHapticsRenderer.

Member Data Documentation

◆ magnetic

H3DUniquePtr< UpdateMagnetic > H3D::OpenHapticsSurface::magnetic

Specifies if the surface should be magnetic or not.

Access type: inputOutput
Default value: false

Referenced by OpenHapticsSurface().


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