solistenerorientationelement(3)
NAME
SoListenerOrientationElement
SYNOPSIS
#include <Inventor/elements/SoListenerOrientationElement.h> Inherits SoReplacedElement.
Detailed Description
The SoListenerOrientationElement holds the orientation of the current
listener.
This orientation is set by SoListener nodes and SoCamera Nodes during
audio rendering. When a SoListener is visited by the
SoAudioRenderAction, it will add a new SoListenerOrientationElement to
the state, holding it's orientation and with the setbylistener flag
set. When a SoCamera is visited by SoAudioRenderAction, it will add a
new SoListenerOrientationElement only if there are no previous elements
with the setbylistener flag set.
The SoListenerOrientationElement 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)
virtual void print (FILE *file) constPrints the contents of the element (unimplemented). - 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, constSbRotation &orientation, SbBool setbylistener) - static const SbRotation & get (SoState *const state)
Returns the current listener orientation.
- static SbBool isSetByListener (SoState *const state)
- Protected Member Functions
- virtual ~SoListenerOrientationElement ()
- Protected Attributes
- SbRotation orientation
SbBool setbylistener
Constructor & Destructor Documentation
- SoListenerOrientationElement::~SoListenerOrientationElement (void)
- [protected, virtual]
The destructor.
Member Function Documentation
- SoType SoListenerOrientationElement::getClassTypeId (void) [static]
- This static method returns the class type.
- Reimplemented from SoReplacedElement.
- int SoListenerOrientationElement::getClassStackIndex (void) [static]
- This static method returns the state stack index for the class.
- Reimplemented from SoReplacedElement.
- void * SoListenerOrientationElement::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 SoListenerOrientationElement::initClass (void) [static]
- This static method initializes static data for the
SoListenerOrientationElement class. - Reimplemented from SoReplacedElement.
- Referenced by SoElement::initElements().
- void SoListenerOrientationElement::init (SoState * state) [virtual]
- Initializes the element to it's default value. The default value for
the orientation is (0.0f, 0.0f, 1.0f, 0.0f) and the default value for
the setByListener flag is FALSE. - Reimplemented from SoReplacedElement.
- References SoReplacedElement::init(), and orientation.
- void SoListenerOrientationElement::set (SoState *const state, SoNode
- *const node, const SbRotation & orientation, SbBool setbylistener)
[static]
Sets the current listener orientation, and indicates if it was set by a SoListener node or a SoCamera node. - References SoElement::getElement(), orientation, and setbylistener.
- SbBool SoListenerOrientationElement::isSetByListener (SoState *const
- state) [static]
Returns TRUE if the orientation was set by a SoListener node, and FALSE if it was set by a SoCamera node - References SoElement::getConstElement(), and setbylistener.
Member Data Documentation
- SoListenerOrientationElement::orientation [protected]
- The orientation of the listener. Can be set by the SoListener class or the SoCamera class.
- Referenced by get(), init(), and set().
Author
- Generated automatically by Doxygen for Coin from the source code.