H3D API  2.4.1
H3DHapticsRendererNode.h
Go to the documentation of this file.
1 // Copyright 2004-2019, SenseGraphics AB
3 //
4 // This file is part of H3D API.
5 //
6 // H3D API is free software; you can redistribute it and/or modify
7 // it under the terms of the GNU General Public License as published by
8 // the Free Software Foundation; either version 2 of the License, or
9 // (at your option) any later version.
10 //
11 // H3D API is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
15 //
16 // You should have received a copy of the GNU General Public License
17 // along with H3D API; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // A commercial license is also available. Please contact us at
21 // www.sensegraphics.com for more information.
22 //
23 //
27 //
29 #ifndef __H3DHAPTICSRENDERERNODE_H__
30 #define __H3DHAPTICSRENDERERNODE_H__
31 
32 // H3DApi includes
33 #include <H3D/H3DApi.h>
34 #include <H3D/Node.h>
35 
36 // HAPI includes
37 #include <HAPI/HAPIHapticsRenderer.h>
38 
39 namespace H3D {
40 
44  class H3DAPI_API H3DHapticsRendererNode: public Node {
45  public:
46 
49  }
50 
52  virtual HAPI::HAPIHapticsRenderer *
53  getHapticsRenderer( unsigned int layer ) {
54  if( renderers.size() < layer + 1 ) {
55  renderers.resize( layer + 1, NULL );
56  }
57  if( !renderers[layer] )
58  renderers[layer] = getNewHapticsRenderer();
59 
60  return renderers[layer];
61  }
62 
69  virtual void hapticsRendererRemoved( unsigned int layer ) {
70  if( layer < renderers.size() ) {
71  renderers[layer] = NULL;
72  }
73  }
74 
75 
78  virtual string defaultXMLContainerField() {
79  return "hapticsRenderer";
80  }
81 
82  protected:
84  virtual HAPI::HAPIHapticsRenderer *getNewHapticsRenderer() = 0;
85  vector< HAPI::HAPIHapticsRenderer * > renderers;
86  };
87 }
88 
89 #endif
Base header file that handles all configuration related settings.
Node base class.
Base class for all haptic renderers, i.e.
Definition: H3DHapticsRendererNode.h:44
virtual HAPI::HAPIHapticsRenderer * getNewHapticsRenderer()=0
Create a new HAPIHapticsRenderer to use.
virtual string defaultXMLContainerField()
Returns the default containerField value for this node.
Definition: H3DHapticsRendererNode.h:78
H3DHapticsRendererNode()
Constructor.
Definition: H3DHapticsRendererNode.h:48
virtual HAPI::HAPIHapticsRenderer * getHapticsRenderer(unsigned int layer)
Get the haptics renderer to use for a certain layer.
Definition: H3DHapticsRendererNode.h:53
virtual void hapticsRendererRemoved(unsigned int layer)
This function should only be called if the HAPI::HAPIHapticsRenderer obtained for the given layer is ...
Definition: H3DHapticsRendererNode.h:69
Node is the base class for all classes that can be part of the H3D scene-graph.
Definition: Node.h:46
H3D API namespace.
Definition: Anchor.h:38