NAME

       SoListenerPositionElement -

       The SoListenerPositionElement holds the position of the current listener.

       This position is set by SoListener nodes and SoCamera Nodes during audio rendering. When a
       SoListener is visited by the SoAudioRenderAction, it will add a new
       SoListenerPositionElement to the state, holding it's position and with the setbylistener
       flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new
       SoListenerPositionElement only if there are no previous elements with the setbylistener
       flag set.

SYNOPSIS

       #include <Inventor/elements/SoListenerPositionElement.h>

       Inherits SoReplacedElement.

   Public Member Functions
       virtual void init (SoState *state)
       virtual void print (FILE *file) const
           Prints contents of element (not implemented)

   Static Public Member Functions
       static SoType getClassTypeId (void)
       static int getClassStackIndex (void)
       static void * createInstance (void)
       static void initClass (void)
       static void set (SoState *const state, SoNode *const node, const SbVec3f &position, SbBool
           setbylistener)
       static const SbVec3f & get (SoState *const state)
           Returns the current listener position.
       static SbBool isSetByListener (SoState *const state)

   Protected Member Functions
       virtual ~SoListenerPositionElement ()

   Protected Attributes
       SbVec3f position
       SbBool setbylistener

   Additional Inherited Members

Detailed Description

       The SoListenerPositionElement holds the position of the current listener.

       This position is set by SoListener nodes and SoCamera Nodes during audio rendering. When a
       SoListener is visited by the SoAudioRenderAction, it will add a new
       SoListenerPositionElement to the state, holding it's position and with the setbylistener
       flag set. When a SoCamera is visited by SoAudioRenderAction, it will add a new
       SoListenerPositionElement only if there are no previous elements with the setbylistener
       flag set.

       The SoListenerPositionElement is used when the SoVRMLSound nodes render themselves.

       Be aware that this class is an extension for Coin, and it is not available in the original
       SGI Open Inventor v2.1 API.

       Since:
           Coin 2.0

Constructor & Destructor Documentation

   SoListenerPositionElement::~SoListenerPositionElement (void) [protected],  [virtual]
       The destructor.

Member Function Documentation

   void * SoListenerPositionElement::createInstance (void) [static]
       This API member is considered internal to the library, as it is not likely to be of
       interest to the application programmer.

   void SoListenerPositionElement::initClass (void) [static]
       This static method initializes static data for the SoListenerPositionElement class.

   void SoListenerPositionElement::init (SoState *state) [virtual]
       Initializes the element to it's default value. The default value for the position is
       (0.0f, 0.0f, 0.0f) and the default value for the setByListener flag is FALSE.

       Reimplemented from SoReplacedElement.

   void SoListenerPositionElement::set (SoState *conststate, SoNode *constnode, const SbVec3f
       &position, SbBoolsetbylistener) [static]
       Sets the current listener position, and indicates if it was set by a SoListener node or a
       SoCamera node.

   SbBool SoListenerPositionElement::isSetByListener (SoState *conststate) [static]
       Returns TRUE if the position was set by a SoListener node, and FALSE if it was set by a
       SoCamera node

Member Data Documentation

   SoListenerPositionElement::position [protected]
       The position of the listener in world space. Can be set by the SoListener class or the
       SoCamera class.

Author

       Generated automatically by Doxygen for Coin from the source code.