SoVRMLSound.h
/**************************************************************************\
* Copyright (c) Kongsberg Oil & Gas Technologies AS
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\**************************************************************************/
#ifndef COIN_SOVRMLSOUND_H
#define COIN_SOVRMLSOUND_H
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/SbTime.h>
class SoVRMLSoundP;
class SoPath;
class COIN_DLL_API SoVRMLSound : public SoNode
{
typedef SoNode inherited;
SO_NODE_HEADER(SoVRMLSound);
public:
static void initClass(void);
SoVRMLSound(void);
SoSFNode source;
SoSFFloat intensity;
SoSFFloat priority;
SoSFVec3f location;
SoSFVec3f direction;
SoSFFloat minFront;
SoSFFloat maxFront;
SoSFFloat minBack;
SoSFFloat maxBack;
SoSFBool spatialize;
SoSFFloat dopplerFactor;
SoSFFloat dopplerVelocity;
void setDopplerVelocity(float velocity);
float getDopplerVelocity(void) const;
void setDopplerFactor(float factor);
float getDopplerFactor(void) const;
void startPlaying(SoPath *path, void *userdataptr);
void stopPlaying(SoPath *path, void *userdataptr);
static void setDefaultBufferingProperties(int bufferLength, int numBuffers,
SbTime sleepTime);
void setBufferingProperties(int bufferLength, int numBuffers,
SbTime sleepTime);
void getBufferingProperties(int &bufferLength, int &numBuffers,
SbTime &sleepTime);
virtual void audioRender(SoAudioRenderAction *action);
protected:
virtual ~SoVRMLSound(void);
private:
SoVRMLSoundP *pimpl;
friend class SoVRMLSoundP;
};
#endif // ! COIN_SOVRMLSOUND_H
SbTime
The SbTime class instances represents time values.
Definition SbTime.h:50
SoAudioRenderAction
The SoAudioRenderAction class renders the aural parts of the scene graph.
Definition SoAudioRenderAction.h:42
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::audioRender
virtual void audioRender(SoAudioRenderAction *action)
Definition SoNode.cpp:1356
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoPath
The SoPath class is a container class for traversal path descriptions.
Definition SoPath.h:52
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.h:39
SoSFFloat
The SoSFFloat class is a container for a floating point value.
Definition SoSFFloat.h:39
SoSFNode
The SoSFNode class is a container for a single node.
Definition SoSFNode.h:47
SoSFVec3f
The SoSFVec3f class is a container for an SbVec3f vector.
Definition SoSFVec3f.h:40
SoVRMLSound::priority
SoSFFloat priority
Definition SoVRMLSound.h:57
SoVRMLSound::getDopplerFactor
float getDopplerFactor(void) const
Definition Sound.cpp:592
SoVRMLSound::setDopplerFactor
void setDopplerFactor(float factor)
Definition Sound.cpp:579
SoVRMLSound::maxBack
SoSFFloat maxBack
Definition SoVRMLSound.h:63
SoVRMLSound::SoVRMLSound
SoVRMLSound(void)
Definition Sound.cpp:365
SoVRMLSound::stopPlaying
void stopPlaying(SoPath *path, void *userdataptr)
Definition Sound.cpp:620
SoVRMLSound::direction
SoSFVec3f direction
Definition SoVRMLSound.h:59
SoVRMLSound::intensity
SoSFFloat intensity
Definition SoVRMLSound.h:56
SoVRMLSound::getDopplerVelocity
float getDopplerVelocity(void) const
Definition Sound.cpp:565
SoVRMLSound::minFront
SoSFFloat minFront
Definition SoVRMLSound.h:60
SoVRMLSound::source
SoSFNode source
Definition SoVRMLSound.h:55
SoVRMLSound::maxFront
SoSFFloat maxFront
Definition SoVRMLSound.h:61
SoVRMLSound::minBack
SoSFFloat minBack
Definition SoVRMLSound.h:62
SoVRMLSound::location
SoSFVec3f location
Definition SoVRMLSound.h:58
SoVRMLSound::startPlaying
void startPlaying(SoPath *path, void *userdataptr)
Definition Sound.cpp:607
SoVRMLSound::spatialize
SoSFBool spatialize
Definition SoVRMLSound.h:64
SoVRMLSound::setDopplerVelocity
void setDopplerVelocity(float velocity)
Definition Sound.cpp:551
SO_NODE_HEADER
#define SO_NODE_HEADER(classname)
Definition Coin_macros.dox:50