SoVRMLSound.h Source File

| http://www.sim.no/ http://www.coin3d.org/

- Main Page
- Related Pages
- Modules
- Classes
- Files

- File List
- File Members

SoVRMLSound.h
1 /**************************************************************************\
2 *
3 * This file is part of the Coin 3D visualization library.
4 * Copyright (C) by Kongsberg Oil & Gas Technologies.
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * ("GPL") version 2 as published by the Free Software Foundation.
9 * See the file LICENSE.GPL at the root directory of this source
10 * distribution for additional information about the GNU GPL.
11 *
12 * For using Coin with software that can not be combined with the GNU
13 * GPL, and for taking advantage of the additional benefits of our
14 * support services, please contact Kongsberg Oil & Gas Technologies
15 * about acquiring a Coin Professional Edition License.
16 *
17 * See http://www.coin3d.org/ for more information.
18 *
19 * Kongsberg Oil & Gas Technologies, Bygdoy Alle 5, 0257 Oslo, NORWAY.
20 * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
21 *
22 \**************************************************************************/
23
24 #ifndef COIN_SOVRMLSOUND_H
25 #define COIN_SOVRMLSOUND_H
26
27 #include <Inventor/nodes/SoSubNode.h>
28 #include <Inventor/fields/SoSFNode.h>
29 #include <Inventor/fields/SoSFBool.h>
30 #include <Inventor/fields/SoSFFloat.h>
31 #include <Inventor/fields/SoSFVec3f.h>
32 #include <Inventor/SbTime.h>
33
34 class SoVRMLSoundP;
35 class SoPath;
36
37 class COIN_DLL_API SoVRMLSound : public SoNode
38 {
39 typedef SoNode inherited;
40 SO_NODE_HEADER(SoVRMLSound);
41
42 public:
43 static void initClass(void);
44 SoVRMLSound(void);
45
46 SoSFNode source;
47 SoSFFloat intensity;
48 SoSFFloat priority;
49 SoSFVec3f location;
50 SoSFVec3f direction;
51 SoSFFloat minFront;
52 SoSFFloat maxFront;
53 SoSFFloat minBack;
54 SoSFFloat maxBack;
55 SoSFBool spatialize;
56 SoSFFloat dopplerFactor;
57 SoSFFloat dopplerVelocity;
58
59 void setDopplerVelocity(float velocity);
60 float getDopplerVelocity(void) const;
61 void setDopplerFactor(float factor);
62 float getDopplerFactor(void) const;
63
64 void startPlaying(SoPath *path, void *userdataptr);
65 void stopPlaying(SoPath *path, void *userdataptr);
66
67 static void setDefaultBufferingProperties(int bufferLength, int numBuffers,
68 SbTime sleepTime);
69 void setBufferingProperties(int bufferLength, int numBuffers,
70 SbTime sleepTime);
71 void getBufferingProperties(int &bufferLength, int &numBuffers,
72 SbTime &sleepTime);
73
74 virtual void audioRender(SoAudioRenderAction *action);
75
76 protected:
77 virtual ~SoVRMLSound(void);
78
79 private:
80 SoVRMLSoundP *pimpl;
81 friend class SoVRMLSoundP;
82 };
83
84 #endif // ! COIN_SOVRMLSOUND_H
SoVRMLSound::maxFront
SoSFFloat maxFront
Definition: SoVRMLSound.h:52
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
SoVRMLSound::direction
SoSFVec3f direction
Definition: SoVRMLSound.h:50
SoVRMLSound::location
SoSFVec3f location
Definition: SoVRMLSound.h:49
SoVRMLSound::minFront
SoSFFloat minFront
Definition: SoVRMLSound.h:51
SoNode
The SoNode class is the base class for nodes used in scene graphs.Coin is a retained mode 3D visualiz...
Definition: SoNode.h:47
SoVRMLSound::maxBack
SoSFFloat maxBack
Definition: SoVRMLSound.h:54
SoVRMLSound::spatialize
SoSFBool spatialize
Definition: SoVRMLSound.h:55
SoSFBool
The SoSFBool class is a container for an SbBool value.This field is used where nodes, engines or other field containers needs to store a boolean on/off or TRUE/FALSE value, like for instance as the "on" field of the SoPointLight, SoSpotLight and SoDirectionalLight node classes.
Definition: SoSFBool.h:30
SoNode::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition: SoNode.cpp:1283
SoPath
The SoPath class is a container class for traversal path descriptions.SoPath objects contain a list o...
Definition: SoPath.h:43
SoSFNode
The SoSFNode class is a container for a single node.This field container stores a pointer to a Coin n...
Definition: SoSFNode.h:38
SoVRMLSound::source
SoSFNode source
Definition: SoVRMLSound.h:46
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.Applying this method at a ro...
Definition: SoAudioRenderAction.h:33
SoVRMLSound::priority
SoSFFloat priority
Definition: SoVRMLSound.h:48
SbTime
The SbTime class instances represents time values.SbTime is a convenient way of doing system independ...
Definition: SbTime.h:41
SoSFFloat
The SoSFFloat class is a container for a floating point value.This field is used where nodes...
Definition: SoSFFloat.h:30
SoSFVec3f
The SoSFVec3f class is a container for an SbVec3f vector.This field is used where nodes...
Definition: SoSFVec3f.h:31
SoVRMLSound::minBack
SoSFFloat minBack
Definition: SoVRMLSound.h:53
SoVRMLSound::intensity
SoSFFloat intensity
Definition: SoVRMLSound.h:47
SoVRMLSound
The SoVRMLSound class is used to represent a sound source.The detailed class documentation is taken v...
Definition: SoVRMLSound.h:37

Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.