Man Linux: Main Page and Category List

NAME

       SoListenerGainElement -

       The SoListenerGainElement class stores the SoListener gain during a
       scene graph traversal.

       This gain is set by SoListener nodes during audio rendering. The
       SoListenerGainElement is used when the SoVRMLSound nodes render
       themselves.

SYNOPSIS

       #include <Inventor/elements/SoListenerGainElement.h>

       Inherits SoFloatElement.

   Public Member Functions
       virtual void init (SoState *state)

   Static Public Member Functions
       static void initClass (void)
       static void set (SoState *const state, SoNode *const node, const float
           gain)
       static void set (SoState *const state, const float gain)
       static float get (SoState *const state)

   Protected Member Functions
       virtual ~SoListenerGainElement ()

Detailed Description

       The SoListenerGainElement class stores the SoListener gain during a
       scene graph traversal.

       This gain is set by SoListener nodes during audio rendering. The
       SoListenerGainElement 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

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

Member Function Documentation

   void SoListenerGainElement::initClass (void) [static] Initialize relevant
       common data for all instances, like the type system.
       Reimplemented from SoFloatElement.

   void SoListenerGainElement::set (SoState *const  state, SoNode *const
       node, const float gain) [static] Sets the value of this element.
   void SoListenerGainElement::set (SoState *const  state, const float gain)
       [static] This is an overloaded member function, provided for
       convenience. It differs from the above function only in what
       argument(s) it accepts.
   float SoListenerGainElement::get (SoState *const  state) [static] Returns
       the element value.

Author

       Generated automatically by Doxygen for Coin from the source code.