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

The MultiDeviceSurface allows you to specify different surface for different haptics devices in a multi device setup. More...

#include <H3D/MultiDeviceSurface.h>

Inheritance diagram for H3D::MultiDeviceSurface:
Inheritance graph

Public Member Functions

 MultiDeviceSurface (Inst< MFSurfaceNode > _surface=0)
 Constructor.
 
virtual HAPI::HAPISurfaceObject * getSurface (unsigned int device_index=0)
 Get the surface to use for the haptics device with the specified index. More...
 
- Public Member Functions inherited from H3D::H3DSurfaceNode
 H3DSurfaceNode ()
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default xml containerField attribute value. More...
 
- 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< MFSurfaceNodesurface
 The surface field contains H3DSurfaceNode instances to use by different devices. 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

The MultiDeviceSurface allows you to specify different surface for different haptics devices in a multi device setup.

The surface field contains H3DSurfaceNode instances to use by different devices. The surfaces are mapped onto different devices in the same order as the devices are specified in DeviceInfo, i.e. the first surface will be mapped to the first device, the second surface to the second device and so on. If there are more devices than surfaces the last surface is used for these. An empty set of surfaces means no surface for any device. If a value is NULL it means no surface for that device.

Examples:

Member Function Documentation

◆ getSurface()

HAPI::HAPISurfaceObject * MultiDeviceSurface::getSurface ( unsigned int  device_index = 0)
virtual

Get the surface to use for the haptics device with the specified index.

Specialization to get different surfaces depending on the surface field.

Reimplemented from H3D::H3DSurfaceNode.

References H3D::H3DSurfaceNode::getSurface(), and surface.

Member Data Documentation

◆ surface

H3DUniquePtr< MFSurfaceNode > H3D::MultiDeviceSurface::surface

The surface field contains H3DSurfaceNode instances to use by different devices.

The surfaces are mapped onto different devices in the same order as the devices are specified in DeviceInfo, i.e. the first surface will be mapped to the first device, the second surface to the second device and so on. If there are more devices than surfaces the last surface is used for these. An empty set of surfaces means no surface for any device. If a value is NULL it means no surface for that device.

Access type: inputOutput

Referenced by getSurface().


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