solistenergainelement(3) [debian man page]
SoListenerGainElement(3) Coin SoListenerGainElement(3) 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 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 () Additional Inherited Members 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 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. 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. void SoListenerGainElement::set (SoState *conststate, SoNode *constnode, const floatgain) [static] Sets the value of this element. void SoListenerGainElement::set (SoState *conststate, const floatgain) [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 *conststate) [static] Returns the element value. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoListenerGainElement(3)
Check Out this Related Man Page
SoFloatElement(3) Coin SoFloatElement(3) NAME
SoFloatElement - SoFloatElement is an abstract base class for elements that consists of a single float value. This is the superclass of elements where the new element data replaces the old data, and where the data the element stores is a simple single precision floating point value. SYNOPSIS
#include <Inventor/elements/SoFloatElement.h> Inherits SoElement. Inherited by SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. Public Member Functions virtual void init (SoState *state) virtual SbBool matches (const SoElement *element) const virtual SoElement * copyMatchInfo (void) const virtual void print (FILE *file) const virtual void setElt (float value) Static Public Member Functions static SoType getClassTypeId (void) static int getClassStackIndex (void) static void initClass (void) static void set (const int stackIndex, SoState *const state, SoNode *const node, const float value) static void set (const int stackIndex, SoState *const state, const float value) static float get (const int stackIndex, SoState *const state) Protected Member Functions virtual ~SoFloatElement () Protected Attributes float data Additional Inherited Members Detailed Description SoFloatElement is an abstract base class for elements that consists of a single float value. This is the superclass of elements where the new element data replaces the old data, and where the data the element stores is a simple single precision floating point value. This element is like a convenient light-weight version of the SoReplacedElement. It differs from the SoReplacedElement in that the set() and get() methods are already implemented, since it is known that subclasses will still contain just a single float value. See also: SoReplacedElement, SoInt32Element, SoAccumulatedElement Constructor &; Destructor Documentation SoFloatElement::~SoFloatElement (void) [protected], [virtual] Destructor. Member Function Documentation SoType SoFloatElement::getClassTypeId (void) [static] This static method returns the class type. Reimplemented from SoElement. Reimplemented in SoGLPointSizeElement, SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. int SoFloatElement::getClassStackIndex (void) [static] This static method returns the state stack index for the class. Reimplemented from SoElement. Reimplemented in SoGLPointSizeElement, SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. void SoFloatElement::initClass (void) [static] Initialize relevant common data for all instances, like the type system. Reimplemented from SoElement. Reimplemented in SoGLPointSizeElement, SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. void SoFloatElement::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 SoElement. Reimplemented in SoGLPointSizeElement, SoComplexityElement, SoCreaseAngleElement, SoDecimationPercentageElement, SoFocalDistanceElement, SoFontSizeElement, SoGLLineWidthElement, SoLineWidthElement, SoListenerGainElement, SoPointSizeElement, and SoTextureQualityElement. SbBool SoFloatElement::matches (const SoElement *element) const [virtual] This function returns TRUE is the element matches another element (of the same class), with respect to cache validity. If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. Implements SoElement. SoElement * SoFloatElement::copyMatchInfo (void) const [virtual] This function creates a copy of the element that contains enough information to enable the matches() function to work. Used to help with scenegraph traversal caching operations. Implements SoElement. void SoFloatElement::print (FILE *file) const [virtual] This function is for printing element information, and is used mostly for debugging purposes. Reimplemented from SoElement. void SoFloatElement::set (const intstackIndex, SoState *conststate, const floatvalue) [static] Static method for setting the value of an element in the given state at the given stackIndex. float SoFloatElement::get (const intindex, SoState *conststate) [static] Static method to fetch the value of the element of this type from the given state at the given stack index. void SoFloatElement::setElt (floatvalue) [virtual] Set element value. Reimplemented in SoGLPointSizeElement, and SoGLLineWidthElement. Member Data Documentation float SoFloatElement::data [protected] The element's value. Author Generated automatically by Doxygen for Coin from the source code. Version 3.1.3 Wed May 23 2012 SoFloatElement(3)