Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoVRMLSound.h
1 /**************************************************************************\
2  * Copyright (c) Kongsberg Oil & Gas Technologies AS
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  * Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 \**************************************************************************/
32 
33 #ifndef COIN_SOVRMLSOUND_H
34 #define COIN_SOVRMLSOUND_H
35 
36 #include <Inventor/nodes/SoSubNode.h>
37 #include <Inventor/fields/SoSFNode.h>
38 #include <Inventor/fields/SoSFBool.h>
39 #include <Inventor/fields/SoSFFloat.h>
40 #include <Inventor/fields/SoSFVec3f.h>
41 #include <Inventor/SbTime.h>
42 
43 class SoVRMLSoundP;
44 class SoPath;
45 
46 class COIN_DLL_API SoVRMLSound : public SoNode
47 {
48  typedef SoNode inherited;
50 
51 public:
52  static void initClass(void);
53  SoVRMLSound(void);
54 
65  SoSFFloat dopplerFactor;
66  SoSFFloat dopplerVelocity;
67 
68  void setDopplerVelocity(float velocity);
69  float getDopplerVelocity(void) const;
70  void setDopplerFactor(float factor);
71  float getDopplerFactor(void) const;
72 
73  void startPlaying(SoPath *path, void *userdataptr);
74  void stopPlaying(SoPath *path, void *userdataptr);
75 
76  static void setDefaultBufferingProperties(int bufferLength, int numBuffers,
77  SbTime sleepTime);
78  void setBufferingProperties(int bufferLength, int numBuffers,
79  SbTime sleepTime);
80  void getBufferingProperties(int &bufferLength, int &numBuffers,
81  SbTime &sleepTime);
82 
83  virtual void audioRender(SoAudioRenderAction *action);
84 
85 protected:
86  virtual ~SoVRMLSound(void);
87 
88 private:
89  SoVRMLSoundP *pimpl;
90  friend class SoVRMLSoundP;
91 };
92 
93 #endif // ! COIN_SOVRMLSOUND_H
SoSFFloat maxFront
Definition: SoVRMLSound.h:61
#define SO_NODE_HEADER(classname)
SoSFVec3f direction
Definition: SoVRMLSound.h:59
SoSFVec3f location
Definition: SoVRMLSound.h:58
SoSFFloat minFront
Definition: SoVRMLSound.h:60
The SoNode class is the base class for nodes used in scene graphs.
Definition: SoNode.h:56
SoSFFloat maxBack
Definition: SoVRMLSound.h:63
SoSFBool spatialize
Definition: SoVRMLSound.h:64
The SoSFBool class is a container for an SbBool value.
Definition: SoSFBool.h:39
virtual void audioRender(SoAudioRenderAction *action)
Definition: SoNode.cpp:1307
The SoPath class is a container class for traversal path descriptions.
Definition: SoPath.h:52
The SoSFNode class is a container for a single node.
Definition: SoSFNode.h:47
SoSFNode source
Definition: SoVRMLSound.h:55
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition: SoAudioRenderAction.h:42
SoSFFloat priority
Definition: SoVRMLSound.h:57
The SbTime class instances represents time values.
Definition: SbTime.h:50
The SoSFFloat class is a container for a floating point value.
Definition: SoSFFloat.h:39
The SoSFVec3f class is a container for an SbVec3f vector.
Definition: SoSFVec3f.h:40
SoSFFloat minBack
Definition: SoVRMLSound.h:62
SoSFFloat intensity
Definition: SoVRMLSound.h:56
The SoVRMLSound class is used to represent a sound source.
Definition: SoVRMLSound.h:46