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

Haptics renderer which may contain other haptics renderer nodes. More...

#include <H3D/HapticsRenderers.h>

Inheritance diagram for H3D::LayeredRenderer:
Inheritance graph

Classes

class  MFHapticsRendererNode
 MFHapticsRendererNode extends TypedMFNode< H3DHapticsRendererNode > in order to change the haptics renderer for the used HAPIHapticsDevice when changing H3DHapticsRendererNode. More...
 

Public Member Functions

 LayeredRenderer (Inst< MFHapticsRendererNode > _hapticsRenderer=0)
 Constructor.
 
virtual HAPI::HAPIHapticsRenderer * getHapticsRenderer (unsigned int layer)
 Get the haptics renderer to use for a certain layer.
 
virtual void hapticsRendererRemoved (unsigned int layer)
 This function should only be called if the HAPI::HAPIHapticsRenderer obtained for the given layer is removed from the HAPIDevice ( and therefore destroyed ). More...
 
- Public Member Functions inherited from H3D::H3DHapticsRendererNode
 H3DHapticsRendererNode ()
 Constructor.
 
virtual string defaultXMLContainerField ()
 Returns the default containerField value for this node. 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< MFHapticsRendererNodehapticsRenderer
 The hapticsRenderer field contains a HapticsRendererNode for each layer. More...
 

Static Public Attributes

static H3DNodeDatabase database
 The H3DNodeDatabase for this node.
 

Protected Member Functions

virtual HAPI::HAPIHapticsRenderer * getNewHapticsRenderer ()
 Returns a new instance of HAPI::RuspiniRenderer.
 
- 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...
 

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.
 
- 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

Haptics renderer which may contain other haptics renderer nodes.

One for each haptics layer in the scene should be specified.

The hapticsRenderer field contains a HapticsRendererNode for each layer. it is possible to mix and match renderers of different types. If no renderer is given for a specific layer then a GodObjectRenderer is used.

To add a shape for a specific layer see HapticLayeredGroup.

Member Function Documentation

◆ hapticsRendererRemoved()

virtual void H3D::LayeredRenderer::hapticsRendererRemoved ( unsigned int  layer)
inlinevirtual

This function should only be called if the HAPI::HAPIHapticsRenderer obtained for the given layer is removed from the HAPIDevice ( and therefore destroyed ).

The reason for having this function is to not accidently leave a pointer to the destroyed instance in this node in case the node will be used again or elsewhere.

Reimplemented from H3D::H3DHapticsRendererNode.

Referenced by H3D::LayeredRenderer::MFHapticsRendererNode::onRemove().

Member Data Documentation

◆ hapticsRenderer

H3DUniquePtr< MFHapticsRendererNode > H3D::LayeredRenderer::hapticsRenderer

The hapticsRenderer field contains a HapticsRendererNode for each layer.

it is possible to mix and match renderers of different types. If no renderer is given for a specific layer then a GodObjectRenderer is used.

Access type: inputOutput

Referenced by getHapticsRenderer().


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