SoListener - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 2.5.0
Note : Coin
NAMESoListener − The SoListener class defines listener attributes used when rendering sound​.
SYNOPSIS
#include <Inventor/nodes/SoListener​.h> Inherits SoNode​.
Public Member Functionsvirtual SoType getTypeId (void) const
SoListener ()
Static Public Member Functionsstatic SoType getClassTypeId (void)
static void initClass ()
Public AttributesSoSFVec3f position
SoSFRotation orientation
SoSFFloat gain
SoSFVec3f dopplerVelocity
SoSFFloat dopplerFactor
Protected Member Functionsvirtual const SoFieldData * getFieldData (void) const
virtual void audioRender (class SoAudioRenderAction *action)
virtual ~SoListener ()
Static Protected Member Functionsstatic const SoFieldData ** getFieldDataPtr (void)
Friendsclass SoAudioRenderAction
class SoListenerP
Additional Inherited Members
Detailed DescriptionThe SoListener class defines listener attributes used when rendering sound​. When rendering geometry, one needs to have a camera defining certain attributes related to vieweing​. The SoListener plays a similar role when it comes to rendering audio​. If no SoListener has been encountered when a SoVRMLSound node renders itself, it will use the position and the orientation of the current camera​. In this case, a gain of 1, a dopplerVelocity of 0 and a dopplerFactor of 0 will be assumed​. Coin does not currently support doppler effects, so the dopplerVelocity and dopplerFactor fields are currently ignored​. FILE FORMAT/DEFAULTS: Listener { position 0 0 0 orientation 0 0 1 0 dopplerVelocity 0 0 0 dopplerFactor 0 gain 1 } See also SoVRMLSound
Constructor & Destructor Documentation
SoListener::SoListener ()Contructor​. References dopplerFactor, dopplerVelocity, gain, orientation, and position​.
SoListener::~SoListener () [protected], [virtual]Destructor​.
Member Function Documentation
SoType SoListener::getTypeId (void) const [virtual]Returns the type identification of an object derived from a class inheriting SoBase​. This is used for run-time type checking and 'downward' casting​. Usage example: void foo(SoNode * node) { if (node->getTypeId() == SoFile::getClassTypeId()) { SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type } else if (node->getTypeId()​.isOfType(SoGroup::getClassTypeId())) { SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type } }For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses​. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode​.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine​.h (for engine classes) and so on​. For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups​. Implements SoBase​.
const SoFieldData * SoListener::getFieldData (void) const [protected], [virtual]Returns a pointer to the class-wide field data storage object for this instance​. If no fields are present, returns NULL​. Reimplemented from SoFieldContainer​.
void SoListener::audioRender (class SoAudioRenderAction * action) [protected], [virtual]Action method for SoAudioRenderAction​. Does common processing for SoAudioRenderAction action instances​. Reimplemented from SoNode​. References dopplerFactor, dopplerVelocity, gain, SoAction::getState(), SbVec3f::getValue(), SoField::isIgnored(), orientation, position, SoDebugError::postInfo(), SoListenerGainElement::set(), SoListenerOrientationElement::set(), SoListenerPositionElement::set(), SoListenerDopplerElement::setDopplerFactor(), and SoListenerDopplerElement::setDopplerVelocity()​.
Member Data Documentation
SoSFVec3f SoListener::positionListener position​. Defaults to (0​.0f, 0​.0f, 0​.0f)​. Referenced by audioRender(), and SoListener()​.
SoSFVec3f SoListener::orientationListener orientation specified as a rotation value from the default orientation where the listener is looking pointing along the negative z-axis, with 'up' along the positive y-axis​. Defaults to SbRotation(SbVec3f(0​.0f, 0​.0f, 1​.0f), 0​.0f)​. Referenced by audioRender(), and SoListener()​.
SoSFVec3f SoListener::gainThe gain is a scalar amplitude multiplier that attenuates all sounds in the scene​. The legal range is [0​.0f, any), however a gain value > 1​.0f might be clamped to 1​.0f by the audio device​. Defaults to 1​.0f, meaning that the sound is un-attenuated​. A gain value of 0​.5f would be equivalent to a 6dB attenuation​. If gain is set to 0​.0f, no sound can be heard​. Referenced by audioRender(), and SoListener()​.
SoSFVec3f SoListener::dopplerVelocityThe doppler velocity of the sound​. It is the application programmer's responsibility to set this value​. Coin does not update this value automatically based on changes in a sound's position​. The default value is (0​.0f, 0​.0f, 0​.0f)​. Coin does not yet support doppler effects​.
Referenced by audioRender(), and SoListener()​.
SoSFFloat SoListener::dopplerFactorThe amount of doppler effect applied to the sound​. The legal range is [0​.0f, any>, where 0​.0f is default and disable all doppler effects, 1​.0f would be a typical value for this field if doppler effects are required​. Coin does not yet support doppler effects​.
Referenced by audioRender(), and SoListener()​.
AuthorGenerated automatically by Doxygen for Coin from the source code​. 0
Johanes Gumabo
Data Size   :   26,889 byte
man-SoListener.3coin2Build   :   2024-12-05, 20:55   :  
Visitor Screen   :   x
Visitor Counter ( page / site )   :   3 / 199,927
Visitor ID   :     :  
Visitor IP   :   18.226.187.60   :  
Visitor Provider   :   AMAZON-02   :  
Provider Position ( lat x lon )   :   39.962500 x -83.006100   :   x
Provider Accuracy Radius ( km )   :   1000   :  
Provider City   :   Columbus   :  
Provider Province   :   Ohio ,   :   ,
Provider Country   :   United States   :  
Provider Continent   :   North America   :  
Visitor Recorder   :   Version   :  
Visitor Recorder   :   Library   :  
Online Linux Manual Page   :   Version   :   Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page   :   Library   :   lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page   :   Library   :   lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base   :   Version   :   Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base   :   Library   :   lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36
Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .
If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.