solistenergainelement(3)

NAME

SoListenerGainElement

SYNOPSIS

#include <Inventor/elements/SoListenerGainElement.h>
Inherits SoFloatElement.

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

Public Member Functions

virtual void init (SoState *state)

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 float

gain)

static void set (SoState *const state, const float gain) static float get (SoState *const state)

Protected Member Functions

virtual ~SoListenerGainElement ()

Constructor & Destructor Documentation

SoListenerGainElement::~SoListenerGainElement (void) [protected, virtual]

The destructor.

Member Function Documentation

SoType SoListenerGainElement::getClassTypeId (void) [static]

This static method returns the class type.

Reimplemented from SoFloatElement.

int SoListenerGainElement::getClassStackIndex (void) [static]

This static method returns the state stack index for the class.

Reimplemented from SoFloatElement.

void * SoListenerGainElement::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 SoListenerGainElement::initClass (void) [static]

Initialize relevant common data for all instances, like the type
system.

Reimplemented from SoFloatElement.

Referenced by SoElement::initElements().

void SoListenerGainElement::init (SoState * state) [virtual]

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoFloatElement.

References SoFloatElement::data, and SoFloatElement::init().

void SoListenerGainElement::set (SoState *const state, SoNode *const

node, const float gain) [static] Sets the value of this element.

References SoFloatElement::set().

Referenced by set().

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.

References set().

float SoListenerGainElement::get (SoState *const state) [static]

Returns the element value.

References SoFloatElement::get().

Author

Generated automatically by Doxygen for Coin from the source code.

Version 2.5.0 28 Jun 2008 SoListenerGainElement(3)