Coin Logo http://www.sim.no/
http://www.coin3d.org/

Public Member Functions | Static Public Member Functions | Protected Member Functions

SoListenerGainElement Class Reference

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. More...

#include <Inventor/elements/SoListenerGainElement.h>

Inheritance diagram for SoListenerGainElement:
SoFloatElement SoElement

List of all members.

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.


The documentation for this class was generated from the following files:

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

Generated for Coin by Doxygen 1.7.3.